| 149 | |
| 150 | |
| 151 | def window_agg_numba_parameters(version: str = "1.3") -> str: |
| 152 | return ( |
| 153 | dedent( |
| 154 | """ |
| 155 | engine : str, default None |
| 156 | * ``'cython'`` : Runs the operation through C-extensions from cython. |
| 157 | * ``'numba'`` : Runs the operation through JIT compiled code from numba. |
| 158 | * ``None`` : Defaults to ``'cython'`` or globally setting ``compute.use_numba`` |
| 159 | |
| 160 | .. versionadded:: {version}.0 |
| 161 | |
| 162 | engine_kwargs : dict, default None |
| 163 | * For ``'cython'`` engine, there are no accepted ``engine_kwargs`` |
| 164 | * For ``'numba'`` engine, the engine can accept ``nopython``, ``nogil`` |
| 165 | and ``parallel`` dictionary keys. The values must either be ``True`` or |
| 166 | ``False``. The default ``engine_kwargs`` for the ``'numba'`` engine is |
| 167 | ``{{'nopython': True, 'nogil': False, 'parallel': False}}`` |
| 168 | |
| 169 | .. versionadded:: {version}.0\n |
| 170 | """ |
| 171 | ) |
| 172 | .replace("\n", "", 1) |
| 173 | .replace("{version}", version) |
| 174 | ) |