docs(python): Add documentation for beta gpu support (#18762)

Co-authored-by: coastalwhite <me@gburghoorn.com>

docs/_build/API_REFERENCE_LINKS.yml

@@ -3,6 +3,8 @@ python:
   LazyFrame: https://docs.pola.rs/api/python/stable/reference/lazyframe/index.html
   Series: https://docs.pola.rs/api/python/stable/reference/series/index.html
   Categorical: https://docs.pola.rs/api/python/stable/reference/api/polars.Categorical.html
+  GPUEngine: https://docs.pola.rs/api/python/stable/lazyframe/api/polars.lazyframe.engine_config.GPUEngine.html
+  Config: https://docs.pola.rs/api/python/stable/reference/config.html
   select: https://docs.pola.rs/api/python/stable/reference/dataframe/api/polars.DataFrame.select.html
   filter: https://docs.pola.rs/api/python/stable/reference/dataframe/api/polars.DataFrame.filter.html
   with_columns: https://docs.pola.rs/api/python/stable/reference/dataframe/api/polars.DataFrame.with_columns.html

docs/_build/scripts/macro.py

@@ -131,6 +131,23 @@ def code_tab(
 
 
 def define_env(env):
+    @env.macro
+    def code_header(language: str, section: str = [], api_functions: List[str] = []) -> str:
+        language_info = LANGUAGES[language]
+
+        language = language_info["code_name"]
+
+        # Create feature flags
+        feature_flags_links = create_feature_flag_links(language, api_functions)
+
+        # Create API Links if they are defined in the YAML
+        api_functions = [
+            link for f in api_functions if (link := create_api_function_link(language, f))
+        ]
+        language_headers = " ·".join(api_functions + feature_flags_links)
+        return f"""=== \":fontawesome-brands-{language_info['icon_name']}: {language_info['display_name']}\"
+    {language_headers}"""
+
     @env.macro
     def code_block(
         path: str, section: str = None, api_functions: List[str] = None

docs/index.md

@@ -26,6 +26,7 @@ Polars is a blazingly fast DataFrame library for manipulating structured data. T
 - **Out of Core**: The streaming API allows you to process your results without requiring all your data to be in memory at the same time
 - **Parallel**: Utilises the power of your machine by dividing the workload among the available CPU cores without any additional configuration.
 - **Vectorized Query Engine**: Using [Apache Arrow](https://arrow.apache.org/), a columnar data format, to process your queries in a vectorized manner and SIMD to optimize CPU usage.
+- **GPU Support**: Optionally run queries on NVIDIA GPUs for maximum performance for in-memory workloads.
 
 <!-- dprint-ignore-start -->
 

docs/src/python/user-guide/lazy/gpu.py

@@ -0,0 +1,46 @@
+# --8<-- [start:setup]
+import polars as pl
+
+df = pl.LazyFrame({"a": [1.242, 1.535]})
+
+q = df.select(pl.col("a").round(1))
+# --8<-- [end:setup]
+
+# Avoiding requiring the GPU engine for doc build output
+# --8<-- [start:simple-result]
+result = q.collect()
+print(result)
+# --8<-- [end:simple-result]
+
+
+# --8<-- [start:engine-setup]
+q = df.select((pl.col("a") ** 4))
+
+# --8<-- [end:engine-setup]
+
+# --8<-- [start:engine-result]
+result = q.collect()
+print(result)
+# --8<-- [end:engine-result]
+
+# --8<-- [start:fallback-setup]
+df = pl.LazyFrame(
+    {
+        "key": [1, 1, 1, 2, 3, 3, 2, 2],
+        "value": [1, 2, 3, 4, 5, 6, 7, 8],
+    }
+)
+
+q = df.select(pl.col("value").sum().over("key"))
+
+# --8<-- [end:fallback-setup]
+
+# --8<-- [start:fallback-result]
+print(
+    "PerformanceWarning: Query execution with GPU not supported, reason: \n"
+    "<class 'NotImplementedError'>: Grouped rolling window not implemented"
+)
+print("# some details elided")
+print()
+print(q.collect())
+# --8<- [end:fallback-result]

docs/user-guide/gpu-support.md

@@ -0,0 +1,166 @@
+# GPU Support [Open Beta]
+
+Polars provides an in-memory, GPU-accelerated execution engine for Python users of the Lazy API on NVIDIA GPUs using [RAPIDS cuDF](https://docs.rapids.ai/api/cudf/stable/). This functionality is available in Open Beta and is undergoing rapid development.
+
+### System Requirements
+
+- NVIDIA Volta™ or higher GPU with [compute capability](https://developer.nvidia.com/cuda-gpus) 7.0+
+- CUDA 11 or CUDA 12
+- Linux or Windows Subsystem for Linux 2 (WSL2)
+
+See the [RAPIDS installation guide](https://docs.rapids.ai/install#system-req) for full details.
+
+### Installation
+
+You can install the GPU backend for Polars with a feature flag as part of a normal [installation](installation.md).
+
+=== ":fontawesome-brands-python: Python"
+`bash pip install --extra-index-url=https://pypi.nvidia.com polars[gpu]`
+
+!!! note Installation on a CUDA 11 system
+
+    If you have CUDA 11, the installation line is slightly more complicated: the relevant GPU package must be requested by hand.
+
+    === ":fontawesome-brands-python: Python"
+    ```bash
+    pip install --extra-index-url=https://pypi.nvidia.com polars cudf-polars-cu11
+    ```
+
+### Usage
+
+Having built a query using the lazy API [as normal](lazy/index.md), GPU-enabled execution is requested by running `.collect(engine="gpu")` instead of `.collect()`.
+
+{{ code_header("python", [], []) }}
+
+```python
+--8<-- "python/user-guide/lazy/gpu.py:setup"
+
+result = q.collect(engine="gpu")
+print(result)
+```
+
+```python exec="on" result="text" session="user-guide/lazy"
+--8<-- "python/user-guide/lazy/gpu.py:setup"
+--8<-- "python/user-guide/lazy/gpu.py:simple-result"
+```
+
+For more detailed control over the execution, for example to specify which GPU to use on a multi-GPU node, we can provide a `GPUEngine` object. By default, the GPU engine will use a configuration applicable to most use cases.
+
+{{ code_header("python", [], []) }}
+
+```python
+--8<-- "python/user-guide/lazy/gpu.py:engine-setup"
+result = q.collect(engine=pl.GPUEngine(device=1))
+print(result)
+```
+
+```python exec="on" result="text" session="user-guide/lazy"
+--8<-- "python/user-guide/lazy/gpu.py:engine-setup"
+--8<-- "python/user-guide/lazy/gpu.py:engine-result"
+```
+
+### How It Works
+
+When you use the GPU-accelerated engine, Polars creates and optimizes a query plan and dispatches to a [RAPIDS](https://rapids.ai/) cuDF-based physical execution engine to compute the results on NVIDIA GPUs. The final result is returned as a normal CPU-backed Polars dataframe.
+
+### What's Supported on the GPU?
+
+GPU support is currently in Open Beta and the engine is undergoing rapid development. The engine currently supports many, but not all, of the core expressions and data types.
+
+Since expressions are composable, it's not feasible to list a full matrix of expressions supported on the GPU. Instead, we provide a list of the high-level categories of expressions and interfaces that are currently supported and not supported.
+
+#### Supported
+
+- LazyFrame API
+- SQL API
+- I/O from CSV, Parquet, ndjson, and in-memory CPU DataFrames.
+- Operations on numeric, logical, string, and datetime types
+- String processing
+- Aggregations and grouped aggregations
+- Joins
+- Filters
+- Missing data
+- Concatenation
+
+#### Not Supported
+
+- Eager DataFrame API
+- Streaming API
+- Operations on categorical, struct, and list data types
+- Rolling aggregations
+- Time series resampling
+- Timezones
+- Folds
+- User-defined functions
+- JSON, Excel, and Database file formats
+
+#### Did my query use the GPU?
+
+The release of the GPU engine in Open Beta implies that we expect things to work well, but there are still some rough edges we're working on. In particular the full breadth of the Polars expression API is not yet supported. With fallback to the CPU, your query _should_ complete, but you might not observe any change in the time it takes to execute. There are two ways to get more information on whether the query ran on the GPU.
+
+When running in verbose mode, any queries that cannot execute on the GPU will issue a `PerformanceWarning`:
+
+{{ code_header("python", [], []) }}
+
+```python
+--8<-- "python/user-guide/lazy/gpu.py:fallback-setup"
+
+with pl.Config() as cfg:
+    cfg.set_verbose(True)
+    result = q.collect(engine="gpu")
+
+print(result)
+```
+
+```python exec="on" result="text" session="user-guide/lazy"
+--8<-- "python/user-guide/lazy/gpu.py:fallback-setup"
+print(
+    "PerformanceWarning: Query execution with GPU not supported, reason: \n"
+    "<class 'NotImplementedError'>: Grouped rolling window not implemented"
+)
+print("# some details elided")
+print()
+print(q.collect())
+```
+
+To disable fallback, and have the GPU engine raise an exception if a query is unsupported, we can pass an appropriately configured `GPUEngine` object:
+
+{{ code_header("python", [], []) }}
+
+```python
+q.collect(engine=pl.GPUEngine(raise_on_fail=True))
+```
+
+```pytb
+Traceback (most recent call last):
+  File "<stdin>", line 1, in <module>
+  File "/home/coder/third-party/polars/py-polars/polars/lazyframe/frame.py", line 2035, in collect
+    return wrap_df(ldf.collect(callback))
+polars.exceptions.ComputeError: 'cuda' conversion failed: NotImplementedError: Grouped rolling window not implemented
+```
+
+Currently, only the proximal cause of failure to execute on the GPU is reported, we plan to extend this functionality to report all unsupported operations for a query.
+
+### Testing
+
+The Polars and NVIDIA RAPIDS teams run comprehensive unit and integration tests to ensure that the GPU-accelerated Polars backend works smoothly.
+
+The **full** Polars test suite is run on every commit made to the GPU engine, ensuring consistency of results.
+
+The GPU engine currently passes 99.2% of the Polars unit tests with CPU fallback enabled. Without CPU fallback, the GPU engine passes 88.8% of the Polars unit tests. With fallback, there are approximately 100 failing tests: around 40 of these fail due to mismatching debug output; there are some cases where the GPU engine produces the a correct result but uses a different data type; the remainder are cases where we do not correctly determine that a query is unsupported and therefore fail at runtime, instead of falling back.
+
+### When Should I Use a GPU?
+
+Based on our benchmarking, you're most likely to observe speedups using the GPU engine when your workflow's profile is dominated by grouped aggregations and joins. In contrast I/O bound queries typically show similar performance on GPU and CPU. GPUs typically have less RAM than CPU systems, therefore very large datasets will fail due to out of memory errors. Based on our testing, raw datasets of 50-100 GiB fit (depending on the workflow) well with a GPU with 80GiB of memory.
+
+### CPU-GPU Interoperability
+
+Both the CPU and GPU engine use the Apache Arrow columnar memory specification, making it possible to quickly move data between the CPU and GPU. Additionally, files written by one engine can be read by the other engine.
+
+When using GPU mode, your workflow won't fail if something isn't supported. When you run `collect(engine="gpu")`, the optimized query plan is inspected to see whether it can be executed on the GPU. If it can't, it will transparently fall back to the standard Polars engine and run on the CPU.
+
+GPU execution is only available in the Lazy API, so materialized DataFrames will reside in CPU memory when the query execution finishes.
+
+### Providing feedback
+
+Please report issues, and missing features, on the Polars [issue tracker](../development/contributing/index.md).

docs/user-guide/installation.md

@@ -88,6 +88,19 @@ pip install 'polars[numpy,fsspec]'
 | --- | --------------------------------- |
 | all | Install all optional dependencies |
 
+#### GPU
+
+| Tag | Description                |
+| --- | -------------------------- |
+| gpu | Run queries on NVIDIA GPUs |
+
+!!! note
+
+    To install the GPU engine, you need to pass
+    `--extra-index-url=https://pypi.nvidia.com` to `pip`. See [GPU
+    support](gpu-support.md) for more detailed instructions and
+    prerequisites.
+
 #### Interop
 
 | Tag      | Description                                       |

docs/user-guide/lazy/gpu.md

@@ -0,0 +1,21 @@
+# GPU Support
+
+Polars provides an in-memory, GPU-accelerated execution engine for the Lazy API in Python using [RAPIDS cuDF](https://docs.rapids.ai/api/cudf/stable/) on NVIDIA GPUs. This functionality is available in Open Beta and is undergoing rapid development.
+
+If you install Polars with the [GPU feature flag](../installation.md), you can trigger GPU-based execution by running `.collect(engine="gpu")` instead of `.collect()`.
+
+{{ code_header("python", [], []) }}
+
+```python
+--8<-- "python/user-guide/lazy/gpu.py:setup"
+
+result = q.collect(engine="gpu")
+print(result)
+```
+
+```python exec="on" result="text" session="user-guide/lazy"
+--8<-- "python/user-guide/lazy/gpu.py:setup"
+--8<-- "python/user-guide/lazy/gpu.py:simple-result"
+```
+
+Learn more in the [GPU Support guide](../gpu-support.md).

docs/user-guide/lazy/index.md

@@ -8,3 +8,4 @@ The Lazy chapter is a guide for working with `LazyFrames`. It covers the functio
 - [Query plan](query-plan.md)
 - [Execution](execution.md)
 - [Streaming](streaming.md)
+- [GPU Support](gpu.md)

docs/user-guide/misc/multiprocessing.md

@@ -11,6 +11,8 @@ It does this by executing computations which can be done in parallel in separate
 For example, requesting two expressions in a `select` statement can be done in parallel, with the results only being combined at the end.
 Another example is aggregating a value within groups using `group_by().agg(<expr>)`, each group can be evaluated separately.
 It is very unlikely that the `multiprocessing` module can improve your code performance in these cases.
+If you're using the GPU Engine with Polars you should also avoid manual multiprocessing. When used simultaneously, they can compete
+for system memory and processing power, leading to reduced performance.
 
 See [the optimizations section](../lazy/optimizations.md) for more optimizations.
 

mkdocs.yml

@@ -58,6 +58,7 @@ nav:
       - user-guide/lazy/query-plan.md
       - user-guide/lazy/execution.md
       - user-guide/lazy/streaming.md
+      - user-guide/lazy/gpu.md
     - IO:
       - user-guide/io/index.md
       - user-guide/io/csv.md
@@ -86,6 +87,7 @@ nav:
       - user-guide/misc/styling.md
       - user-guide/misc/comparison.md
       - user-guide/misc/arrow.md
+    - user-guide/gpu-support.md
 
   - API reference: api/index.md
 

py-polars/docs/source/reference/lazyframe/gpu_engine.rst

@@ -0,0 +1,14 @@
+=========
+GPUEngine
+=========
+
+This object provides fine-grained control over the behavior of the
+GPU engine when calling `LazyFrame.collect()` with an `engine`
+argument.
+
+.. currentmodule:: polars.lazyframe.engine_config
+
+.. autosummary::
+   :toctree: api/
+
+    GPUEngine

py-polars/docs/source/reference/lazyframe/index.rst

@@ -15,6 +15,7 @@ This page gives an overview of all public LazyFrame methods.
    modify_select
    miscellaneous
    in_process
+   gpu_engine
 
 .. _lazyframe: