documenting cache=True feature

voxel51 · Jul 12, 2023 · 5e534e8 · 5e534e8
1 parent d44d015
commit 5e534e8
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/docs/source/release-notes.rst b/docs/source/release-notes.rst
@@ -11,6 +11,12 @@ FiftyOne Teams 1.3.3
 
 Includes all updates from :ref:`FiftyOne 0.21.3 <release-notes-v0.21.3>`, plus:
 
+SDK
+
+- Added a `cache=True` option to the
+  :ref:`upload_media() <teams-cloud-api-reference>` utility that allows for
+  automatically adding any uploaded files to your local cache
+
 API connections
 
 - Fixed a bug when launching the App locally via API connections

diff --git a/docs/source/teams/cloud_media.rst b/docs/source/teams/cloud_media.rst
@@ -561,6 +561,7 @@ _____________
         rel_dir=None,
         media_field="filepath",
         update_filepaths=False,
+        cache=False,
         overwrite=False,
         skip_failures=False,
         progress=False,
@@ -582,6 +583,12 @@ _____________
             media_field ("filepath"): the field containing the media paths
             update_filepaths (False): whether to update the ``media_field`` of each
                 sample in the collection to its remote path
+            cache (False): whether to store the uploaded media in your local media
+                cache. The supported values are:
+
+                -   ``False`` (default): do not cache the media
+                -   ``True`` or ``"copy"``: copy the media into your local cache
+                -   ``"move"``: move the media into your local cache
             overwrite (False): whether to overwrite (True) or skip (False) existing
                 remote files
             skip_failures (False): whether to gracefully continue without raising