Skip to content

Commit 8beece3

Browse files
authored
Merge pull request #189 from crusaderky/lazy_apply_dask_doc
DOC: add Dask note to `lazy_apply`
2 parents 5326cbd + fcddde3 commit 8beece3

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

src/array_api_extra/_lib/_lazy.py

+6-1
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,12 @@ def lazy_apply( # type: ignore[valid-type] # numpydoc ignore=GL07,SA04
144144
145145
Dask
146146
This allows applying eager functions to Dask arrays.
147-
The Dask graph won't be computed.
147+
The Dask graph won't be computed until the user calls ``compute()`` or
148+
``persist()`` down the line.
149+
150+
The function name will be prominently visible on the user-facing Dask
151+
dashboard and on Prometheus metrics, so it is recommended for it to be
152+
meaningful.
148153
149154
`lazy_apply` doesn't know if `func` reduces along any axes; also, shape
150155
changes are non-trivial in chunked Dask arrays. For these reasons, all inputs

0 commit comments

Comments
 (0)