Skip to content

Commit b19edc0

Browse files
Mariko WakabayashiZsailer
authored andcommitted
update docs and configs
1 parent 188fc3c commit b19edc0

File tree

2 files changed

+373
-6
lines changed

2 files changed

+373
-6
lines changed

docs/source/developers/contents.rst

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -269,11 +269,22 @@ ContentsManager.
269269
.. _PostgreSQL: https://www.postgresql.org/
270270

271271
Asynchronous Support
272-
~~~~~~~~~~~~~~~~~~~~
272+
--------------------
273273

274-
To execute file operations asynchronously in a virtual filesystem, the following classes are available.
274+
An asynchronous version of the Contents API is available to run slow IO processes concurrently.
275275

276276
- :class:`~manager.AsyncContentsManager`
277277
- :class:`~filemanager.AsyncFileContentsManager`
278+
- :class:`~largefilemanager.AsyncLargeFileManager`
278279
- :class:`~checkpoints.AsyncCheckpoints`
280+
- :class:`~checkpoints.AsyncGenericCheckpointsMixin`
281+
282+
.. note::
283+
284+
.. _contentfree:
285+
286+
In most cases, the non-asynchronous Contents API is performant for local filesystems.
287+
However, if the Jupyter Notebook web application is interacting with a high-latent virtual filesystem, you may see performance gains by using the asynchronous version.
288+
For example, if you're experiencing terminal lag in the web application due to the slow and blocking file operations, the asynchronous version may be a good option.
289+
Before opting in, comparing both non-async and async options' performances is recommended.
279290

0 commit comments

Comments
 (0)