diff --git a/docs/source/advanced_features/fusion_dataset/CADC.rst b/docs/source/advanced_features/fusion_dataset/CADC.rst index deee8fd78..3a4f5acb4 100644 --- a/docs/source/advanced_features/fusion_dataset/CADC.rst +++ b/docs/source/advanced_features/fusion_dataset/CADC.rst @@ -184,7 +184,7 @@ to TensorBay for sharing, reuse, etc. Remember to execute the commit step after uploading. If needed, you can re-upload and commit again. -Please see :ref:`this page ` for more details about version control. +Please see :ref:`this page ` for more details about version control. .. note:: diff --git a/docs/source/advanced_features/fusion_dataset.rst b/docs/source/advanced_features/fusion_dataset/index.rst similarity index 86% rename from docs/source/advanced_features/fusion_dataset.rst rename to docs/source/advanced_features/fusion_dataset/index.rst index 78ef15af7..04d0d22a5 100644 --- a/docs/source/advanced_features/fusion_dataset.rst +++ b/docs/source/advanced_features/fusion_dataset/index.rst @@ -12,5 +12,5 @@ such as `nuScenes`_ and `KITTI-tracking`_. .. toctree:: :maxdepth: 1 - fusion_dataset/fusion_dataset_structure - fusion_dataset/CADC + fusion_dataset_structure + CADC diff --git a/docs/source/features/dataset_management.rst b/docs/source/features/dataset_management.rst index 6a58e1de6..c3adc13d0 100644 --- a/docs/source/features/dataset_management.rst +++ b/docs/source/features/dataset_management.rst @@ -31,7 +31,7 @@ The typical steps to organize a local dataset: A catalog is needed only if there is label information inside the dataset. -Take the :ref:`Organization of BSTLD ` as an example. +Take the :ref:`Organization of BSTLD ` as an example. **************** @@ -57,7 +57,7 @@ There are plenty of benefits of uploading local datasets to TensorBay. During uploading dataset or data, if the remote path of the data is the same as another data under the same segment, the old data will be replaced. -Take the :ref:`Upload Dataset of BSTLD ` as an example. +Take the :ref:`Upload Dataset of BSTLD ` as an example. ************** Read Dataset @@ -82,7 +82,7 @@ Two types of datasets can be read from TensorBay: .. _my datasets(or team datasets): https://gas.graviti.cn/tensorbay/dataset-list .. _TensorBay: https://gas.graviti.cn/tensorbay/ -Take the :ref:`Read Dataset of BSTLD ` as an example. +Take the :ref:`Read Dataset of BSTLD ` as an example. **************** Update Dataset @@ -91,7 +91,7 @@ Take the :ref:`Read Dataset of BSTLD ` as an exampl Since TensorBay supports version control, users can update dataset meta, notes, data and labels to a new commit of a dataset. Thus, different versions of data and labels can coexist in one dataset, which greatly facilitates the datasets' maintenance. -Please see :ref:`Update dataset` example for more details. +Please see :ref:`Update dataset` example for more details. *************** Move and Copy @@ -112,7 +112,7 @@ Moving is only supported within one dataset. The target dataset of copying and moving must be in :ref:`reference/glossary:draft` status. -Please see :ref:`Move and copy` example for more details. +Please see :ref:`Move and copy` example for more details. **************** Merge Datasets @@ -120,7 +120,7 @@ Please see :ref:`Move and copy` example fo Since TensorBay supports copy operation between different datasets, users can use it to merge datasets. -Please see :ref:`examples/merge_datasets:Merge Datasets` example for more details. +Please see :ref:`quick_start/examples/merge_datasets:Merge Datasets` example for more details. ********************** Get Label Statistics @@ -128,4 +128,4 @@ Please see :ref:`examples/merge_datasets:Merge Datasets` example for more detail TensorBay supports getting label statistics of dataset. -Please see :ref:`examples/get_label_statistics:Get Label Statistics` example for more details. +Please see :ref:`quick_start/examples/get_label_statistics:Get Label Statistics` example for more details. diff --git a/docs/source/version_control/branch.rst b/docs/source/features/version_control/branch.rst similarity index 82% rename from docs/source/version_control/branch.rst rename to docs/source/features/version_control/branch.rst index 691702aa2..c7438d527 100644 --- a/docs/source/version_control/branch.rst +++ b/docs/source/features/version_control/branch.rst @@ -9,7 +9,7 @@ Tensorbay encourages workflows that branch often, even multiple times in a day. Before operating branches, a dataset client instance with existing commit is needed. -.. literalinclude:: ../../../docs/code/branch.py +.. literalinclude:: ../../../../docs/code/branch.py :language: python :start-after: """Authorize a Dataset Client Instance""" :end-before: """""" @@ -23,7 +23,7 @@ Create Branch on the Current Commit TensorBay SDK supports creating the branch straightforwardly, which is based on the current commit. -.. literalinclude:: ../../../docs/code/branch.py +.. literalinclude:: ../../../../docs/code/branch.py :language: python :start-after: """Create Branch""" :end-before: """""" @@ -31,7 +31,7 @@ TensorBay SDK supports creating the branch straightforwardly, which is based on Then the dataset client will storage the branch name. "main" is the default branch, it will be created when init the dataset -.. literalinclude:: ../../../docs/code/branch.py +.. literalinclude:: ../../../../docs/code/branch.py :language: python :start-after: """Branch Name Will Be Stored""" :end-before: """""" @@ -41,28 +41,28 @@ Create Branch on a Revision Also, creating a branch based on a revision is allowed. -.. literalinclude:: ../../../docs/code/branch.py +.. literalinclude:: ../../../../docs/code/branch.py :language: python :start-after: """Create Branch Based On a Revision""" :end-before: """""" The dataset client will checkout to the branch. The stored commit id is from the commit which the branch points to. -.. literalinclude:: ../../../docs/code/branch.py +.. literalinclude:: ../../../../docs/code/branch.py :language: python :start-after: """Branch Name Will Be Stored(Revision)""" :end-before: """""" Specially, creating a branch based on a former commit is permitted. -.. literalinclude:: ../../../docs/code/branch.py +.. literalinclude:: ../../../../docs/code/branch.py :language: python :start-after: """Create Branch Based On a Former Commit""" :end-before: """""" Similarly, the dataset client will checkout to the branch. -.. literalinclude:: ../../../docs/code/branch.py +.. literalinclude:: ../../../../docs/code/branch.py :language: python :start-after: """Branch Name Will Be Stored(Former Commit)""" :end-before: """""" @@ -70,7 +70,7 @@ Similarly, the dataset client will checkout to the branch. Then, through creating and committing the draft based on the branch, diverging from the current line of development can be realized. -.. literalinclude:: ../../../docs/code/branch.py +.. literalinclude:: ../../../../docs/code/branch.py :language: python :start-after: """Create and Commit Draft""" :end-before: """""" @@ -79,7 +79,7 @@ based on the branch, diverging from the current line of development can be reali List Branches *************** -.. literalinclude:: ../../../docs/code/branch.py +.. literalinclude:: ../../../../docs/code/branch.py :language: python :start-after: """List Branches""" :end-before: """""" @@ -88,7 +88,7 @@ based on the branch, diverging from the current line of development can be reali Get Branch ************ -.. literalinclude:: ../../../docs/code/branch.py +.. literalinclude:: ../../../../docs/code/branch.py :language: python :start-after: """Get a Branch""" :end-before: """""" @@ -97,7 +97,7 @@ based on the branch, diverging from the current line of development can be reali Delete Branch *************** -.. literalinclude:: ../../../docs/code/branch.py +.. literalinclude:: ../../../../docs/code/branch.py :language: python :start-after: """Delete a Branch""" :end-before: """""" diff --git a/docs/source/version_control/diff.rst b/docs/source/features/version_control/diff.rst similarity index 91% rename from docs/source/version_control/diff.rst rename to docs/source/features/version_control/diff.rst index 5fa660e0b..18c602096 100644 --- a/docs/source/version_control/diff.rst +++ b/docs/source/features/version_control/diff.rst @@ -5,7 +5,7 @@ TensorBay supports showing changes between commits or drafts. Before operating the :ref:`reference/glossary:diff`, a dataset client instance with commits is needed. -See more details in :ref:`version_control/draft_and_commit:Draft and Commit` +See more details in :ref:`features/version_control/draft_and_commit:Draft and Commit` ********** Get Diff @@ -16,7 +16,7 @@ through :ref:`reference/glossary:basehead`. Currently, only obtaining the :ref:` between the head and its parent commit is supported; that is, the head is the given version(commit or draft) while the base is parent commit of the head. -.. literalinclude:: ../../../docs/code/diff.py +.. literalinclude:: ../../../../docs/code/diff.py :language: python :start-after: """Get Diff""" :end-before: """""" @@ -30,7 +30,7 @@ Get Diff on Revision For example, the following diff records the difference between the commit whose id is ``"3bc35d806e0347d08fc23564b82737dc"`` and its parent commit. -.. literalinclude:: ../../../docs/code/diff.py +.. literalinclude:: ../../../../docs/code/diff.py :language: python :start-after: """Get Diff on Commit""" :end-before: """""" @@ -41,7 +41,7 @@ Get Diff on Draft Number For example, the following diff records the difference between the draft whose draft number is ``1`` and its parent commit. -.. literalinclude:: ../../../docs/code/diff.py +.. literalinclude:: ../../../../docs/code/diff.py :language: python :start-after: """Get Diff on Draft""" :end-before: """""" @@ -85,4 +85,4 @@ The attribute "action" represents the status difference of the relative resource - unmodify - add - delete -- modify \ No newline at end of file +- modify diff --git a/docs/source/version_control/draft_and_commit.rst b/docs/source/features/version_control/draft_and_commit.rst similarity index 79% rename from docs/source/version_control/draft_and_commit.rst rename to docs/source/features/version_control/draft_and_commit.rst index 6d0053a28..e6a7c5928 100644 --- a/docs/source/version_control/draft_and_commit.rst +++ b/docs/source/features/version_control/draft_and_commit.rst @@ -16,7 +16,7 @@ In TensorBay SDK, the dataset client supplies the function of version control. Authorization ************** -.. literalinclude:: ../../../docs/code/draft_and_commit.py +.. literalinclude:: ../../../../docs/code/draft_and_commit.py :language: python :start-after: """Authorize a Dataset Client Instance""" :end-before: """""" @@ -28,7 +28,7 @@ Create Draft TensorBay SDK supports creating the draft straightforwardly, which is based on the current branch. Note that currently there can be only one open draft in each branch. -.. literalinclude:: ../../../docs/code/draft_and_commit.py +.. literalinclude:: ../../../../docs/code/draft_and_commit.py :language: python :start-after: """Create Draft""" :end-before: """""" @@ -36,14 +36,14 @@ Note that currently there can be only one open draft in each branch. Then the dataset client will change the status to "draft" and store the draft number. The draft number will be auto-increasing every time a draft is created. -.. literalinclude:: ../../../docs/code/draft_and_commit.py +.. literalinclude:: ../../../../docs/code/draft_and_commit.py :language: python :start-after: """Draft Number Will Be Stored""" :end-before: """""" Also, TensorBay SDK supports creating a draft based on a given branch. -.. literalinclude:: ../../../docs/code/draft_and_commit.py +.. literalinclude:: ../../../../docs/code/draft_and_commit.py :language: python :start-after: """Create Draft on a Branch""" :end-before: """""" @@ -57,7 +57,7 @@ The draft number can be found through listing drafts. ``status`` includes "OPEN", "CLOSED", "COMMITTED" and None where None means listing drafts in all status. ``branch_name`` refers to the branch name of the draft to be listed. -.. literalinclude:: ../../../docs/code/draft_and_commit.py +.. literalinclude:: ../../../../docs/code/draft_and_commit.py :language: python :start-after: """List Drafts""" :end-before: """""" @@ -66,7 +66,7 @@ The draft number can be found through listing drafts. Get Draft ********** -.. literalinclude:: ../../../docs/code/draft_and_commit.py +.. literalinclude:: ../../../../docs/code/draft_and_commit.py :language: python :start-after: """Get Draft""" :end-before: """""" @@ -77,7 +77,7 @@ Commit Draft After the commit, the draft will be closed. -.. literalinclude:: ../../../docs/code/draft_and_commit.py +.. literalinclude:: ../../../../docs/code/draft_and_commit.py :language: python :start-after: """Commit Draft""" :end-before: """""" @@ -86,7 +86,7 @@ After the commit, the draft will be closed. Get Commit *********** -.. literalinclude:: ../../../docs/code/draft_and_commit.py +.. literalinclude:: ../../../../docs/code/draft_and_commit.py :language: python :start-after: """Get Commit""" :end-before: """""" @@ -95,7 +95,7 @@ Get Commit List Commits ************* -.. literalinclude:: ../../../docs/code/draft_and_commit.py +.. literalinclude:: ../../../../docs/code/draft_and_commit.py :language: python :start-after: """List Commits""" :end-before: """""" @@ -104,7 +104,7 @@ List Commits Checkout ********* -.. literalinclude:: ../../../docs/code/draft_and_commit.py +.. literalinclude:: ../../../../docs/code/draft_and_commit.py :language: python :start-after: """Checkout""" :end-before: """""" diff --git a/docs/source/features/version_control.rst b/docs/source/features/version_control/index.rst similarity index 90% rename from docs/source/features/version_control.rst rename to docs/source/features/version_control/index.rst index 8026b6e45..334a105ef 100644 --- a/docs/source/features/version_control.rst +++ b/docs/source/features/version_control/index.rst @@ -15,7 +15,7 @@ Take the `VersionControlDemo Dataset ` is added by dataset_client.create_tag("v1.0.0", revision=SECOND_COMMIT_ID) -See :ref:`version_control/tag:Tag` for more details about tag. +See :ref:`features/version_control/tag:Tag` for more details about tag. ******** Branch @@ -146,7 +146,7 @@ and adds :ref:`classification ` as an example: +Take the :ref:`BSTLD ` as an example: .. literalinclude:: ../../../docs/code/pharos.py :language: python diff --git a/docs/source/index.rst b/docs/source/index.rst index bda5dad3a..82ff1bb42 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -35,21 +35,21 @@ It provides: :caption: Quick Start quick_start/getting_started_with_tensorbay - quick_start/examples + quick_start/examples/index .. toctree:: :maxdepth: 1 :caption: Features features/dataset_management - features/version_control + features/version_control/index features/visualization .. toctree:: :maxdepth: 1 :caption: Advanced Features - advanced_features/fusion_dataset + advanced_features/fusion_dataset/index advanced_features/cloud_storage advanced_features/request_configuration advanced_features/use_internal_endpoint @@ -78,9 +78,9 @@ It provides: reference/glossary reference/dataset_structure - reference/label_format + reference/label_format/index reference/exception - reference/api_reference + reference/api/index .. reference/release_note diff --git a/docs/source/quick_start/examples.rst b/docs/source/quick_start/examples.rst deleted file mode 100644 index bf2e00a64..000000000 --- a/docs/source/quick_start/examples.rst +++ /dev/null @@ -1,58 +0,0 @@ -########## - Examples -########## - -The following table lists a series of examples to help developers to use TensorBay(:numref:`Table. %s `). - -.. _examples_table: - -.. table:: Examples - :align: center - :widths: auto - - ========================================================= ========================================================================= - Examples Description - ========================================================= ========================================================================= - :ref:`examples/DogsVsCats:Dogs vs Cats` | Topic: Dataset Management - | Data Type: Image - | Label Type: :ref:`reference/label_format/Classification:Classification` - :ref:`examples/Newsgroups20:20 Newsgroups` | Topic: Dataset Management - | Data Type: Text - | Label Type: :ref:`reference/label_format/Classification:Classification` - :ref:`examples/BSTLD:BSTLD` | Topic: Dataset Management - | Data Type: Image - | Label Type: :ref:`reference/label_format/Box2D:Box2D` - :ref:`examples/NeolixOD:Neolix OD` | Topic: Dataset Management - | Data Type: Point Cloud - | Label Type: :ref:`reference/label_format/Box3D:Box3D` - :ref:`examples/LeedsSportsPose:Leeds Sports Pose` | Topic: Dataset Management - | Data Type: Image - | Label Type: :ref:`reference/label_format/Keypoints2D:Keypoints2D` - :ref:`examples/THCHS30:THCHS-30` | Topic: Dataset Management - | Data Type: Audio - | Label Type: :ref:`reference/label_format/Sentence:Sentence` - :ref:`examples/VOC2012Segmentation:VOC2012 Segmentation` | Topic: Dataset Management - | Data Type: Image - | Label Types: :ref:`reference/label_format/SemanticMask:SemanticMask`, - :ref:`reference/label_format/InstanceMask:InstanceMask` - :ref:`examples/update_dataset:Update Dataset` | Topic: Update Dataset - :ref:`examples/move_and_copy:Move And Copy` | Topic: Move And Copy - :ref:`examples/merge_datasets:Merge Datasets` | Topic: Merge Datasets - :ref:`examples/get_label_statistics:Get Label Statistics` | Topic: Get Label Statistics - ========================================================= ========================================================================= - -.. toctree:: - :hidden: - :maxdepth: 1 - - ../examples/DogsVsCats - ../examples/BSTLD - ../examples/LeedsSportsPose - ../examples/NeolixOD - ../examples/THCHS30 - ../examples/Newsgroups20 - ../examples/VOC2012Segmentation - ../examples/update_dataset - ../examples/move_and_copy - ../examples/merge_datasets - ../examples/get_label_statistics diff --git a/docs/source/examples/BSTLD.rst b/docs/source/quick_start/examples/BSTLD.rst similarity index 86% rename from docs/source/examples/BSTLD.rst rename to docs/source/quick_start/examples/BSTLD.rst index 1ca833d4e..59e2b579a 100644 --- a/docs/source/examples/BSTLD.rst +++ b/docs/source/quick_start/examples/BSTLD.rst @@ -7,7 +7,7 @@ which is a dataset with :ref:`reference/label_format/Box2D:Box2D` label(:numref: .. _example-bstld: -.. figure:: ../images/example-Box2D.png +.. figure:: ../../images/example-Box2D.png :scale: 50 % :align: center @@ -19,7 +19,7 @@ which is a dataset with :ref:`reference/label_format/Box2D:Box2D` label(:numref: An :ref:`reference/glossary:accesskey` is needed to authenticate identity when using TensorBay. -.. literalinclude:: ../../../docs/code/BSTLD.py +.. literalinclude:: ../../../../docs/code/BSTLD.py :language: python :start-after: """Authorize a Client Instance""" :end-before: """""" @@ -28,7 +28,7 @@ An :ref:`reference/glossary:accesskey` is needed to authenticate identity when u Create Dataset **************** -.. literalinclude:: ../../../docs/code/BSTLD.py +.. literalinclude:: ../../../../docs/code/BSTLD.py :language: python :start-after: """Create Dataset""" :end-before: """""" @@ -45,7 +45,7 @@ Step 1: Write the Catalog A :ref:`reference/dataset_structure:catalog` contains all label information of one dataset, which is typically stored in a json file. -.. literalinclude:: ../../../tensorbay/opendataset/BSTLD/catalog.json +.. literalinclude:: ../../../../tensorbay/opendataset/BSTLD/catalog.json :language: json :name: BSTLD-catalog :linenos: @@ -63,7 +63,7 @@ Step 2: Write the Dataloader A :ref:`reference/glossary:dataloader` is needed to organize the dataset into a :class:`~tensorbay.dataset.dataset.Dataset` instance. -.. literalinclude:: ../../../tensorbay/opendataset/BSTLD/loader.py +.. literalinclude:: ../../../../tensorbay/opendataset/BSTLD/loader.py :language: python :name: BSTLD-dataloader :linenos: @@ -74,7 +74,7 @@ See :ref:`Box2D annotation ` for more detail There are already a number of dataloaders in TensorBay SDK provided by the community. Thus, instead of writing, importing an available dataloader is also feasible. -.. literalinclude:: ../../../docs/code/BSTLD.py +.. literalinclude:: ../../../../docs/code/BSTLD.py :language: python :start-after: """Organize dataset / import dataloader""" :end-before: """""" @@ -101,7 +101,7 @@ Please see :ref:`features/visualization:Visualization` for more details. The organized "BSTLD" dataset can be uploaded to TensorBay for sharing, reuse, etc. -.. literalinclude:: ../../../docs/code/BSTLD.py +.. literalinclude:: ../../../../docs/code/BSTLD.py :language: python :start-after: """Upload Dataset""" :end-before: """""" @@ -112,7 +112,7 @@ The organized "BSTLD" dataset can be uploaded to TensorBay for sharing, reuse, e 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. +Please see :ref:`features/version_control/index:Version Control` for more details. ************** Read Dataset @@ -120,7 +120,7 @@ Please see :ref:`features/version_control:Version Control` for more details. Now "BSTLD" dataset can be read from TensorBay. -.. literalinclude:: ../../../docs/code/BSTLD.py +.. literalinclude:: ../../../../docs/code/BSTLD.py :language: python :start-after: """Read Dataset / get dataset""" :end-before: """""" @@ -129,14 +129,14 @@ In :ref:`reference/dataset_structure:dataset` "BSTLD", there are three :ref:`segments `: ``train``, ``test`` and ``additional``. Get the segment names by listing them all. -.. literalinclude:: ../../../docs/code/BSTLD.py +.. literalinclude:: ../../../../docs/code/BSTLD.py :language: python :start-after: """Read Dataset / list segment names""" :end-before: """""" Get a segment by passing the required segment name. -.. literalinclude:: ../../../docs/code/BSTLD.py +.. literalinclude:: ../../../../docs/code/BSTLD.py :language: python :start-after: """Read Dataset / get segment""" :end-before: """""" @@ -145,7 +145,7 @@ Get a segment by passing the required segment name. In the train :ref:`reference/dataset_structure:segment`, there is a sequence of :ref:`reference/dataset_structure:data`, which can be obtained by index. -.. literalinclude:: ../../../docs/code/BSTLD.py +.. literalinclude:: ../../../../docs/code/BSTLD.py :language: python :start-after: """Read Dataset / get data""" :end-before: """""" @@ -154,7 +154,7 @@ In each :ref:`reference/dataset_structure:data`, there is a sequence of :ref:`reference/label_format/Box2D:Box2D` annotations, which can be obtained by index. -.. literalinclude:: ../../../docs/code/BSTLD.py +.. literalinclude:: ../../../../docs/code/BSTLD.py :language: python :start-after: """Read Dataset / get label""" :end-before: """""" @@ -169,7 +169,7 @@ See :ref:`reference/label_format/Box2D:Box2D` label format for more details. Delete Dataset **************** -.. literalinclude:: ../../../docs/code/BSTLD.py +.. literalinclude:: ../../../../docs/code/BSTLD.py :language: python :start-after: """Delete Dataset""" :end-before: """""" diff --git a/docs/source/examples/DogsVsCats.rst b/docs/source/quick_start/examples/DogsVsCats.rst similarity index 85% rename from docs/source/examples/DogsVsCats.rst rename to docs/source/quick_start/examples/DogsVsCats.rst index 83ddcd670..660345182 100644 --- a/docs/source/examples/DogsVsCats.rst +++ b/docs/source/quick_start/examples/DogsVsCats.rst @@ -11,7 +11,7 @@ which is a dataset with :ref:`reference/label_format/Classification:Classificati An :ref:`reference/glossary:accesskey` is needed to authenticate identity when using TensorBay. -.. literalinclude:: ../../../docs/code/DogsVsCats.py +.. literalinclude:: ../../../../docs/code/DogsVsCats.py :language: python :start-after: """Authorize a Client Instance""" :end-before: """""" @@ -20,7 +20,7 @@ An :ref:`reference/glossary:accesskey` is needed to authenticate identity when u Create Dataset **************** -.. literalinclude:: ../../../docs/code/DogsVsCats.py +.. literalinclude:: ../../../../docs/code/DogsVsCats.py :language: python :start-after: """Create Dataset""" :end-before: """""" @@ -37,7 +37,7 @@ Step 1: Write the Catalog A :ref:`reference/dataset_structure:catalog` contains all label information of one dataset, which is typically stored in a json file. -.. literalinclude:: ../../../tensorbay/opendataset/DogsVsCats/catalog.json +.. literalinclude:: ../../../../tensorbay/opendataset/DogsVsCats/catalog.json :language: json :name: dogsvscats-catalog :linenos: @@ -55,7 +55,7 @@ Step 2: Write the Dataloader A :ref:`reference/glossary:dataloader` is needed to organize the dataset into a :class:`~tensorbay.dataset.dataset.Dataset` instance. -.. literalinclude:: ../../../tensorbay/opendataset/DogsVsCats/loader.py +.. literalinclude:: ../../../../tensorbay/opendataset/DogsVsCats/loader.py :language: python :name: dogsvscats-dataloader :linenos: @@ -66,7 +66,7 @@ See :ref:`Classification annotation `: ``train`` and ``test``. Get the segment names by listing them all. -.. literalinclude:: ../../../docs/code/DogsVsCats.py +.. literalinclude:: ../../../../docs/code/DogsVsCats.py :language: python :start-after: """Read Dataset / list segment names""" :end-before: """""" Get a segment by passing the required segment name. -.. literalinclude:: ../../../docs/code/DogsVsCats.py +.. literalinclude:: ../../../../docs/code/DogsVsCats.py :language: python :start-after: """Read Dataset / get segment""" :end-before: """""" @@ -132,7 +132,7 @@ Get a segment by passing the required segment name. In the train :ref:`reference/dataset_structure:segment`, there is a sequence of :ref:`reference/dataset_structure:data`, which can be obtained by index. -.. literalinclude:: ../../../docs/code/DogsVsCats.py +.. literalinclude:: ../../../../docs/code/DogsVsCats.py :language: python :start-after: """Read Dataset / get data""" :end-before: """""" @@ -141,7 +141,7 @@ In each :ref:`reference/dataset_structure:data`, there is a sequence of :ref:`reference/label_format/Classification:Classification` annotations, which can be obtained by index. -.. literalinclude:: ../../../docs/code/DogsVsCats.py +.. literalinclude:: ../../../../docs/code/DogsVsCats.py :language: python :start-after: """Read Dataset / get label""" :end-before: """""" @@ -154,7 +154,7 @@ See :ref:`reference/label_format/Classification:Classification` label format for Delete Dataset **************** -.. literalinclude:: ../../../docs/code/DogsVsCats.py +.. literalinclude:: ../../../../docs/code/DogsVsCats.py :language: python :start-after: """Delete Dataset""" :end-before: """""" diff --git a/docs/source/examples/LeedsSportsPose.rst b/docs/source/quick_start/examples/LeedsSportsPose.rst similarity index 84% rename from docs/source/examples/LeedsSportsPose.rst rename to docs/source/quick_start/examples/LeedsSportsPose.rst index 1add86a45..5f0cf657a 100644 --- a/docs/source/examples/LeedsSportsPose.rst +++ b/docs/source/quick_start/examples/LeedsSportsPose.rst @@ -7,7 +7,7 @@ which is a dataset with :ref:`reference/label_format/Keypoints2D:Keypoints2D` la .. _example-leedssportspose: -.. figure:: ../images/example-Keypoints2D.png +.. figure:: ../../images/example-Keypoints2D.png :scale: 80 % :align: center @@ -19,7 +19,7 @@ which is a dataset with :ref:`reference/label_format/Keypoints2D:Keypoints2D` la An :ref:`reference/glossary:accesskey` is needed to authenticate identity when using TensorBay. -.. literalinclude:: ../../../docs/code/LeedsSportsPose.py +.. literalinclude:: ../../../../docs/code/LeedsSportsPose.py :language: python :start-after: """Authorize a Client Instance""" :end-before: """""" @@ -28,7 +28,7 @@ An :ref:`reference/glossary:accesskey` is needed to authenticate identity when u Create Dataset **************** -.. literalinclude:: ../../../docs/code/LeedsSportsPose.py +.. literalinclude:: ../../../../docs/code/LeedsSportsPose.py :language: python :start-after: """Create Dataset""" :end-before: """""" @@ -45,7 +45,7 @@ Step 1: Write the Catalog A :ref:`reference/dataset_structure:catalog` contains all label information of one dataset, which is typically stored in a json file. -.. literalinclude:: ../../../tensorbay/opendataset/LeedsSportsPose/catalog.json +.. literalinclude:: ../../../../tensorbay/opendataset/LeedsSportsPose/catalog.json :language: json :name: LeedsSportsPose-catalog :linenos: @@ -62,7 +62,7 @@ Step 2: Write the Dataloader A :ref:`reference/glossary:dataloader` is needed to organize the dataset into a :class:`~tensorbay.dataset.dataset.Dataset` instance. -.. literalinclude:: ../../../tensorbay/opendataset/LeedsSportsPose/loader.py +.. literalinclude:: ../../../../tensorbay/opendataset/LeedsSportsPose/loader.py :language: python :name: LeedsSportsPose-dataloader :linenos: @@ -73,7 +73,7 @@ See :ref:`Keipoints2D annotation ` contains all label information of one dataset, which is typically stored in a json file. -.. literalinclude:: ../../../tensorbay/opendataset/NeolixOD/catalog.json +.. literalinclude:: ../../../../tensorbay/opendataset/NeolixOD/catalog.json :language: json :name: neolixod-catalog :linenos: @@ -67,7 +67,7 @@ Step 2: Write the Dataloader A :ref:`reference/glossary:dataloader` is needed to organize the dataset into a :class:`~tensorbay.dataset.dataset.Dataset` instance. -.. literalinclude:: ../../../tensorbay/opendataset/NeolixOD/loader.py +.. literalinclude:: ../../../../tensorbay/opendataset/NeolixOD/loader.py :language: python :name: neolixod-dataloader :linenos: @@ -78,7 +78,7 @@ See :ref:`Box3D annotation ` for more detail There are already a number of dataloaders in TensorBay SDK provided by the community. Thus, instead of writing, importing an available dataloader is also feasible. -.. literalinclude:: ../../../docs/code/NeolixOD.py +.. literalinclude:: ../../../../docs/code/NeolixOD.py :language: python :start-after: """Organize dataset / import dataloader""" :end-before: """""" @@ -105,14 +105,14 @@ Please see :ref:`features/visualization:Visualization` for more details. The organized "Neolix OD" dataset can be uploaded to tensorBay for sharing, reuse, etc. -.. literalinclude:: ../../../docs/code/NeolixOD.py +.. literalinclude:: ../../../../docs/code/NeolixOD.py :language: python :start-after: """Upload Dataset""" :end-before: """""" 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. +Please see :ref:`features/version_control/index:Version Control` for more details. ************** Read Dataset @@ -120,7 +120,7 @@ Please see :ref:`features/version_control:Version Control` for more details. Now "Neolix OD" dataset can be read from TensorBay. -.. literalinclude:: ../../../docs/code/NeolixOD.py +.. literalinclude:: ../../../../docs/code/NeolixOD.py :language: python :start-after: """Read Dataset / get dataset""" :end-before: """""" @@ -129,7 +129,7 @@ In :ref:`reference/dataset_structure:Dataset` "Neolix OD", there is only one :ref:`segment `: ``default``. Get a segment by passing the required segment name or the index. -.. literalinclude:: ../../../docs/code/NeolixOD.py +.. literalinclude:: ../../../../docs/code/NeolixOD.py :language: python :start-after: """Read Dataset / get segment""" :end-before: """""" @@ -138,7 +138,7 @@ In the default :ref:`reference/dataset_structure:Segment`, there is a sequence of :ref:`reference/dataset_structure:Data`, which can be obtained by index. -.. literalinclude:: ../../../docs/code/NeolixOD.py +.. literalinclude:: ../../../../docs/code/NeolixOD.py :language: python :start-after: """Read Dataset / get data""" :end-before: """""" @@ -146,7 +146,7 @@ which can be obtained by index. In each :ref:`reference/dataset_structure:Data`, there is a sequence of :ref:`reference/label_format/Box3D:Box3D` annotations, -.. literalinclude:: ../../../docs/code/NeolixOD.py +.. literalinclude:: ../../../../docs/code/NeolixOD.py :language: python :start-after: """Read Dataset / get label""" :end-before: """""" @@ -162,7 +162,7 @@ See :ref:`reference/label_format/Box3D:Box3D` label format for more details. Delete Dataset **************** -.. literalinclude:: ../../../docs/code/NeolixOD.py +.. literalinclude:: ../../../../docs/code/NeolixOD.py :language: python :start-after: """Delete Dataset""" :end-before: """""" diff --git a/docs/source/examples/Newsgroups20.rst b/docs/source/quick_start/examples/Newsgroups20.rst similarity index 86% rename from docs/source/examples/Newsgroups20.rst rename to docs/source/quick_start/examples/Newsgroups20.rst index ec273b317..1531062c8 100644 --- a/docs/source/examples/Newsgroups20.rst +++ b/docs/source/quick_start/examples/Newsgroups20.rst @@ -13,7 +13,7 @@ with :ref:`reference/label_format/Classification:Classification` label type. An :ref:`reference/glossary:accesskey` is needed to authenticate identity when using TensorBay. -.. literalinclude:: ../../../docs/code/Newsgroups20.py +.. literalinclude:: ../../../../docs/code/Newsgroups20.py :language: python :start-after: """Authorize a Client Instance""" :end-before: """""" @@ -22,7 +22,7 @@ An :ref:`reference/glossary:accesskey` is needed to authenticate identity when u Create Dataset **************** -.. literalinclude:: ../../../docs/code/Newsgroups20.py +.. literalinclude:: ../../../../docs/code/Newsgroups20.py :language: python :start-after: """Create Dataset""" :end-before: """""" @@ -40,7 +40,7 @@ Step 1: Write the Catalog A :ref:`Catalog ` contains all label information of one dataset, which is typically stored in a json file. -.. literalinclude:: ../../../tensorbay/opendataset/Newsgroups20/catalog.json +.. literalinclude:: ../../../../tensorbay/opendataset/Newsgroups20/catalog.json :language: json :name: Newsgroups20-catalog :linenos: @@ -63,7 +63,7 @@ Step 2: Write the Dataloader A :ref:`reference/glossary:Dataloader` is neeeded to organize the dataset into a :class:`~tensorbay.dataset.dataset.Dataset` instance. -.. literalinclude:: ../../../tensorbay/opendataset/Newsgroups20/loader.py +.. literalinclude:: ../../../../tensorbay/opendataset/Newsgroups20/loader.py :language: python :name: Newsgroups20-dataloader :linenos: @@ -80,7 +80,7 @@ See :ref:`Classification annotation ` is needed to organize the dataset into a :class:`~tensorbay.dataset.dataset.Dataset` instance. -.. literalinclude:: ../../../tensorbay/opendataset/THCHS30/loader.py +.. literalinclude:: ../../../../tensorbay/opendataset/THCHS30/loader.py :language: python :name: THCHS30-dataloader :linenos: @@ -63,7 +63,7 @@ See :ref:`Sentence annotation ` for mo There are already a number of dataloaders in TensorBay SDK provided by the community. Thus, instead of writing, importing an available dataloadert is also feasible. -.. literalinclude:: ../../../docs/code/THCHS30.py +.. literalinclude:: ../../../../docs/code/THCHS30.py :language: python :start-after: """Organize dataset / import dataloader""" :end-before: """""" @@ -90,14 +90,14 @@ Upload Dataset The organized "THCHS-30" dataset can be uploaded to TensorBay for sharing, reuse, etc. -.. literalinclude:: ../../../docs/code/THCHS30.py +.. literalinclude:: ../../../../docs/code/THCHS30.py :language: python :start-after: """Upload Dataset""" :end-before: """""" 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. +Please see :ref:`features/version_control/index:Version Control` for more details. ************** Read Dataset @@ -105,7 +105,7 @@ Read Dataset Now "THCHS-30" dataset can be read from TensorBay. -.. literalinclude:: ../../../docs/code/THCHS30.py +.. literalinclude:: ../../../../docs/code/THCHS30.py :language: python :start-after: """Read Dataset / get dataset""" :end-before: """""" @@ -115,14 +115,14 @@ In :ref:`reference/dataset_structure:Dataset` "THCHS-30", there are three ``dev``, ``train`` and ``test``. Get the segment names by listing them all. -.. literalinclude:: ../../../docs/code/THCHS30.py +.. literalinclude:: ../../../../docs/code/THCHS30.py :language: python :start-after: """Read Dataset / list segment names""" :end-before: """""" Get a segment by passing the required segment name. -.. literalinclude:: ../../../docs/code/THCHS30.py +.. literalinclude:: ../../../../docs/code/THCHS30.py :language: python :start-after: """Read Dataset / get segment""" :end-before: """""" @@ -131,7 +131,7 @@ In the dev :ref:`reference/dataset_structure:Segment`, there is a sequence of :ref:`reference/dataset_structure:Data`, which can be obtained by index. -.. literalinclude:: ../../../docs/code/THCHS30.py +.. literalinclude:: ../../../../docs/code/THCHS30.py :language: python :start-after: """Read Dataset / get data""" :end-before: """""" @@ -140,7 +140,7 @@ In each :ref:`reference/dataset_structure:Data`, there is a sequence of :ref:`reference/label_format/Sentence:Sentence` annotations, which can be obtained by index. -.. literalinclude:: ../../../docs/code/THCHS30.py +.. literalinclude:: ../../../../docs/code/THCHS30.py :language: python :start-after: """Read Dataset / get label""" :end-before: """""" @@ -153,7 +153,7 @@ label format for more details. Delete Dataset **************** -.. literalinclude:: ../../../docs/code/THCHS30.py +.. literalinclude:: ../../../../docs/code/THCHS30.py :language: python :start-after: """Delete Dataset""" :end-before: """""" diff --git a/docs/source/examples/VOC2012Segmentation.rst b/docs/source/quick_start/examples/VOC2012Segmentation.rst similarity index 85% rename from docs/source/examples/VOC2012Segmentation.rst rename to docs/source/quick_start/examples/VOC2012Segmentation.rst index bc68fedb0..6c64d3724 100644 --- a/docs/source/examples/VOC2012Segmentation.rst +++ b/docs/source/quick_start/examples/VOC2012Segmentation.rst @@ -11,7 +11,7 @@ and :ref:`reference/label_format/InstanceMask:InstanceMask` labels .. _example-semantic-mask: -.. figure:: ../images/example-semanticmask.png +.. figure:: ../../images/example-semanticmask.png :scale: 150 % :align: center @@ -19,7 +19,7 @@ and :ref:`reference/label_format/InstanceMask:InstanceMask` labels .. _example-instance-mask: -.. figure:: ../images/example-instancemask.png +.. figure:: ../../images/example-instancemask.png :scale: 150 % :align: center @@ -32,7 +32,7 @@ and :ref:`reference/label_format/InstanceMask:InstanceMask` labels An :ref:`reference/glossary:accesskey` is needed to authenticate identity when using TensorBay. -.. literalinclude:: ../../../docs/code/VOC2012Segmentation.py +.. literalinclude:: ../../../../docs/code/VOC2012Segmentation.py :language: python :start-after: """Authorize a Client Instance""" :end-before: """""" @@ -42,7 +42,7 @@ An :ref:`reference/glossary:accesskey` is needed to authenticate identity when u **************** -.. literalinclude:: ../../../docs/code/VOC2012Segmentation.py +.. literalinclude:: ../../../../docs/code/VOC2012Segmentation.py :language: python :start-after: """Create Dataset""" :end-before: """""" @@ -59,7 +59,7 @@ Step 1: Write the Catalog A :ref:`Catalog ` contains all label information of one dataset, which is typically stored in a json file. -.. literalinclude:: ../../../tensorbay/opendataset/VOC2012Segmentation/catalog.json +.. literalinclude:: ../../../../tensorbay/opendataset/VOC2012Segmentation/catalog.json :language: json :name: voc2012segmentation-catalog :linenos: @@ -84,7 +84,7 @@ Step 2: Write the Dataloader A :ref:`reference/glossary:dataloader` is needed to organize the dataset into a :class:`~tensorbay.dataset.dataset.Dataset` instance. -.. literalinclude:: ../../../tensorbay/opendataset/VOC2012Segmentation/loader.py +.. literalinclude:: ../../../../tensorbay/opendataset/VOC2012Segmentation/loader.py :language: python :name: voc2012segmentation-dataloader :linenos: @@ -96,7 +96,7 @@ and :ref:`InstanceMask annotation `: ``train`` and ``val``. Get a segment by passing the required segment name or the index. -.. literalinclude:: ../../../docs/code/VOC2012Segmentation.py +.. literalinclude:: ../../../../docs/code/VOC2012Segmentation.py :language: python :start-after: """Read Dataset / get segment""" :end-before: """""" @@ -150,7 +150,7 @@ In the ``train`` :ref:`reference/dataset_structure:Segment`, there is a sequence of :ref:`reference/dataset_structure:Data`, which can be obtained by index. -.. literalinclude:: ../../../docs/code/VOC2012Segmentation.py +.. literalinclude:: ../../../../docs/code/VOC2012Segmentation.py :language: python :start-after: """Read Dataset / get data""" :end-before: """""" @@ -158,7 +158,7 @@ which can be obtained by index. In each :ref:`reference/dataset_structure:Data`, there are one :ref:`reference/label_format/SemanticMask:SemanticMask` annotation and one :ref:`reference/label_format/InstanceMask:InstanceMask` annotation. -.. literalinclude:: ../../../docs/code/VOC2012Segmentation.py +.. literalinclude:: ../../../../docs/code/VOC2012Segmentation.py :language: python :start-after: """Read Dataset / get label""" :end-before: """""" @@ -175,7 +175,7 @@ See :ref:`reference/label_format/SemanticMask:SemanticMask` and :ref:`reference/ Delete Dataset **************** -.. literalinclude:: ../../../docs/code/VOC2012Segmentation.py +.. literalinclude:: ../../../../docs/code/VOC2012Segmentation.py :language: python :start-after: """Delete Dataset""" :end-before: """""" diff --git a/docs/source/examples/get_label_statistics.rst b/docs/source/quick_start/examples/get_label_statistics.rst similarity index 100% rename from docs/source/examples/get_label_statistics.rst rename to docs/source/quick_start/examples/get_label_statistics.rst diff --git a/docs/source/quick_start/examples/index.rst b/docs/source/quick_start/examples/index.rst new file mode 100644 index 000000000..4a7c7a0b9 --- /dev/null +++ b/docs/source/quick_start/examples/index.rst @@ -0,0 +1,58 @@ +######### + Example +######### + +The following table lists a series of examples to help developers to use TensorBay(:numref:`Table. %s `). + +.. _examples_table: + +.. table:: Examples + :align: center + :widths: auto + + ====================================================================== ========================================================================= + Examples Description + ====================================================================== ========================================================================= + :ref:`quick_start/examples/DogsVsCats:Dogs vs Cats` | Topic: Dataset Management + | Data Type: Image + | Label Type: :ref:`reference/label_format/Classification:Classification` + :ref:`quick_start/examples/Newsgroups20:20 Newsgroups` | Topic: Dataset Management + | Data Type: Text + | Label Type: :ref:`reference/label_format/Classification:Classification` + :ref:`quick_start/examples/BSTLD:BSTLD` | Topic: Dataset Management + | Data Type: Image + | Label Type: :ref:`reference/label_format/Box2D:Box2D` + :ref:`quick_start/examples/NeolixOD:Neolix OD` | Topic: Dataset Management + | Data Type: Point Cloud + | Label Type: :ref:`reference/label_format/Box3D:Box3D` + :ref:`quick_start/examples/LeedsSportsPose:Leeds Sports Pose` | Topic: Dataset Management + | Data Type: Image + | Label Type: :ref:`reference/label_format/Keypoints2D:Keypoints2D` + :ref:`quick_start/examples/THCHS30:THCHS-30` | Topic: Dataset Management + | Data Type: Audio + | Label Type: :ref:`reference/label_format/Sentence:Sentence` + :ref:`quick_start/examples/VOC2012Segmentation:VOC2012 Segmentation` | Topic: Dataset Management + | Data Type: Image + | Label Types: :ref:`reference/label_format/SemanticMask:SemanticMask`, + :ref:`reference/label_format/InstanceMask:InstanceMask` + :ref:`quick_start/examples/update_dataset:Update Dataset` | Topic: Update Dataset + :ref:`quick_start/examples/move_and_copy:Move And Copy` | Topic: Move And Copy + :ref:`quick_start/examples/merge_datasets:Merge Datasets` | Topic: Merge Datasets + :ref:`quick_start/examples/get_label_statistics:Get Label Statistics` | Topic: Get Label Statistics + ====================================================================== ========================================================================= + +.. toctree:: + :hidden: + :maxdepth: 2 + + DogsVsCats + Newsgroups20 + BSTLD + NeolixOD + LeedsSportsPose + THCHS30 + VOC2012Segmentation + update_dataset + move_and_copy + merge_datasets + get_label_statistics diff --git a/docs/source/examples/merge_datasets.rst b/docs/source/quick_start/examples/merge_datasets.rst similarity index 85% rename from docs/source/examples/merge_datasets.rst rename to docs/source/quick_start/examples/merge_datasets.rst index 27b79ef7a..92c503175 100644 --- a/docs/source/examples/merge_datasets.rst +++ b/docs/source/quick_start/examples/merge_datasets.rst @@ -35,21 +35,21 @@ merge them to get a more diverse dataset. Create a dataset which is named ``mergedDataset``. -.. literalinclude:: ../../../docs/code/merge_datasets.py +.. literalinclude:: ../../../../docs/code/merge_datasets.py :language: python :start-after: """Create Target Dataset""" :end-before: """""" Copy all segments in ``OxfordIIITPetDog`` to ``mergedDataset``. -.. literalinclude:: ../../../docs/code/merge_datasets.py +.. literalinclude:: ../../../../docs/code/merge_datasets.py :language: python :start-after: """Copy Segment From Pet""" :end-before: """""" Use the catalog of OxfordIIITPet as the catalog of the merged dataset. -.. literalinclude:: ../../../docs/code/merge_datasets.py +.. literalinclude:: ../../../../docs/code/merge_datasets.py :language: python :start-after: """Upload Catalog""" :end-before: """""" @@ -57,7 +57,7 @@ Use the catalog of OxfordIIITPet as the catalog of the merged dataset. Unify categories of ``train`` segment. -.. literalinclude:: ../../../docs/code/merge_datasets.py +.. literalinclude:: ../../../../docs/code/merge_datasets.py :language: python :start-after: """Unify Category""" :end-before: """""" @@ -70,7 +70,7 @@ Unify categories of ``train`` segment. Copy data from ``Dogs vs Cats`` to ``mergedDataset``. -.. literalinclude:: ../../../docs/code/merge_datasets.py +.. literalinclude:: ../../../../docs/code/merge_datasets.py :language: python :start-after: """Copy Data From Dog VS Cat""" :end-before: """""" diff --git a/docs/source/examples/move_and_copy.rst b/docs/source/quick_start/examples/move_and_copy.rst similarity index 79% rename from docs/source/examples/move_and_copy.rst rename to docs/source/quick_start/examples/move_and_copy.rst index 9a12909d3..8c6981dc3 100644 --- a/docs/source/examples/move_and_copy.rst +++ b/docs/source/quick_start/examples/move_and_copy.rst @@ -4,10 +4,10 @@ This topic describes TensorBay dataset operations: -- :ref:`examples/move_and_copy:Copy Segment` -- :ref:`examples/move_and_copy:Move Segment` -- :ref:`examples/move_and_copy:Copy Data` -- :ref:`examples/move_and_copy:Move Data` +- :ref:`quick_start/examples/move_and_copy:Copy Segment` +- :ref:`quick_start/examples/move_and_copy:Move Segment` +- :ref:`quick_start/examples/move_and_copy:Copy Data` +- :ref:`quick_start/examples/move_and_copy:Move Data` Take the `Oxford-IIIT Pet `_ as an example. Its structure looks like:: @@ -27,7 +27,7 @@ as an example. Its structure looks like:: Get the dataset client. -.. literalinclude:: ../../../docs/code/move_and_copy.py +.. literalinclude:: ../../../../docs/code/move_and_copy.py :language: python :start-after: """Get Dataset Client""" :end-before: """""" @@ -40,7 +40,7 @@ There are currently two segments: ``test`` and ``trainval``. Copy segment ``test`` to ``test_1``. -.. literalinclude:: ../../../docs/code/move_and_copy.py +.. literalinclude:: ../../../../docs/code/move_and_copy.py :language: python :start-after: """Copy Segment""" :end-before: """""" @@ -51,7 +51,7 @@ Copy segment ``test`` to ``test_1``. Move segment ``test`` to ``test_2``. -.. literalinclude:: ../../../docs/code/move_and_copy.py +.. literalinclude:: ../../../../docs/code/move_and_copy.py :language: python :start-after: """Move Segment""" :end-before: """""" @@ -63,7 +63,7 @@ Move segment ``test`` to ``test_2``. Copy all data with prefix ``Abyssinian`` in both ``test_1`` and ``trainval`` segments to ``abyssinian`` segment. -.. literalinclude:: ../../../docs/code/move_and_copy.py +.. literalinclude:: ../../../../docs/code/move_and_copy.py :language: python :start-after: """Copy Data""" :end-before: """""" @@ -77,7 +77,7 @@ Split ``trainval`` segment into ``train`` and ``val``: #. Extract 500 data from ``trainval`` to ``val`` segment. #. Move ``trainval`` to ``train``. -.. literalinclude:: ../../../docs/code/move_and_copy.py +.. literalinclude:: ../../../../docs/code/move_and_copy.py :language: python :start-after: """Move Data""" :end-before: """""" diff --git a/docs/source/examples/update_dataset.rst b/docs/source/quick_start/examples/update_dataset.rst similarity index 77% rename from docs/source/examples/update_dataset.rst rename to docs/source/quick_start/examples/update_dataset.rst index bafb229f9..e35bc5513 100644 --- a/docs/source/examples/update_dataset.rst +++ b/docs/source/quick_start/examples/update_dataset.rst @@ -4,10 +4,10 @@ This topic describes how to update datasets, including: -- :ref:`examples/update_dataset:Update Dataset Meta` -- :ref:`examples/update_dataset:Update Dataset Notes` -- :ref:`examples/update_dataset:Update Label` -- :ref:`examples/update_dataset:Update Data` +- :ref:`quick_start/examples/update_dataset:Update Dataset Meta` +- :ref:`quick_start/examples/update_dataset:Update Dataset Notes` +- :ref:`quick_start/examples/update_dataset:Update Label` +- :ref:`quick_start/examples/update_dataset:Update Data` The following scenario is used for demonstrating how to update data and label: @@ -24,7 +24,7 @@ The following scenario is used for demonstrating how to update data and label: TensorBay SDK supports a method to update dataset meta info. -.. literalinclude:: ../../../docs/code/update_dataset.py +.. literalinclude:: ../../../../docs/code/update_dataset.py :language: python :start-after: """Update dataset meta""" :end-before: """""" @@ -36,7 +36,7 @@ TensorBay SDK supports a method to update dataset meta info. TensorBay SDK supports a method to update :ref:`dataset notes `. The dataset can be updated into continuous dataset by setting ``is_continuous`` to ``True``. -.. literalinclude:: ../../../docs/code/update_dataset.py +.. literalinclude:: ../../../../docs/code/update_dataset.py :language: python :start-after: """Update dataset notes""" :end-before: """""" @@ -49,28 +49,28 @@ TensorBay SDK supports methods to update labels to overwrite previous labels. Get a previously uploaded dataset and create a draft: -.. literalinclude:: ../../../docs/code/update_dataset.py +.. literalinclude:: ../../../../docs/code/update_dataset.py :language: python :start-after: """Update label / get dataset an create draft""" :end-before: """""" Update the catalog if needed: -.. literalinclude:: ../../../docs/code/update_dataset.py +.. literalinclude:: ../../../../docs/code/update_dataset.py :language: python :start-after: """Update label / update catalog""" :end-before: """""" Overwrite previous labels with new label on dataset: -.. literalinclude:: ../../../docs/code/update_dataset.py +.. literalinclude:: ../../../../docs/code/update_dataset.py :language: python :start-after: """Update label / overwrite label""" :end-before: """""" Commit the dataset: -.. literalinclude:: ../../../docs/code/update_dataset.py +.. literalinclude:: ../../../../docs/code/update_dataset.py :language: python :start-after: """Update label / commit dataset""" :end-before: """""" @@ -87,7 +87,7 @@ Commit the dataset: Add new data to dataset. -.. literalinclude:: ../../../docs/code/update_dataset.py +.. literalinclude:: ../../../../docs/code/update_dataset.py :language: python :start-after: """Update data/ upload dataset""" :end-before: """""" @@ -96,7 +96,7 @@ Set `skip_uploaded_files=True` to skip uploaded data. Overwrite uploaded data to dataset. -.. literalinclude:: ../../../docs/code/update_dataset.py +.. literalinclude:: ../../../../docs/code/update_dataset.py :language: python :start-after: """Update data/ overwrite dataset""" :end-before: """""" @@ -113,21 +113,21 @@ The default value of `skip_uploaded_files` is false, use it to overwrite uploade Delete segment by the segment name. -.. literalinclude:: ../../../docs/code/update_dataset.py +.. literalinclude:: ../../../../docs/code/update_dataset.py :language: python :start-after: """Update data/ delete segment""" :end-before: """""" Delete data by the data remote path. -.. literalinclude:: ../../../docs/code/update_dataset.py +.. literalinclude:: ../../../../docs/code/update_dataset.py :language: python :start-after: """Update data/ delete data""" :end-before: """""" For a fusion dataset, TensorBay SDK supports deleting a frame by its id. -.. literalinclude:: ../../../docs/code/update_dataset.py +.. literalinclude:: ../../../../docs/code/update_dataset.py :language: python :start-after: """Delete frame""" :end-before: """""" diff --git a/docs/source/api/client/cloud_storage.rst b/docs/source/reference/api/client/cloud_storage.rst similarity index 100% rename from docs/source/api/client/cloud_storage.rst rename to docs/source/reference/api/client/cloud_storage.rst diff --git a/docs/source/api/client/dataset.rst b/docs/source/reference/api/client/dataset.rst similarity index 100% rename from docs/source/api/client/dataset.rst rename to docs/source/reference/api/client/dataset.rst diff --git a/docs/source/api/client/diff.rst b/docs/source/reference/api/client/diff.rst similarity index 100% rename from docs/source/api/client/diff.rst rename to docs/source/reference/api/client/diff.rst diff --git a/docs/source/api/client/gas.rst b/docs/source/reference/api/client/gas.rst similarity index 100% rename from docs/source/api/client/gas.rst rename to docs/source/reference/api/client/gas.rst diff --git a/docs/source/api/client/client_module.rst b/docs/source/reference/api/client/index.rst similarity index 100% rename from docs/source/api/client/client_module.rst rename to docs/source/reference/api/client/index.rst diff --git a/docs/source/api/client/lazy.rst b/docs/source/reference/api/client/lazy.rst similarity index 100% rename from docs/source/api/client/lazy.rst rename to docs/source/reference/api/client/lazy.rst diff --git a/docs/source/api/client/log.rst b/docs/source/reference/api/client/log.rst similarity index 100% rename from docs/source/api/client/log.rst rename to docs/source/reference/api/client/log.rst diff --git a/docs/source/api/client/profile.rst b/docs/source/reference/api/client/profile.rst similarity index 100% rename from docs/source/api/client/profile.rst rename to docs/source/reference/api/client/profile.rst diff --git a/docs/source/api/client/requests.rst b/docs/source/reference/api/client/requests.rst similarity index 100% rename from docs/source/api/client/requests.rst rename to docs/source/reference/api/client/requests.rst diff --git a/docs/source/api/client/segment.rst b/docs/source/reference/api/client/segment.rst similarity index 100% rename from docs/source/api/client/segment.rst rename to docs/source/reference/api/client/segment.rst diff --git a/docs/source/api/client/statistics.rst b/docs/source/reference/api/client/statistics.rst similarity index 100% rename from docs/source/api/client/statistics.rst rename to docs/source/reference/api/client/statistics.rst diff --git a/docs/source/api/client/status.rst b/docs/source/reference/api/client/status.rst similarity index 100% rename from docs/source/api/client/status.rst rename to docs/source/reference/api/client/status.rst diff --git a/docs/source/api/client/struct.rst b/docs/source/reference/api/client/struct.rst similarity index 100% rename from docs/source/api/client/struct.rst rename to docs/source/reference/api/client/struct.rst diff --git a/docs/source/api/client/version.rst b/docs/source/reference/api/client/version.rst similarity index 100% rename from docs/source/api/client/version.rst rename to docs/source/reference/api/client/version.rst diff --git a/docs/source/api/dataset/data.rst b/docs/source/reference/api/dataset/data.rst similarity index 100% rename from docs/source/api/dataset/data.rst rename to docs/source/reference/api/dataset/data.rst diff --git a/docs/source/api/dataset/dataset.rst b/docs/source/reference/api/dataset/dataset.rst similarity index 100% rename from docs/source/api/dataset/dataset.rst rename to docs/source/reference/api/dataset/dataset.rst diff --git a/docs/source/api/dataset/frame.rst b/docs/source/reference/api/dataset/frame.rst similarity index 100% rename from docs/source/api/dataset/frame.rst rename to docs/source/reference/api/dataset/frame.rst diff --git a/docs/source/api/dataset/dataset_module.rst b/docs/source/reference/api/dataset/index.rst similarity index 100% rename from docs/source/api/dataset/dataset_module.rst rename to docs/source/reference/api/dataset/index.rst diff --git a/docs/source/api/dataset/segment.rst b/docs/source/reference/api/dataset/segment.rst similarity index 100% rename from docs/source/api/dataset/segment.rst rename to docs/source/reference/api/dataset/segment.rst diff --git a/docs/source/api/exception.rst b/docs/source/reference/api/exception.rst similarity index 100% rename from docs/source/api/exception.rst rename to docs/source/reference/api/exception.rst diff --git a/docs/source/api/geometry/box.rst b/docs/source/reference/api/geometry/box.rst similarity index 100% rename from docs/source/api/geometry/box.rst rename to docs/source/reference/api/geometry/box.rst diff --git a/docs/source/api/geometry/geometry_module.rst b/docs/source/reference/api/geometry/index.rst similarity index 100% rename from docs/source/api/geometry/geometry_module.rst rename to docs/source/reference/api/geometry/index.rst diff --git a/docs/source/api/geometry/keypoint.rst b/docs/source/reference/api/geometry/keypoint.rst similarity index 100% rename from docs/source/api/geometry/keypoint.rst rename to docs/source/reference/api/geometry/keypoint.rst diff --git a/docs/source/api/geometry/point_list.rst b/docs/source/reference/api/geometry/point_list.rst similarity index 100% rename from docs/source/api/geometry/point_list.rst rename to docs/source/reference/api/geometry/point_list.rst diff --git a/docs/source/api/geometry/polygon.rst b/docs/source/reference/api/geometry/polygon.rst similarity index 100% rename from docs/source/api/geometry/polygon.rst rename to docs/source/reference/api/geometry/polygon.rst diff --git a/docs/source/api/geometry/polyline.rst b/docs/source/reference/api/geometry/polyline.rst similarity index 100% rename from docs/source/api/geometry/polyline.rst rename to docs/source/reference/api/geometry/polyline.rst diff --git a/docs/source/api/geometry/transform.rst b/docs/source/reference/api/geometry/transform.rst similarity index 100% rename from docs/source/api/geometry/transform.rst rename to docs/source/reference/api/geometry/transform.rst diff --git a/docs/source/api/geometry/vector.rst b/docs/source/reference/api/geometry/vector.rst similarity index 100% rename from docs/source/api/geometry/vector.rst rename to docs/source/reference/api/geometry/vector.rst diff --git a/docs/source/api/healthcheck/basic_check.rst b/docs/source/reference/api/healthcheck/basic_check.rst similarity index 100% rename from docs/source/api/healthcheck/basic_check.rst rename to docs/source/reference/api/healthcheck/basic_check.rst diff --git a/docs/source/api/healthcheck/catalog_check.rst b/docs/source/reference/api/healthcheck/catalog_check.rst similarity index 100% rename from docs/source/api/healthcheck/catalog_check.rst rename to docs/source/reference/api/healthcheck/catalog_check.rst diff --git a/docs/source/api/healthcheck/healthcheck.rst b/docs/source/reference/api/healthcheck/healthcheck.rst similarity index 100% rename from docs/source/api/healthcheck/healthcheck.rst rename to docs/source/reference/api/healthcheck/healthcheck.rst diff --git a/docs/source/api/healthcheck/healthcheck_module.rst b/docs/source/reference/api/healthcheck/index.rst similarity index 100% rename from docs/source/api/healthcheck/healthcheck_module.rst rename to docs/source/reference/api/healthcheck/index.rst diff --git a/docs/source/api/healthcheck/pipeline.rst b/docs/source/reference/api/healthcheck/pipeline.rst similarity index 100% rename from docs/source/api/healthcheck/pipeline.rst rename to docs/source/reference/api/healthcheck/pipeline.rst diff --git a/docs/source/api/healthcheck/report.rst b/docs/source/reference/api/healthcheck/report.rst similarity index 100% rename from docs/source/api/healthcheck/report.rst rename to docs/source/reference/api/healthcheck/report.rst diff --git a/docs/source/reference/api/index.rst b/docs/source/reference/api/index.rst new file mode 100644 index 000000000..f9295115a --- /dev/null +++ b/docs/source/reference/api/index.rst @@ -0,0 +1,14 @@ +API Reference +============= + +.. toctree:: + :maxdepth: 2 + + client/index + dataset/index + geometry/index + label/index + sensor/index + utility/index + exception + opendataset/index diff --git a/docs/source/api/label/attributes.rst b/docs/source/reference/api/label/attributes.rst similarity index 100% rename from docs/source/api/label/attributes.rst rename to docs/source/reference/api/label/attributes.rst diff --git a/docs/source/api/label/basic.rst b/docs/source/reference/api/label/basic.rst similarity index 100% rename from docs/source/api/label/basic.rst rename to docs/source/reference/api/label/basic.rst diff --git a/docs/source/api/label/catalog.rst b/docs/source/reference/api/label/catalog.rst similarity index 100% rename from docs/source/api/label/catalog.rst rename to docs/source/reference/api/label/catalog.rst diff --git a/docs/source/api/label/label_module.rst b/docs/source/reference/api/label/index.rst similarity index 100% rename from docs/source/api/label/label_module.rst rename to docs/source/reference/api/label/index.rst diff --git a/docs/source/api/label/label.rst b/docs/source/reference/api/label/label.rst similarity index 100% rename from docs/source/api/label/label.rst rename to docs/source/reference/api/label/label.rst diff --git a/docs/source/api/label/label_box.rst b/docs/source/reference/api/label/label_box.rst similarity index 100% rename from docs/source/api/label/label_box.rst rename to docs/source/reference/api/label/label_box.rst diff --git a/docs/source/api/label/label_classification.rst b/docs/source/reference/api/label/label_classification.rst similarity index 100% rename from docs/source/api/label/label_classification.rst rename to docs/source/reference/api/label/label_classification.rst diff --git a/docs/source/api/label/label_keypoints.rst b/docs/source/reference/api/label/label_keypoints.rst similarity index 100% rename from docs/source/api/label/label_keypoints.rst rename to docs/source/reference/api/label/label_keypoints.rst diff --git a/docs/source/api/label/label_mask.rst b/docs/source/reference/api/label/label_mask.rst similarity index 100% rename from docs/source/api/label/label_mask.rst rename to docs/source/reference/api/label/label_mask.rst diff --git a/docs/source/api/label/label_polygon.rst b/docs/source/reference/api/label/label_polygon.rst similarity index 100% rename from docs/source/api/label/label_polygon.rst rename to docs/source/reference/api/label/label_polygon.rst diff --git a/docs/source/api/label/label_polyline.rst b/docs/source/reference/api/label/label_polyline.rst similarity index 100% rename from docs/source/api/label/label_polyline.rst rename to docs/source/reference/api/label/label_polyline.rst diff --git a/docs/source/api/label/label_sentence.rst b/docs/source/reference/api/label/label_sentence.rst similarity index 100% rename from docs/source/api/label/label_sentence.rst rename to docs/source/reference/api/label/label_sentence.rst diff --git a/docs/source/api/label/supports.rst b/docs/source/reference/api/label/supports.rst similarity index 100% rename from docs/source/api/label/supports.rst rename to docs/source/reference/api/label/supports.rst diff --git a/docs/source/api/opendataset/AADB.rst b/docs/source/reference/api/opendataset/AADB.rst similarity index 100% rename from docs/source/api/opendataset/AADB.rst rename to docs/source/reference/api/opendataset/AADB.rst diff --git a/docs/source/api/opendataset/AnimalPose.rst b/docs/source/reference/api/opendataset/AnimalPose.rst similarity index 100% rename from docs/source/api/opendataset/AnimalPose.rst rename to docs/source/reference/api/opendataset/AnimalPose.rst diff --git a/docs/source/api/opendataset/AnimalsWithAttributes2.rst b/docs/source/reference/api/opendataset/AnimalsWithAttributes2.rst similarity index 100% rename from docs/source/api/opendataset/AnimalsWithAttributes2.rst rename to docs/source/reference/api/opendataset/AnimalsWithAttributes2.rst diff --git a/docs/source/api/opendataset/BDD100K.rst b/docs/source/reference/api/opendataset/BDD100K.rst similarity index 100% rename from docs/source/api/opendataset/BDD100K.rst rename to docs/source/reference/api/opendataset/BDD100K.rst diff --git a/docs/source/api/opendataset/BSTLD.rst b/docs/source/reference/api/opendataset/BSTLD.rst similarity index 100% rename from docs/source/api/opendataset/BSTLD.rst rename to docs/source/reference/api/opendataset/BSTLD.rst diff --git a/docs/source/api/opendataset/BioIDFace.rst b/docs/source/reference/api/opendataset/BioIDFace.rst similarity index 100% rename from docs/source/api/opendataset/BioIDFace.rst rename to docs/source/reference/api/opendataset/BioIDFace.rst diff --git a/docs/source/api/opendataset/CACD.rst b/docs/source/reference/api/opendataset/CACD.rst similarity index 100% rename from docs/source/api/opendataset/CACD.rst rename to docs/source/reference/api/opendataset/CACD.rst diff --git a/docs/source/api/opendataset/CADC.rst b/docs/source/reference/api/opendataset/CADC.rst similarity index 100% rename from docs/source/api/opendataset/CADC.rst rename to docs/source/reference/api/opendataset/CADC.rst diff --git a/docs/source/api/opendataset/CCPD.rst b/docs/source/reference/api/opendataset/CCPD.rst similarity index 100% rename from docs/source/api/opendataset/CCPD.rst rename to docs/source/reference/api/opendataset/CCPD.rst diff --git a/docs/source/api/opendataset/COVIDChestXRay.rst b/docs/source/reference/api/opendataset/COVIDChestXRay.rst similarity index 100% rename from docs/source/api/opendataset/COVIDChestXRay.rst rename to docs/source/reference/api/opendataset/COVIDChestXRay.rst diff --git a/docs/source/api/opendataset/COVID_CT.rst b/docs/source/reference/api/opendataset/COVID_CT.rst similarity index 100% rename from docs/source/api/opendataset/COVID_CT.rst rename to docs/source/reference/api/opendataset/COVID_CT.rst diff --git a/docs/source/api/opendataset/CarConnection.rst b/docs/source/reference/api/opendataset/CarConnection.rst similarity index 100% rename from docs/source/api/opendataset/CarConnection.rst rename to docs/source/reference/api/opendataset/CarConnection.rst diff --git a/docs/source/api/opendataset/CoinImage.rst b/docs/source/reference/api/opendataset/CoinImage.rst similarity index 100% rename from docs/source/api/opendataset/CoinImage.rst rename to docs/source/reference/api/opendataset/CoinImage.rst diff --git a/docs/source/api/opendataset/CompCars.rst b/docs/source/reference/api/opendataset/CompCars.rst similarity index 100% rename from docs/source/api/opendataset/CompCars.rst rename to docs/source/reference/api/opendataset/CompCars.rst diff --git a/docs/source/api/opendataset/DeepRoute.rst b/docs/source/reference/api/opendataset/DeepRoute.rst similarity index 100% rename from docs/source/api/opendataset/DeepRoute.rst rename to docs/source/reference/api/opendataset/DeepRoute.rst diff --git a/docs/source/api/opendataset/DogsVsCats.rst b/docs/source/reference/api/opendataset/DogsVsCats.rst similarity index 100% rename from docs/source/api/opendataset/DogsVsCats.rst rename to docs/source/reference/api/opendataset/DogsVsCats.rst diff --git a/docs/source/api/opendataset/DownsampledImagenet.rst b/docs/source/reference/api/opendataset/DownsampledImagenet.rst similarity index 100% rename from docs/source/api/opendataset/DownsampledImagenet.rst rename to docs/source/reference/api/opendataset/DownsampledImagenet.rst diff --git a/docs/source/api/opendataset/Elpv.rst b/docs/source/reference/api/opendataset/Elpv.rst similarity index 100% rename from docs/source/api/opendataset/Elpv.rst rename to docs/source/reference/api/opendataset/Elpv.rst diff --git a/docs/source/api/opendataset/FLIC.rst b/docs/source/reference/api/opendataset/FLIC.rst similarity index 100% rename from docs/source/api/opendataset/FLIC.rst rename to docs/source/reference/api/opendataset/FLIC.rst diff --git a/docs/source/api/opendataset/FSDD.rst b/docs/source/reference/api/opendataset/FSDD.rst similarity index 100% rename from docs/source/api/opendataset/FSDD.rst rename to docs/source/reference/api/opendataset/FSDD.rst diff --git a/docs/source/api/opendataset/Flower.rst b/docs/source/reference/api/opendataset/Flower.rst similarity index 100% rename from docs/source/api/opendataset/Flower.rst rename to docs/source/reference/api/opendataset/Flower.rst diff --git a/docs/source/api/opendataset/HalpeFullBody.rst b/docs/source/reference/api/opendataset/HalpeFullBody.rst similarity index 100% rename from docs/source/api/opendataset/HalpeFullBody.rst rename to docs/source/reference/api/opendataset/HalpeFullBody.rst diff --git a/docs/source/api/opendataset/HardHatWorkers.rst b/docs/source/reference/api/opendataset/HardHatWorkers.rst similarity index 100% rename from docs/source/api/opendataset/HardHatWorkers.rst rename to docs/source/reference/api/opendataset/HardHatWorkers.rst diff --git a/docs/source/api/opendataset/HeadPoseImage.rst b/docs/source/reference/api/opendataset/HeadPoseImage.rst similarity index 100% rename from docs/source/api/opendataset/HeadPoseImage.rst rename to docs/source/reference/api/opendataset/HeadPoseImage.rst diff --git a/docs/source/api/opendataset/ImageEmotion.rst b/docs/source/reference/api/opendataset/ImageEmotion.rst similarity index 100% rename from docs/source/api/opendataset/ImageEmotion.rst rename to docs/source/reference/api/opendataset/ImageEmotion.rst diff --git a/docs/source/api/opendataset/JHU_CROWD.rst b/docs/source/reference/api/opendataset/JHU_CROWD.rst similarity index 100% rename from docs/source/api/opendataset/JHU_CROWD.rst rename to docs/source/reference/api/opendataset/JHU_CROWD.rst diff --git a/docs/source/api/opendataset/KenyanFood.rst b/docs/source/reference/api/opendataset/KenyanFood.rst similarity index 100% rename from docs/source/api/opendataset/KenyanFood.rst rename to docs/source/reference/api/opendataset/KenyanFood.rst diff --git a/docs/source/api/opendataset/KylbergTexture.rst b/docs/source/reference/api/opendataset/KylbergTexture.rst similarity index 100% rename from docs/source/api/opendataset/KylbergTexture.rst rename to docs/source/reference/api/opendataset/KylbergTexture.rst diff --git a/docs/source/api/opendataset/LISATrafficLight.rst b/docs/source/reference/api/opendataset/LISATrafficLight.rst similarity index 100% rename from docs/source/api/opendataset/LISATrafficLight.rst rename to docs/source/reference/api/opendataset/LISATrafficLight.rst diff --git a/docs/source/api/opendataset/LISATrafficSign.rst b/docs/source/reference/api/opendataset/LISATrafficSign.rst similarity index 100% rename from docs/source/api/opendataset/LISATrafficSign.rst rename to docs/source/reference/api/opendataset/LISATrafficSign.rst diff --git a/docs/source/api/opendataset/LeedsSportsPose.rst b/docs/source/reference/api/opendataset/LeedsSportsPose.rst similarity index 100% rename from docs/source/api/opendataset/LeedsSportsPose.rst rename to docs/source/reference/api/opendataset/LeedsSportsPose.rst diff --git a/docs/source/api/opendataset/NeolixOD.rst b/docs/source/reference/api/opendataset/NeolixOD.rst similarity index 100% rename from docs/source/api/opendataset/NeolixOD.rst rename to docs/source/reference/api/opendataset/NeolixOD.rst diff --git a/docs/source/api/opendataset/Newsgroups20.rst b/docs/source/reference/api/opendataset/Newsgroups20.rst similarity index 100% rename from docs/source/api/opendataset/Newsgroups20.rst rename to docs/source/reference/api/opendataset/Newsgroups20.rst diff --git a/docs/source/api/opendataset/NightOwls.rst b/docs/source/reference/api/opendataset/NightOwls.rst similarity index 100% rename from docs/source/api/opendataset/NightOwls.rst rename to docs/source/reference/api/opendataset/NightOwls.rst diff --git a/docs/source/api/opendataset/RP2K.rst b/docs/source/reference/api/opendataset/RP2K.rst similarity index 100% rename from docs/source/api/opendataset/RP2K.rst rename to docs/source/reference/api/opendataset/RP2K.rst diff --git a/docs/source/api/opendataset/THCHS30.rst b/docs/source/reference/api/opendataset/THCHS30.rst similarity index 100% rename from docs/source/api/opendataset/THCHS30.rst rename to docs/source/reference/api/opendataset/THCHS30.rst diff --git a/docs/source/api/opendataset/THUCNews.rst b/docs/source/reference/api/opendataset/THUCNews.rst similarity index 100% rename from docs/source/api/opendataset/THUCNews.rst rename to docs/source/reference/api/opendataset/THUCNews.rst diff --git a/docs/source/api/opendataset/TLR.rst b/docs/source/reference/api/opendataset/TLR.rst similarity index 100% rename from docs/source/api/opendataset/TLR.rst rename to docs/source/reference/api/opendataset/TLR.rst diff --git a/docs/source/api/opendataset/UAVDT.rst b/docs/source/reference/api/opendataset/UAVDT.rst similarity index 100% rename from docs/source/api/opendataset/UAVDT.rst rename to docs/source/reference/api/opendataset/UAVDT.rst diff --git a/docs/source/api/opendataset/VOC2012ActionClassification.rst b/docs/source/reference/api/opendataset/VOC2012ActionClassification.rst similarity index 100% rename from docs/source/api/opendataset/VOC2012ActionClassification.rst rename to docs/source/reference/api/opendataset/VOC2012ActionClassification.rst diff --git a/docs/source/api/opendataset/VOC2012Detection.rst b/docs/source/reference/api/opendataset/VOC2012Detection.rst similarity index 100% rename from docs/source/api/opendataset/VOC2012Detection.rst rename to docs/source/reference/api/opendataset/VOC2012Detection.rst diff --git a/docs/source/api/opendataset/WIDER_FACE.rst b/docs/source/reference/api/opendataset/WIDER_FACE.rst similarity index 100% rename from docs/source/api/opendataset/WIDER_FACE.rst rename to docs/source/reference/api/opendataset/WIDER_FACE.rst diff --git a/docs/source/api/opendataset/_utility.rst b/docs/source/reference/api/opendataset/_utility.rst similarity index 100% rename from docs/source/api/opendataset/_utility.rst rename to docs/source/reference/api/opendataset/_utility.rst diff --git a/docs/source/api/opendataset/opendataset_module.rst b/docs/source/reference/api/opendataset/index.rst similarity index 100% rename from docs/source/api/opendataset/opendataset_module.rst rename to docs/source/reference/api/opendataset/index.rst diff --git a/docs/source/api/opendataset/nuScenes.rst b/docs/source/reference/api/opendataset/nuScenes.rst similarity index 100% rename from docs/source/api/opendataset/nuScenes.rst rename to docs/source/reference/api/opendataset/nuScenes.rst diff --git a/docs/source/api/sensor/sensor_module.rst b/docs/source/reference/api/sensor/index.rst similarity index 100% rename from docs/source/api/sensor/sensor_module.rst rename to docs/source/reference/api/sensor/index.rst diff --git a/docs/source/api/sensor/intrinsics.rst b/docs/source/reference/api/sensor/intrinsics.rst similarity index 100% rename from docs/source/api/sensor/intrinsics.rst rename to docs/source/reference/api/sensor/intrinsics.rst diff --git a/docs/source/api/sensor/sensor.rst b/docs/source/reference/api/sensor/sensor.rst similarity index 100% rename from docs/source/api/sensor/sensor.rst rename to docs/source/reference/api/sensor/sensor.rst diff --git a/docs/source/api/utility/attr.rst b/docs/source/reference/api/utility/attr.rst similarity index 100% rename from docs/source/api/utility/attr.rst rename to docs/source/reference/api/utility/attr.rst diff --git a/docs/source/api/utility/common.rst b/docs/source/reference/api/utility/common.rst similarity index 100% rename from docs/source/api/utility/common.rst rename to docs/source/reference/api/utility/common.rst diff --git a/docs/source/api/utility/deprecated.rst b/docs/source/reference/api/utility/deprecated.rst similarity index 100% rename from docs/source/api/utility/deprecated.rst rename to docs/source/reference/api/utility/deprecated.rst diff --git a/docs/source/api/utility/file.rst b/docs/source/reference/api/utility/file.rst similarity index 100% rename from docs/source/api/utility/file.rst rename to docs/source/reference/api/utility/file.rst diff --git a/docs/source/api/utility/utility_module.rst b/docs/source/reference/api/utility/index.rst similarity index 100% rename from docs/source/api/utility/utility_module.rst rename to docs/source/reference/api/utility/index.rst diff --git a/docs/source/api/utility/itertools.rst b/docs/source/reference/api/utility/itertools.rst similarity index 100% rename from docs/source/api/utility/itertools.rst rename to docs/source/reference/api/utility/itertools.rst diff --git a/docs/source/api/utility/name.rst b/docs/source/reference/api/utility/name.rst similarity index 100% rename from docs/source/api/utility/name.rst rename to docs/source/reference/api/utility/name.rst diff --git a/docs/source/api/utility/repr.rst b/docs/source/reference/api/utility/repr.rst similarity index 100% rename from docs/source/api/utility/repr.rst rename to docs/source/reference/api/utility/repr.rst diff --git a/docs/source/api/utility/type.rst b/docs/source/reference/api/utility/type.rst similarity index 100% rename from docs/source/api/utility/type.rst rename to docs/source/reference/api/utility/type.rst diff --git a/docs/source/api/utility/user.rst b/docs/source/reference/api/utility/user.rst similarity index 100% rename from docs/source/api/utility/user.rst rename to docs/source/reference/api/utility/user.rst diff --git a/docs/source/reference/api_reference.rst b/docs/source/reference/api_reference.rst deleted file mode 100644 index a35cad485..000000000 --- a/docs/source/reference/api_reference.rst +++ /dev/null @@ -1,14 +0,0 @@ -API Reference -============= - -.. toctree:: - :maxdepth: 2 - - ../api/client/client_module - ../api/dataset/dataset_module - ../api/geometry/geometry_module - ../api/label/label_module - ../api/sensor/sensor_module - ../api/utility/utility_module - ../api/exception - ../api/opendataset/opendataset_module diff --git a/docs/source/reference/dataset_structure.rst b/docs/source/reference/dataset_structure.rst index c97f2561b..eb6528e76 100644 --- a/docs/source/reference/dataset_structure.rst +++ b/docs/source/reference/dataset_structure.rst @@ -48,7 +48,7 @@ The corresponding class of notes is :class:`~tensorbay.dataset.dataset.Notes`. Catalog is used for storing label meta information. It collects all the labels corresponding to a dataset. -There could be one or several subcatalogs (:ref:`reference/label_format:Label Format`) +There could be one or several subcatalogs (:ref:`reference/label_format/index:Label Format`) under one catalog. Each Subcatalog only stores label meta information of one label type, including whether the corresponding annotation has tracking information. diff --git a/docs/source/reference/glossary.rst b/docs/source/reference/glossary.rst index 8f77c1517..ec3925384 100644 --- a/docs/source/reference/glossary.rst +++ b/docs/source/reference/glossary.rst @@ -120,7 +120,7 @@ Here are some dataloader examples of datasets with different label types and con .. _dogs vs cats: https://gas.graviti.cn/dataset/data-decorators/DogsVsCats -See more dataloader examples in :ref:`api/opendataset/opendataset_module:tensorbay.opendataset`. +See more dataloader examples in :ref:`reference/api/opendataset/index:tensorbay.opendataset`. dataset ======= @@ -213,4 +213,4 @@ Tracking is a characteristic to describe the labels within a :ref:`reference/glo The labels of a dataset are tracking means the labels contain tracking information, such as tracking ID, which is used for tracking tasks. Tracking characteristic is stored in :ref:`reference/dataset_structure:catalog`, -please see :ref:`reference/label_format:Label Format` for more details. +please see :ref:`reference/label_format/index:Label Format` for more details. diff --git a/docs/source/reference/label_format.rst b/docs/source/reference/label_format/index.rst similarity index 86% rename from docs/source/reference/label_format.rst rename to docs/source/reference/label_format/index.rst index 92df39c99..02bbb12fc 100644 --- a/docs/source/reference/label_format.rst +++ b/docs/source/reference/label_format/index.rst @@ -5,9 +5,9 @@ TensorBay supports multiple types of labels. Each :class:`~tensorbay.dataset.data.Data` instance -can have multiple types of :class:`label <~tensorbay.label.basic.Label>`. +can have multiple types of :class:`label <~tensorbay.label.label.Label>`. -And each type of :class:`label <~tensorbay.label.basic.Label>` is supported with a specific label +And each type of :class:`label <~tensorbay.label.label.Label>` is supported with a specific label class, and has a corresponding :ref:`subcatalog ` class. @@ -36,19 +36,18 @@ and has a corresponding :ref:`subcatalog ` :hidden: :maxdepth: 1 - ./label_format/CommonLabelProperties - ./label_format/CommonSubcatalogProperties - ./label_format/Classification - ./label_format/Box2D - ./label_format/Box3D - ./label_format/Keypoints2D - ./label_format/Polygon - ./label_format/MultiPolygon - ./label_format/RLE - ./label_format/Polyline2D - ./label_format/MultiPolyline2D - ./label_format/Sentence - ./label_format/SemanticMask - ./label_format/InstanceMask - ./label_format/PanopticMask - + CommonLabelProperties + CommonSubcatalogProperties + Classification + Box2D + Box3D + Keypoints2D + Polygon + MultiPolygon + RLE + Polyline2D + MultiPolyline2D + Sentence + SemanticMask + InstanceMask + PanopticMask diff --git a/docs/source/tensorbay_cli/tbrn.rst b/docs/source/tensorbay_cli/tbrn.rst index 8be7624f0..8ca6e7c67 100644 --- a/docs/source/tensorbay_cli/tbrn.rst +++ b/docs/source/tensorbay_cli/tbrn.rst @@ -49,7 +49,7 @@ For example, the following TBRN means the file "2012_004330.jpg" under "train" s ************************ The version information can also be included in the TBRN -when using :ref:`version control ` feature. +when using :ref:`version control ` feature. | 1. Include revision info: