From ec73b1302a190a01d1b39dfc18d75ed7663c29f3 Mon Sep 17 00:00:00 2001 From: "zhen.chen" Date: Wed, 29 Sep 2021 15:00:26 +0800 Subject: [PATCH] docs: add documents for skip_upload_files in "BSTLD.Upload Dataset" --- docs/code/BSTLD.py | 2 +- docs/source/examples/BSTLD.rst | 4 ++++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/code/BSTLD.py b/docs/code/BSTLD.py index 5cfcdd5b5..ea3aa1452 100644 --- 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 index 1ac7e3161..36faaa043 100644 --- 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.