docs: add comments to the sample code about getting AccessKey

PR Closed: #1228
Graviti-AI · Mar 17, 2022 · 0e24c28 · 0e24c28
1 parent 66b7ac9
commit 0e24c28
Show file tree

Hide file tree

Showing 26 changed files with 29 additions and 0 deletions.
diff --git a/docs/code/BSTLD.py b/docs/code/BSTLD.py
@@ -14,7 +14,10 @@
 """Authorize a Client Instance"""
 from tensorbay import GAS
 
+# Please visit `https://gas.graviti.cn/tensorbay/developer` to get the AccessKey.
 gas = GAS("<YOUR_ACCESSKEY>")
+
+
 """"""
 
 """Create Dataset"""

diff --git a/docs/code/CADC.py b/docs/code/CADC.py
@@ -14,6 +14,7 @@
 from tensorbay import GAS
 from tensorbay.dataset import FusionDataset
 
+# Please visit `https://gas.graviti.cn/tensorbay/developer` to get the AccessKey.
 gas = GAS("<YOUR_ACCESSKEY>")
 """"""
 

diff --git a/docs/code/DogsVsCats.py b/docs/code/DogsVsCats.py
@@ -14,6 +14,7 @@
 """Authorize a Client Instance"""
 from tensorbay import GAS
 
+# Please visit `https://gas.graviti.cn/tensorbay/developer` to get the AccessKey.
 gas = GAS("<YOUR_ACCESSKEY>")
 """"""
 

diff --git a/docs/code/LeedsSportsPose.py b/docs/code/LeedsSportsPose.py
@@ -15,6 +15,7 @@
 """Authorize a Client Instance"""
 from tensorbay import GAS
 
+# Please visit `https://gas.graviti.cn/tensorbay/developer` to get the AccessKey.
 gas = GAS("<YOUR_ACCESSKEY>")
 """"""
 

diff --git a/docs/code/NeolixOD.py b/docs/code/NeolixOD.py
@@ -14,6 +14,7 @@
 """Authorize a Client Instance"""
 from tensorbay import GAS
 
+# Please visit `https://gas.graviti.cn/tensorbay/developer` to get the AccessKey.
 gas = GAS("<YOUR_ACCESSKEY>")
 """"""
 

diff --git a/docs/code/Newsgroups20.py b/docs/code/Newsgroups20.py
@@ -14,6 +14,7 @@
 """Authorize a Client Instance"""
 from tensorbay import GAS
 
+# Please visit `https://gas.graviti.cn/tensorbay/developer` to get the AccessKey.
 gas = GAS("<YOUR_ACCESSKEY>")
 """"""
 

diff --git a/docs/code/THCHS30.py b/docs/code/THCHS30.py
@@ -14,6 +14,7 @@
 """Authorize a Client Instance"""
 from tensorbay import GAS
 
+# Please visit `https://gas.graviti.cn/tensorbay/developer` to get the AccessKey.
 gas = GAS("<YOUR_ACCESSKEY>")
 """"""
 

diff --git a/docs/code/VOC2012Segmentation.py b/docs/code/VOC2012Segmentation.py
@@ -16,6 +16,7 @@
 """Authorize a Client Instance"""
 from tensorbay import GAS
 
+# Please visit `https://gas.graviti.cn/tensorbay/developer` to get the AccessKey.
 gas = GAS("<YOUR_ACCESSKEY>")
 """"""
 

diff --git a/docs/code/basic_search.py b/docs/code/basic_search.py
@@ -15,6 +15,7 @@
 """Authorize a Dataset Client Instance"""
 from tensorbay import GAS
 
+# Please visit `https://gas.graviti.cn/tensorbay/developer` to get the AccessKey.
 gas = GAS("<YOUR_ACCESSKEY>")
 dataset_client = gas.create_dataset("<DATASET_NAME>")
 

diff --git a/docs/code/branch.py b/docs/code/branch.py
@@ -13,6 +13,7 @@
 """Authorize a Dataset Client Instance"""
 from tensorbay import GAS
 
+# Please visit `https://gas.graviti.cn/tensorbay/developer` to get the AccessKey.
 gas = GAS("<YOUR_ACCESSKEY>")
 dataset_client = gas.create_dataset("<DATASET_NAME>")
 dataset_client.create_draft("draft-1")

diff --git a/docs/code/cache.py b/docs/code/cache.py
@@ -17,6 +17,7 @@
 from tensorbay import GAS
 from tensorbay.dataset import Dataset
 
+# Please visit `https://gas.graviti.cn/tensorbay/developer` to get the AccessKey.
 gas = GAS("<YOUR_ACCESSKEY>")
 dataset = Dataset("<DATASET_NAME>", gas)
 """"""

diff --git a/docs/code/diff.py b/docs/code/diff.py
@@ -13,6 +13,7 @@
 """Authorize a Dataset Client Instance"""
 from tensorbay import GAS
 
+# Please visit `https://gas.graviti.cn/tensorbay/developer` to get the AccessKey.
 gas = GAS("<YOUR_ACCESSKEY>")
 dataset_client = gas.create_dataset("<DATASET_NAME>")
 dataset_client.create_draft("draft-1")

diff --git a/docs/code/draft_and_commit.py b/docs/code/draft_and_commit.py
@@ -13,6 +13,7 @@
 """Authorize a Dataset Client Instance"""
 from tensorbay import GAS
 
+# Please visit `https://gas.graviti.cn/tensorbay/developer` to get the AccessKey.
 gas = GAS("<YOUR_ACCESSKEY>")
 dataset_client = gas.create_dataset("<DATASET_NAME>")
 """"""

diff --git a/docs/code/merge_datasets.py b/docs/code/merge_datasets.py
@@ -13,6 +13,7 @@
 """Create Target Dataset"""
 from tensorbay import GAS
 
+# Please visit `https://gas.graviti.cn/tensorbay/developer` to get the AccessKey.
 gas = GAS("<YOUR_ACCESSKEY>")
 dataset_client = gas.create_dataset("mergedDataset")
 dataset_client.create_draft("merge dataset")

diff --git a/docs/code/request_configuration.py b/docs/code/request_configuration.py
@@ -17,6 +17,7 @@
 config.timeout = 40
 config.max_retries = 4
 
+# Please visit `https://gas.graviti.cn/tensorbay/developer` to get the AccessKey.
 gas = GAS("<YOUR_ACCESSKEY>")
 
 # The configs will apply to all the requests sent by TensorBay SDK.

diff --git a/docs/code/search_result.py b/docs/code/search_result.py
@@ -15,6 +15,7 @@
 """Obtain a SearchResult Instance"""
 from tensorbay import GAS
 
+# Please visit `https://gas.graviti.cn/tensorbay/developer` to get the AccessKey.
 gas = GAS("<YOUR_ACCESSKEY>")
 dataset_client = gas.get_dataset("<DATASET_NAME>")
 

diff --git a/docs/code/sextant.py b/docs/code/sextant.py
@@ -14,6 +14,7 @@
 """Get sextant client"""
 from tensorbay.apps.sextant import Sextant
 
+# Please visit `https://gas.graviti.cn/tensorbay/developer` to get the AccessKey.
 sextant = Sextant("<YOUR_ACCESSKEY>")
 """"""
 
@@ -28,6 +29,7 @@
 """Create evaluation"""
 from tensorbay import GAS
 
+# Please visit `https://gas.graviti.cn/tensorbay/developer` to get the AccessKey.
 gas = GAS("<YOUR_ACCESSKEY>")
 dataset_client = gas.get_dataset("<DATASET_NAME>")
 dataset_client.checkout(revision="<branch/tag/commitId>")

diff --git a/docs/code/squash_and_merge.py b/docs/code/squash_and_merge.py
@@ -15,6 +15,7 @@
 """Authorize a Dataset Client Instance"""
 from tensorbay import GAS
 
+# Please visit `https://gas.graviti.cn/tensorbay/developer` to get the AccessKey.
 gas = GAS("<YOUR_ACCESSKEY>")
 dataset_client = gas.create_dataset("<DATASET_NAME>")
 

diff --git a/docs/code/storage_config.py b/docs/code/storage_config.py
@@ -12,6 +12,7 @@
 """Get cloud client"""
 from tensorbay import GAS
 
+# Please visit `https://gas.graviti.cn/tensorbay/developer` to get the AccessKey.
 gas = GAS("<YOUR_ACCESSKEY>")
 cloud_client = gas.get_cloud_client("<CONFIG_NAME>")
 """"""

diff --git a/docs/code/tag.py b/docs/code/tag.py
@@ -14,6 +14,7 @@
 """Authorize a Dataset Client Instance"""
 from tensorbay import GAS
 
+# Please visit `https://gas.graviti.cn/tensorbay/developer` to get the AccessKey.
 gas = GAS("<YOUR_ACCESSKEY>")
 dataset_client = gas.create_dataset("<DATASET_NAME>")
 dataset_client.create_draft("draft-1")

diff --git a/docs/code/update_dataset.py b/docs/code/update_dataset.py
@@ -14,6 +14,7 @@
 """Upload Images to the Dataset"""
 from tensorbay.dataset import Dataset
 
+# Please visit `https://gas.graviti.cn/tensorbay/developer` to get the AccessKey.
 gas = GAS("<YOUR_ACCESSKEY>")
 dataset = Dataset("<DATASET_NAME>")
 """"""

diff --git a/docs/code/use_dataset_in_paddlepaddle.py b/docs/code/use_dataset_in_paddlepaddle.py
@@ -42,6 +42,7 @@ def __getitem__(self, idx):
 
 
 """Build a dataloader and run it"""
+# Please visit `https://gas.graviti.cn/tensorbay/developer` to get the AccessKey.
 ACCESS_KEY = "<YOUR_ACCESSKEY>"
 
 to_tensor = transforms.ToTensor()

diff --git a/docs/code/use_dataset_in_pytorch.py b/docs/code/use_dataset_in_pytorch.py
@@ -43,6 +43,7 @@ def __getitem__(self, idx):
 
 
 """Build a dataloader and run it"""
+# Please visit `https://gas.graviti.cn/tensorbay/developer` to get the AccessKey.
 ACCESS_KEY = "<YOUR_ACCESSKEY>"
 
 to_tensor = transforms.ToTensor()

diff --git a/docs/code/use_dataset_in_tensorflow.py b/docs/code/use_dataset_in_tensorflow.py
@@ -49,6 +49,7 @@ def __call__(self):
 
 
 """Build a tensorflow dataset and run it"""
+# Please visit `https://gas.graviti.cn/tensorbay/developer` to get the AccessKey.
 ACCESS_KEY = "<YOUR_ACCESSKEY>"
 
 dataset = Dataset.from_generator(

diff --git a/docs/code/use_internal_endpoint.py b/docs/code/use_internal_endpoint.py
@@ -18,6 +18,7 @@
 # Set is_internal to True for using internal endpoint.
 config.is_internal = True
 
+# Please visit `https://gas.graviti.cn/tensorbay/developer` to get the AccessKey.
 gas = GAS("<YOUR_ACCESSKEY>")
 
 # Organize the local dataset by the "Dataset" class before uploading.

diff --git a/docs/source/features/version_control/getting_started_with_version_control.rst b/docs/source/features/version_control/getting_started_with_version_control.rst
@@ -32,6 +32,7 @@ The code below checkouts to the first commit and check the data amount.
    from tensorbay import GAS
    from tensorbay.dataset import Dataset
 
+   # Please visit `https://gas.graviti.cn/tensorbay/developer` to get the AccessKey.
    gas = GAS("<YOUR_ACCESSKEY>")
    commits = dataset_client.list_commits()