Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
MarcoGorelli committed Mar 15, 2024
1 parent bad046b commit c491a68
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,10 @@ Or just vendor it, it's only a bunch of pure-Python files.

There are three steps to writing dataframe-agnostic code using Narwhals:

1. use `narwhals.translate_frame` to wrap a pandas or Polars DataFrame to a Narwhals DataFrame
2. (optional) use `narwhals.get_namespace` to get a namespace object
3. use the subset of the Polars API defined in https://github.com/MarcoGorelli/narwhals/blob/main/narwhals/spec/__init__.py.
1. use `narwhals.DataFrame` to wrap a pandas or Polars DataFrame to a Narwhals DataFrame
2. use the subset of the Polars API supported by Narwhals
Some methods are only available if you called `narwhals.translate_frame` with `is_eager=True`
4. use `narwhals.to_native` to return an object to the user in their original
3. use `narwhals.to_native` to return an object to the user in its original
dataframe flavour. For example:

- if you started with pandas, you'll get pandas back
Expand Down

0 comments on commit c491a68

Please sign in to comment.