Skip to main content

Blazingly fast DataFrame library

Project description


Documentation: Python - Rust - Node.js | StackOverflow: Python - Rust - Node.js | User Guide | Discord

Polars: Blazingly fast DataFrames in Rust, Python & Node.js

Polars is a blazingly fast DataFrames library implemented in Rust using Apache Arrow Columnar Format as the memory model.

  • Lazy | eager execution
  • Multi-threaded
  • SIMD
  • Query optimization
  • Powerful expression API
  • Hybrid Streaming (larger than RAM datasets)
  • Rust | Python | NodeJS | ...

To learn more, read the User Guide.

>>> import polars as pl
>>> df = pl.DataFrame(
...     {
...         "A": [1, 2, 3, 4, 5],
...         "fruits": ["banana", "banana", "apple", "apple", "banana"],
...         "B": [5, 4, 3, 2, 1],
...         "cars": ["beetle", "audi", "beetle", "beetle", "beetle"],
...     }
... )

# embarrassingly parallel execution & very expressive query language
>>> df.sort("fruits").select(
...     [
...         "fruits",
...         "cars",
...         pl.lit("fruits").alias("literal_string_fruits"),
...         pl.col("B").filter(pl.col("cars") == "beetle").sum(),
...         pl.col("A").filter(pl.col("B") > 2).sum().over("cars").alias("sum_A_by_cars"),
...         pl.col("A").sum().over("fruits").alias("sum_A_by_fruits"),
...         pl.col("A").reverse().over("fruits").alias("rev_A_by_fruits"),
...         pl.col("A").sort_by("B").over("fruits").alias("sort_A_by_B_by_fruits"),
...     ]
... )
shape: (5, 8)
┌──────────┬──────────┬──────────────┬─────┬─────────────┬─────────────┬─────────────┬─────────────┐
 fruits    cars      literal_stri  B    sum_A_by_ca  sum_A_by_fr  rev_A_by_fr  sort_A_by_B 
 ---       ---       ng_fruits     ---  rs           uits         uits         _by_fruits  
 str       str       ---           i64  ---          ---          ---          ---         
                     str                i64          i64          i64          i64         
╞══════════╪══════════╪══════════════╪═════╪═════════════╪═════════════╪═════════════╪═════════════╡
 "apple"   "beetle"  "fruits"      11   4            7            4            4           
 "apple"   "beetle"  "fruits"      11   4            7            3            3           
 "banana"  "beetle"  "fruits"      11   4            8            5            5           
 "banana"  "audi"    "fruits"      11   2            8            2            2           
 "banana"  "beetle"  "fruits"      11   4            8            1            1           
└──────────┴──────────┴──────────────┴─────┴─────────────┴─────────────┴─────────────┴─────────────┘

Performance 🚀🚀

Blazingly fast

Polars is very fast. In fact, it is one of the best performing solutions available. See the results in h2oai's db-benchmark.

In the TPCH benchmarks polars is orders of magnitudes faster than pandas, dask, modin and vaex on full queries (including IO).

Lightweight

Polars is also very lightweight. It comes with zero required dependencies, and this shows in the import times:

  • polars: 70ms
  • numpy: 104ms
  • pandas: 520ms

Handles larger than RAM data

If you have data that does not fit into memory, polars lazy is able to process your query (or parts of your query) in a streaming fashion, this drastically reduces memory requirements so you might be able to process your 250GB dataset on your laptop. Collect with collect(streaming=True) to run the query streaming. (This might be a little slower, but it is still very fast!)

Setup

Python

Install the latest polars version with:

pip install polars

We also have a conda package (conda install polars), however pip is the preferred way to install Polars.

Install Polars with all optional dependencies.

pip install 'polars[all]'
pip install 'polars[numpy,pandas,pyarrow]'  # install a subset of all optional dependencies

You can also install the dependencies directly.

Tag Description
all Install all optional dependencies (all of the following)
pandas Install with Pandas for converting data to and from Pandas Dataframes/Series
numpy Install with numpy for converting data to and from numpy arrays
pyarrow Reading data formats using PyArrow
fsspec Support for reading from remote file systems
connectorx Support for reading from SQL databases
xlsx2csv Support for reading from Excel files
deltalake Support for reading from Delta Lake Tables
timezone Timezone support, only needed if 1. you are on Python < 3.9 and/or 2. you are on Windows, otherwise no dependencies will be installed

Releases happen quite often (weekly / every few days) at the moment, so updating polars regularly to get the latest bugfixes / features might not be a bad idea.

Rust

You can take latest release from crates.io, or if you want to use the latest features / performance improvements point to the master branch of this repo.

polars = { git = "https://github.com/pola-rs/polars", rev = "<optional git tag>" }

Required Rust version >=1.58

Contributing

Want to contribute? Read our contribution guideline.

Python: compile polars from source

If you want a bleeding edge release or maximal performance you should compile polars from source.

This can be done by going through the following steps in sequence:

  1. Install the latest Rust compiler
  2. Install maturin: pip install maturin
  3. Choose any of:
    • Fastest binary, very long compile times:
      $ cd py-polars && maturin develop --release -- -C target-cpu=native
      
    • Fast binary, Shorter compile times:
      $ cd py-polars && maturin develop --release -- -C codegen-units=16 -C lto=thin -C target-cpu=native
      

Note that the Rust crate implementing the Python bindings is called py-polars to distinguish from the wrapped Rust crate polars itself. However, both the Python package and the Python module are named polars, so you can pip install polars and import polars.

Arrow2

Polars has transitioned to arrow2. Arrow2 is a faster and safer implementation of the Apache Arrow Columnar Format. Arrow2 also has a more granular code base, helping to reduce the compiler bloat.

Use custom Rust function in python?

See this example.

Going big...

Do you expect more than 2^32 ~4,2 billion rows? Compile polars with the bigidx feature flag.

Or for python users install pip install polars-u64-idx.

Don't use this unless you hit the row boundary as the default polars is faster and consumes less memory.

Legacy

Do you want polars to run on an old CPU (e.g. dating from before 2011)? Install pip polars-lts-cpu. This polars project is compiled without avx target features.

Acknowledgements

Development of Polars is proudly powered by

Xomnia

Sponsors

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

polars-0.15.11.tar.gz (1.3 MB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

polars-0.15.11-cp37-abi3-win_amd64.whl (15.7 MB view details)

Uploaded CPython 3.7+Windows x86-64

polars-0.15.11-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (14.6 MB view details)

Uploaded CPython 3.7+manylinux: glibc 2.17+ x86-64

polars-0.15.11-cp37-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (12.8 MB view details)

Uploaded CPython 3.7+manylinux: glibc 2.17+ ARM64

polars-0.15.11-cp37-abi3-macosx_11_0_arm64.whl (12.4 MB view details)

Uploaded CPython 3.7+macOS 11.0+ ARM64

polars-0.15.11-cp37-abi3-macosx_10_7_x86_64.whl (13.9 MB view details)

Uploaded CPython 3.7+macOS 10.7+ x86-64

File details

Details for the file polars-0.15.11.tar.gz.

File metadata

  • Download URL: polars-0.15.11.tar.gz
  • Upload date:
  • Size: 1.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: maturin/0.13.5

File hashes

Hashes for polars-0.15.11.tar.gz
Algorithm Hash digest
SHA256 3a73a68f46005df9f668e723399082ab009f59483c36b70e751e11ac783c0181
MD5 e780b1ff0fff3e3804e337b230fcffeb
BLAKE2b-256 00a58a11bcbf3b3503c30ec0e119c30517bcabadb915aee82ec193b2d8ba6c08

See more details on using hashes here.

File details

Details for the file polars-0.15.11-cp37-abi3-win_amd64.whl.

File metadata

  • Download URL: polars-0.15.11-cp37-abi3-win_amd64.whl
  • Upload date:
  • Size: 15.7 MB
  • Tags: CPython 3.7+, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: maturin/0.13.5

File hashes

Hashes for polars-0.15.11-cp37-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 84e21e27555ae49d2cca4792497d7052b65d80f4d8fc7191d7d570073587986c
MD5 370b5058982eb8447106a11ae37d05bb
BLAKE2b-256 59c6f661970c22b9bd52e5f1d4fd7afbf829c8249c997cf04450f87dc54f725e

See more details on using hashes here.

File details

Details for the file polars-0.15.11-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for polars-0.15.11-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 93cb399917a05b2def9bd1104b5c9fe75768f6e13f5c826fabd98a533aacc4a8
MD5 f7f594b01216e28a1cd6e42d0aab63d9
BLAKE2b-256 80cc6020446b93b4a3908c6bbc05b78276d6f4ac0775d1e918c262523002d5e5

See more details on using hashes here.

File details

Details for the file polars-0.15.11-cp37-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl.

File metadata

File hashes

Hashes for polars-0.15.11-cp37-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 82c491dd3d3789661775464448fbcdd5f332845d717665840896b263d20e47fa
MD5 20bef1d294821336508ac2a86a8c7108
BLAKE2b-256 5107fc5356d52899d273edbb2b25d015fb3c9490f12755e64baacda02ab937a3

See more details on using hashes here.

File details

Details for the file polars-0.15.11-cp37-abi3-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for polars-0.15.11-cp37-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 9487c278af13e3d9c540f5e9402d758f2faeb76cb4af05ab573460dafd34ace5
MD5 179b409f4171006b9627e3e3e4451e3d
BLAKE2b-256 32eab46e8ea306182133a830480a13ed28bd919565715c0a8d4aa0e65bff6584

See more details on using hashes here.

File details

Details for the file polars-0.15.11-cp37-abi3-macosx_10_7_x86_64.whl.

File metadata

File hashes

Hashes for polars-0.15.11-cp37-abi3-macosx_10_7_x86_64.whl
Algorithm Hash digest
SHA256 77552af5a57c35bd61dede4dc1856456bbe1638c03d49b51c7855f2cb7c5d186
MD5 70820d51bad4b41312ea960b1faff50a
BLAKE2b-256 2d2cce2849c38c8b0e221bfcd213f1aa91a75386adbcc5efc3a35d3ccadd5624

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page