Giter Club home page Giter Club logo

narwhals's Introduction

Narwhals

narwhals_small

PyPI version

Extremely lightweight and extensible compatibility layer between Polars, pandas, Modin, and cuDF (and more!).

Seamlessly support all, without depending on any!

  • Just use a subset of the Polars API, no need to learn anything new
  • No dependencies (not even Polars), keep your library lightweight
  • ✅ Separate lazy and eager APIs
  • ✅ Use Expressions
  • ✅ 100% branch coverage, tested against pandas and Polars nightly builds!
  • ✅ Preserve your Index (if present) without it getting in the way!

Used by

Join the party!

Installation

pip install narwhals

Or just vendor it, it's only a bunch of pure-Python files.

Usage

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

  1. use narwhals.from_native to wrap a pandas/Polars/Modin/cuDF DataFrame/LazyFrame in a Narwhals class

  2. use the subset of the Polars API supported by Narwhals

  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
    • if you started with Polars, you'll get Polars back
    • if you started with Modin, you'll get Modin back (and compute will be distributed)
    • if you started with cuDF, you'll get cuDF back (and compute will happen on GPU)

What about Ibis?

Like Ibis, Narwhals aims to enable dataframe-agnostic code. However, Narwhals comes with zero dependencies, is about as lightweight as it gets, and is aimed at library developers rather than at end users. It also does not aim to support as many backends, preferring to instead focus on dataframes. So, which should you use?

  • If you need to run complicated analyses and aren't too bothered about package size: Ibis!
  • If you're a library maintainer and want the thinnest-possible layer to get cross-dataframe library support: Narwhals!

Here is the package size increase which would result from installing each tool in a non-pandas environment:

image

Example

See the tutorial for several examples!

Scope

  • Do you maintain a dataframe-consuming library?
  • Is there a Polars function which you'd like Narwhals to have, which would make your work easier?

If, I'd love to hear from you!

Note: You might suspect that this is a secret ploy to infiltrate the Polars API everywhere. Indeed, you may suspect that.

Why "Narwhals"?

Coz they are so awesome.

Thanks to Olha Urdeichuk for the illustration!

narwhals's People

Contributors

marcogorelli avatar deamarialeon avatar brentomagic avatar frnmst avatar pre-commit-ci[bot] avatar matthewmec avatar ugohuche avatar natmokval avatar georgescutelnicu avatar anopsy avatar raisadz avatar shriyakalakata avatar fbruzzesi avatar hathawayj avatar inessapawson avatar saravanansathyanandhaqc avatar koaning avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.