Skip to content

Commit

Permalink
init 10 minutes to polars nb
Browse files Browse the repository at this point in the history
  • Loading branch information
ritchie46 committed Aug 30, 2020
1 parent 7c1213b commit 0f380f1
Show file tree
Hide file tree
Showing 6 changed files with 1,596 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .gitattributes
@@ -1 +1 @@
.ipynb linguist-documentation
*.ipynb linguist-documentation
14 changes: 11 additions & 3 deletions README.md
Expand Up @@ -11,16 +11,24 @@ Its focus is being a fast in memory DataFrame library.
Polars is in rapid development, but it already supports most features needed for a useful DataFrame library. Do you
mis something, please make an issue and/or sent a PR.

## First run
Take a look at the [10 minutes to Polars notebook](examples/10_minutes_to_polars.ipynb) to get you started.
Want to run the notebook yourself? Clone the repo and run `$ cargo c && docker-compose up`. This will spin up a jupyter
notebook on `http://localhost:8891`. The notebooks are in the `/examples` directory.

Oh yeah.. and get a cup of coffee because compilation will take while during the first run.


## Documentation
Want to know what features Polars support? [Check the current master docs](https://ritchie46.github.io/polars).

Most
features are described on the [DataFrame](https://ritchie46.github.io/polars/polars/frame/struct.DataFrame.html),
Most features are described on the [DataFrame](https://ritchie46.github.io/polars/polars/frame/struct.DataFrame.html),
[Series](https://ritchie46.github.io/polars/polars/series/enum.Series.html), and [ChunkedArray](https://ritchie46.github.io/polars/polars/chunked_array/struct.ChunkedArray.html)
structs in that order. For `ChunkedArray` a lot of functionality is also defined by `Traits` in the
[ops module](https://ritchie46.github.io/polars/polars/chunked_array/ops/index.html).

### Performance
## Performance
Polars is written to be performant. Below are some comparisons with the (also very fast) Pandas DataFrame library.

#### GroupBy
![](pandas_cmp/img/groupby10_.png)
Expand Down
13 changes: 13 additions & 0 deletions docker-compose.yaml
@@ -0,0 +1,13 @@
version: '3'
services:
notebook:
build: .
ports:
- "8891:8891"
command: ["jupyter", "notebook", "--ip=0.0.0.0", "--port=8891", "--NotebookApp.token=''"]
environment:
- EVCXR_TMPDIR=/target
volumes:
- ./polars:/polars
- ./target:/target
- ./examples:/examples

0 comments on commit 0f380f1

Please sign in to comment.