Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API Doc for Polars GPU Engine #16753

Merged
merged 34 commits into from
Sep 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
5dd765e
added index file for cudf polars
Sep 5, 2024
4f11aaa
added Announcement and Google Colab sections
Sep 5, 2024
7bab15f
Added Google Colab image
Sep 5, 2024
311deb3
Added Google Colab image
Sep 5, 2024
8bf9cd2
Added Google Colab image
Sep 5, 2024
b7dd2d8
Added Google Colab image
Sep 5, 2024
6a2ffb5
text alignment
Sep 5, 2024
2925068
change headings
Sep 5, 2024
afdfe5b
added extra index to the install command
Sep 5, 2024
093ce0c
Update index.rst
singhmanas1 Sep 6, 2024
a8ac87e
Added polars pds benchmark
singhmanas1 Sep 11, 2024
ac4ecf0
Delete docs/cudf/source/_static/polars_pds_benchmark.png
singhmanas1 Sep 11, 2024
8d27437
Added polars pds benchmark
singhmanas1 Sep 11, 2024
1d21c92
Add files via upload
singhmanas1 Sep 12, 2024
87e9810
Delete docs/cudf/source/_static/polars_GPU_speedups_80GB.png
singhmanas1 Sep 12, 2024
c95f440
Add files via upload
singhmanas1 Sep 12, 2024
9048a91
Update index.rst
singhmanas1 Sep 12, 2024
f22acc7
Apply suggestions from code review
wence- Sep 16, 2024
f47a035
Fix links and style check.
bdice Sep 16, 2024
2a6a844
Added graph with compute heavy queries
singhmanas1 Sep 16, 2024
9b21c66
Delete docs/cudf/source/_static/polars_compute_heavy_query.png
singhmanas1 Sep 16, 2024
79ac363
Adding polars compute heavy queries
singhmanas1 Sep 16, 2024
ca3517c
Delete docs/cudf/source/_static/polars_compute_heavy_queries.png
singhmanas1 Sep 16, 2024
c006acd
Adding TPC-H benchmark results
singhmanas1 Sep 16, 2024
c395baa
Updated index.rst
singhmanas1 Sep 16, 2024
e39539f
Update index.rst
singhmanas1 Sep 16, 2024
4606930
Update index.rst
singhmanas1 Sep 16, 2024
c4ef847
Update index.rst
singhmanas1 Sep 16, 2024
7e71672
Update index.rst
singhmanas1 Sep 16, 2024
f076bd4
Update index.rst
singhmanas1 Sep 16, 2024
36bb894
Update index.rst
singhmanas1 Sep 16, 2024
71ea75a
qMerge remote-tracking branch 'upstream/feature/cudf-polars' into fea…
Sep 16, 2024
bb66967
cudf_polars index page added to toc
Sep 16, 2024
d403419
Update docs/cudf/source/cudf_polars/index.rst
bdice Sep 16, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/cudf/source/_static/pds_benchmark_polars.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
41 changes: 41 additions & 0 deletions docs/cudf/source/cudf_polars/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
cuDF-based GPU backend for Polars [Open Beta]
=============================================

cuDF supports an in-memory, GPU-accelerated execution engine for Python users of the Polars Lazy API.
The engine supports most of the core expressions and data types as well as a growing set of more advanced dataframe manipulations
and data file formats. When using the GPU engine, Polars will convert expressions into an optimized query plan and determine
whether the plan is supported on the GPU. If it is not, the execution will transparently fall back to the standard Polars engine
and run on the CPU.

Benchmark
---------
We reproduced the `Polars Decision Support (PDS) <https://github.com/pola-rs/polars-benchmark>`__ benchmark to compare Polars GPU engine with the default CPU settings across several dataset sizes. Here are the results:

.. figure:: ../_static/pds_benchmark_polars.png
:width: 600px



You can see up to 13x speedup using the GPU backend on the compute-heavy PDS queries involving complex aggregation and join operations. Below are the speedups for the top performing queries:


.. figure:: ../_static/compute_heavy_queries_polars.png
:width: 1000px

:emphasis:`PDS-H benchmark | GPU: NVIDIA H100 PCIe | CPU: Intel Xeon W9-3495X (Sapphire Rapids) | Storage: Local NVMe`

You can reproduce the results by visiting the `Polars Decision Support (PDS) GitHub repository <https://github.com/pola-rs/polars-benchmark>`__.

Learn More
----------

The GPU backend for Polars is now available in Open Beta and the engine is undergoing rapid development. To learn more, visit the `GPU Support page <https://docs.pola.rs/user-guide/gpu-support/>`__ on the Polars website.

Launch on Google Colab
----------------------

.. figure:: ../_static/colab.png
:width: 200px
:target: https://colab.research.google.com/github/rapidsai-community/showcase/blob/main/accelerated_data_processing_examples/polars_gpu_engine_demo.ipynb

Take the cuDF backend for Polars for a test-drive in a free GPU-enabled notebook environment using your Google account by `launching on Colab <https://colab.research.google.com/github/rapidsai-community/showcase/blob/main/accelerated_data_processing_examples/polars_gpu_engine_demo.ipynb>`__.
1 change: 1 addition & 0 deletions docs/cudf/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,6 @@ other operations.

user_guide/index
cudf_pandas/index
cudf_polars/index
libcudf_docs/index
developer_guide/index
Loading