docs: add documents for skip_upload_files in "BSTLD.Upload Dataset"

Graviti-AI · Sep 29, 2021 · ec73b13 · ec73b13
1 parent b65e505
commit ec73b13
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/docs/code/BSTLD.py b/docs/code/BSTLD.py
@@ -40,7 +40,7 @@
 """"""
 
 """Upload Dataset"""
-dataset_client = gas.upload_dataset(dataset, jobs=8)
+dataset_client = gas.upload_dataset(dataset, jobs=8, skip_uploaded_files=True)
 dataset_client.commit("initial commit")
 """"""
 

diff --git a/docs/source/examples/BSTLD.rst b/docs/source/examples/BSTLD.rst
@@ -116,6 +116,10 @@ The organized "BSTLD" dataset can be uploaded to TensorBay for sharing, reuse, e
    :start-after: """Upload Dataset"""
    :end-before: """"""
 
+.. note::
+   Set `skip_uploaded_files=True` to skip uploaded data.
+   The data will be skiped if it's name and segment name is the same as remote data.
+
 Similar with Git, the commit step after uploading can record changes to the dataset as a version.
 If needed, do the modifications and commit again.
 Please see :ref:`features/version_control:Version Control` for more details.