pytorch docstring tweaks

chanzuckerberg · Jul 11, 2023 · e5d8e25 · e5d8e25
1 parent 1231ede
commit e5d8e25
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/api/python/cellxgene_census/src/cellxgene_census/experimental/ml/pytorch.py b/api/python/cellxgene_census/src/cellxgene_census/experimental/ml/pytorch.py
@@ -366,9 +366,10 @@ def __init__(
                 value. Maximum memory utilization is controlled by this parameter, with larger values providing better
                 read performance.
             use_eager_fetch:
-                Controls whether the returned iterator will eagerly fetch data from SOMA while client code is iterating
-                through data. Defaults to ``True``.
-
+                Fetch the next SOMA batch of ``obs`` and ``X`` data immediately after a previously fetched SOMA batch is made
+                available for processing via the iterator. This allows network (or filesystem) requests to be made in
+                parallel with client-side processing of the SOMA data, potentially improving overall performance at the
+                cost of doubling memory utilization. Defaults to ``True``.
         Returns:
             The constructed ``ExperimentDataPipe``.