polars.Config.set_engine_affinity#

classmethod Config.set_engine_affinity( engine: Literal['auto', 'in-memory', 'streaming', 'gpu'] | GPUEngine | None = None, ) → type[Config][source]#

Set which engine to use by default.

Parameters:

engine{None, ‘auto’, ‘in-memory’, ‘streaming’, ‘gpu’}: The default execution engine Polars will attempt to use when calling .collect(). However, the query is not guaranteed to execute with the specified engine.

Raises:

ValueError: if engine is not recognised.
NotImplementedError: if engine is a GPUEngine object

Examples

>>> pl.Config.set_engine_affinity("streaming")  
>>> lf = pl.LazyFrame({"v": [1, 2, 3], "v2": [4, 5, 6]})  
>>> lf.max().collect()  
shape: (3, 2)
┌─────┬─────┐
│ v   ┆ v2  │
│ --- ┆ --- │
│ i64 ┆ i64 │
╞═════╪═════╡
│ 1   ┆ 4   │
│ 2   ┆ 5   │
│ 3   ┆ 6   │
└─────┴─────┘
>>> pl.Config.set_engine_affinity("gpu")  
>>> lf.max().collect()  
shape: (3, 2)
┌─────┬─────┐
│ v   ┆ v2  │
│ --- ┆ --- │
│ i64 ┆ i64 │
╞═════╪═════╡
│ 1   ┆ 4   │
│ 2   ┆ 5   │
│ 3   ┆ 6   │
└─────┴─────┘