Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@MarcoGorelli
MarcoGorelli committed Mar 24, 2024
1 parent bcc6e2c commit ee5e6bd
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,9 @@ 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.LazyFrame` or `narwhals.DataFrame` to wrap a pandas or Polars
1. use `narwhals.DataFrame` or `narwhals.LazyFrame` to wrap a pandas/Polars/Modin/cuDF
DataFrame/LazyFrame in a Narwhals class
2. use the subset of the Polars API supported by Narwhals. Just like in Polars,
some methods (e.g. `to_numpy`) are only available for `DataFrame`, not `LazyFrame`
2. use the [subset of the Polars API supported by Narwhals](https://marcogorelli.github.io/narwhals/api-reference/narwhals/)
3. use `narwhals.to_native` to return an object to the user in its original
dataframe flavour. For example:

Expand Down

0 comments on commit ee5e6bd

Please sign in to comment.