Skip to content

Commit

Permalink
chore: update readme (#5486)
Browse files Browse the repository at this point in the history
  • Loading branch information
ritchie46 committed Nov 12, 2022
1 parent 0c84d41 commit 1c1a193
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,8 @@ Polars is a blazingly fast DataFrames library implemented in Rust using
* SIMD
* Query optimization
* Powerful expression API
* Rust | Python | ...
* Hybrid Streaming (larger than RAM datasets)
* Rust | Python | NodeJS | ...

To learn more, read the [User Guide](https://pola-rs.github.io/polars-book/).

Expand Down Expand Up @@ -104,6 +105,16 @@ shape: (5, 8)
Polars is very fast. In fact, it is one of the best performing solutions available.
See the results in [h2oai's db-benchmark](https://h2oai.github.io/db-benchmark/).

In the [TPCH benchmarks](https://www.pola.rs/benchmarks.html) polars is orders of magnitudes faster than pandas, dask, modin and vaex
on full queries (including IO).

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

### import time measurements:
- polars: 70ms
- numpy: 104ms
- pandas: 520ms


## Python setup

Expand Down Expand Up @@ -156,6 +167,12 @@ Required Rust version `>=1.58`

Want to know about all the features Polars supports? Read the docs!

## 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 you might be able to process your 250GB dataset on your
laptop. Collect with `collect(allow_streaming=True)` to run the query streaming. (This might be a little slower, but
it is still very fast!)

#### Python

* Installation guide: `pip install polars`
Expand Down

0 comments on commit 1c1a193

Please sign in to comment.