remove extra / old prefect-dask usage docs
#16872
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
zzstoatzz
requested review from
discdiver,
cicdw and
desertaxle
as code owners
zzstoatzz
changed the title
prefect-dask usage docs
zzstoatzz
commented
Jan 28, 2025
There was a problem hiding this comment.
this whole section already exists in the index.mdx and no other collections have a separate usage guide page, its all just embedded in the index like this one is now
zzstoatzz
commented
Jan 28, 2025
Comment on lines
+403
to
+428
|
|
||
| <Warning> | ||
| **Resolving futures in sync client** | ||
|
|
||
| Note, by default, `dask_collection.compute()` returns concrete values while `client.compute(dask_collection)` returns Dask Futures. Therefore, if you call `client.compute`, you must resolve all futures before exiting out of the context manager by either: | ||
|
|
||
| 1. setting `sync=True` | ||
| ```python | ||
| with get_dask_client() as client: | ||
| df = dask.datasets.timeseries("2000", "2001", partition_freq="4w") | ||
| summary_df = client.compute(df.describe(), sync=True) | ||
| ``` | ||
|
|
||
| 2. calling `result()` | ||
| ```python | ||
| with get_dask_client() as client: | ||
| df = dask.datasets.timeseries("2000", "2001", partition_freq="4w") | ||
| summary_df = client.compute(df.describe()).result() | ||
| ``` | ||
| For more information, visit the docs on [Waiting on Futures](https://docs.dask.org/en/stable/futures.html#waiting-on-futures). | ||
| </Warning> | ||
|
|
||
| There is also an equivalent context manager for asynchronous tasks and flows: `get_async_dask_client`. When using the async client, you must `await client.compute(dask_collection)` before exiting the context manager. | ||
|
|
||
| Note that task submission (`.submit()`) and future resolution (`.result()`) are always synchronous operations in Prefect, even when working with async tasks and flows. |
There was a problem hiding this comment.
it appeared this was the only section unique to the "usage guide" page
desertaxle
approved these changes
Jan 28, 2025
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
closes #16865