Skip to content

Commit

Permalink
docs: use ":doc:" instead of ":ref:" for specified document link
Browse files Browse the repository at this point in the history
PR Closed: #1159
  • Loading branch information
wangyuqing0424 committed Dec 21, 2021

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
1 parent 323eadb commit 27f0aa4
Showing 22 changed files with 129 additions and 129 deletions.
16 changes: 8 additions & 8 deletions docs/source/advanced_features/fusion_dataset/CADC.rst
Original file line number Diff line number Diff line change
@@ -5,7 +5,7 @@
This topic describes how to manage the "CADC" dataset.

"CADC" is a fusion dataset with 8 :ref:`sensors<advanced_features/fusion_dataset/fusion_dataset_structure:sensor>` including 7 :class:`cameras<tensorbay.sensor.sensor.Camera>` and 1 :class:`lidar<tensorbay.sensor.sensor.Lidar>`
, and has :ref:`reference/label_format/Box3D:Box3D` type of labels on the point cloud data.
, and has :doc:`/reference/label_format/Box3D` type of labels on the point cloud data.
(:numref:`Fig. %s <example-cadc>`).
See `this page <https://gas.graviti.cn/dataset/hello-dataset/CADC>`_ for more details about this dataset.

@@ -68,7 +68,7 @@ Write the Catalog
The first step is to write the :ref:`reference/dataset_structure:Catalog`.
Catalog is a json file contains all label information of one dataset.
See :ref:`this page <reference/dataset_structure:Catalog>` for more details.
The only annotation type for "CADC" is :ref:`reference/label_format/Box3D:Box3D`, and there are 10
The only annotation type for "CADC" is :doc:`/reference/label_format/Box3D`, and there are 10
:ref:`reference/label_format/CommonLabelProperties:Category` types and 9 :ref:`reference/label_format/CommonLabelProperties:Attributes` types.

.. literalinclude:: ../../../../tensorbay/opendataset/CADC/catalog.json
@@ -153,8 +153,8 @@ After adding the sensors to the fusion segments, the frames should be added into
Each frame contains the data corresponding to each sensor, and each data should be added to the frame under the key of sensor name(L147).

In fusion datasets, it is common that not all data have labels.
In "CADC", only point cloud files(Lidar data) have :ref:`reference/label_format/Box3D:Box3D` type of labels(L145).
See :ref:`this page <reference/label_format/Box3D:Box3D>` for more details about Box3D annotation details.
In "CADC", only point cloud files(Lidar data) have :doc:`/reference/label_format/Box3D` type of labels(L145).
See :doc:`this page </reference/label_format/Box3D>` for more details about Box3D annotation details.

.. note::
The :ref:`CADC dataloader <cadc-dataloader>` above uses relative import(L16-L19).
@@ -167,7 +167,7 @@ See :ref:`this page <reference/label_format/Box3D:Box3D>` for more details about

Optionally, the organized dataset can be visualized by **Pharos**, which is a TensorBay SDK plug-in.
This step can help users to check whether the dataset is correctly organized.
Please see :ref:`features/visualization:Visualization` for more details.
Please see :doc:`/features/visualization` for more details.

***********************
Upload Fusion Dataset
@@ -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 <features/version_control/index:Version Control>` for more details about version control.
Please see :doc:`this page </features/version_control/index>` for more details about version control.

.. note::

@@ -257,7 +257,7 @@ You can get each data by the corresponding sensor name.

In "CADC", only :ref:`data<advanced_features/fusion_dataset/fusion_dataset_structure:data in fusion dataset>`
under :class:`~tensorbay.sensor.sensor.Lidar`
has a sequence of :ref:`reference/label_format/Box3D:Box3D` annotations.
has a sequence of :doc:`/reference/label_format/Box3D` annotations.
You can get one by index.

.. literalinclude:: ../../../../docs/code/CADC.py
@@ -271,7 +271,7 @@ one of the category names in "categories" list of :ref:`catalog.json <cadc-catal
The information stored in :ref:`reference/label_format/CommonLabelProperties:Attributes`
is some of the attributes in "attributes" list of :ref:`catalog.json <cadc-catalog>`.

See :ref:`this page <reference/label_format/Box3D:Box3D>` for more details about the structure of Box3D.
See :doc:`this page </reference/label_format/Box3D>` for more details about the structure of Box3D.

***********************
Delete Fusion Dataset
2 changes: 1 addition & 1 deletion docs/source/advanced_features/request_configuration.rst
Original file line number Diff line number Diff line change
@@ -31,7 +31,7 @@ Note that the default settings can satisfy most use cases.
is_internal | Whether the request is from internal or not.
| Scenario: Set it to True for quicker network speed when datasets
| and cloud servers are in the same region.
| See :ref:`advanced_features/use_internal_endpoint:Use Internal Endpoint` for details.
| See :doc:`/advanced_features/use_internal_endpoint` for details.
| Default: False
===================== ======================================================================================

10 changes: 5 additions & 5 deletions docs/source/features/dataset_management.rst
Original file line number Diff line number Diff line change
@@ -18,7 +18,7 @@ This topic describes dataset management, including:
******************

TensorBay SDK supports methods to organize local datasets
into uniform TensorBay :ref:`dataset structure <reference/dataset_structure:Dataset Structure>`.
into uniform TensorBay :doc:`dataset structure </reference/dataset_structure>`.
The typical steps to organize a local dataset:

- First, write a catalog (:ref:`ref <reference/dataset_structure:Catalog>`)
@@ -91,7 +91,7 @@ Take the :ref:`Read Dataset of BSTLD <quick_start/examples/bstld:Read Dataset>`
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<quick_start/examples/update_dataset:Update Dataset>` example for more details.
Please see :doc:`Update dataset</quick_start/examples/update_dataset>` example for more details.

***************
Move and Copy
@@ -112,20 +112,20 @@ 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<quick_start/examples/move_and_copy:Move And Copy>` example for more details.
Please see :doc:`Move and copy</quick_start/examples/move_and_copy>` example for more details.

****************
Merge Datasets
****************

Since TensorBay supports copy operation between different datasets, users can use it to merge datasets.

Please see :ref:`quick_start/examples/merge_datasets:Merge Datasets` example for more details.
Please see :doc:`/quick_start/examples/merge_datasets` example for more details.

**********************
Get Label Statistics
**********************

TensorBay supports getting label statistics of dataset.

Please see :ref:`quick_start/examples/get_label_statistics:Get Label Statistics` example for more details.
Please see :doc:`/quick_start/examples/get_label_statistics` example for more details.
2 changes: 1 addition & 1 deletion docs/source/features/version_control/diff.rst
Original file line number Diff line number Diff line change
@@ -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:`features/version_control/draft_and_commit:Draft and Commit`
See more details in :doc:`/features/version_control/draft_and_commit`

**********
Get Diff
Original file line number Diff line number Diff line change
@@ -53,7 +53,7 @@ The code below checkouts to the second commit and check the data amount.
As shown above, there are 8 data in the train segment.

See :ref:`features/version_control/draft_and_commit:Draft and Commit` for more details about commit.
See :doc:`/features/version_control/draft_and_commit` for more details about commit.

Draft
=====
@@ -103,7 +103,7 @@ adds a new segment to the "VersionControlDemo" dataset and does the commit opera
dataset_client.upload_segment(test_segment, jobs=8)
dataset_client.commit("add test segment")
See :ref:`features/version_control/draft_and_commit:Draft and Commit` for more details about draft.
See :doc:`/features/version_control/draft_and_commit` for more details about draft.

Tag
===
@@ -118,7 +118,7 @@ The tag "v1.0.0" in :numref:`Fig. %s <commit-demonstration>` is added by
dataset_client.create_tag("v1.0.0", revision=SECOND_COMMIT_ID)
See :ref:`features/version_control/tag:Tag` for more details about tag.
See :doc:`/features/version_control/tag` for more details about tag.

Branch
======
@@ -133,7 +133,7 @@ For the convenience of maintaining a commit tree, TensorBay provides the :ref:`r
Actually, the commit list (:numref:`Fig. %s <commit-demonstration>`) above is the default branch named "main".

The code block below creates a branch "with-label" based on the :ref:`reference/glossary:revision` "v1.0.0",
and adds :ref:`classification <reference/label_format/Classification:Classification>` label to the "train" segment.
and adds :doc:`classification </reference/label_format/Classification>` label to the "train" segment.

:numref:`Figure. %s <branch-demonstration>` demonstrates the two branches.

@@ -172,4 +172,4 @@ and adds :ref:`classification <reference/label_format/Classification:Classificat
dataset_client.commit("add labels to train segment")
See :ref:`features/version_control/branch:Branch` for more details about branch.
See :doc:`/features/version_control/branch` for more details about branch.
2 changes: 1 addition & 1 deletion docs/source/features/version_control/squash_and_merge.rst
Original file line number Diff line number Diff line change
@@ -5,7 +5,7 @@
TensorBay supports squashing and merging between different branches.

Before :func:`~tensorbay.client.version.VersionControlMixin.squash_and_merge`, a dataset client instance with commits on different branches is needed.
See more details in :ref:`features/version_control/draft_and_commit:Draft and Commit`.
See more details in :doc:`/features/version_control/draft_and_commit`.

.. figure:: /images/squash_and_merge.png
:scale: 40 %
10 changes: 5 additions & 5 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -7,8 +7,8 @@ complex data version management, online data visualization, and data collaborati
TensorBay's unified authority management makes your data sharing and collaborative use more secure.

This documentation describes
:ref:`SDK <quick_start/getting_started_with_tensorbay:Getting Started with TensorBay>` and
:ref:`CLI <tensorbay_cli/getting_started_with_CLI:Getting Started with CLI>` tools for using TensorBay.
:doc:`SDK </quick_start/getting_started_with_tensorbay>` and
:doc:`CLI </tensorbay_cli/getting_started_with_cli>` tools for using TensorBay.

.. _TensorBay: https://www.graviti.cn/

@@ -20,11 +20,11 @@ This documentation describes
TensorBay Python SDK is a python library to access TensorBay and manage your datasets.
It provides:

- A :ref:`pythonic way <quick_start/getting_started_with_tensorbay:Getting Started with TensorBay>`
- A :doc:`pythonic way </quick_start/getting_started_with_tensorbay>`
to access TensorBay resources by TensorBay `OpenAPI`_.
- An easy-to-use CLI tool :ref:`gas <tensorbay_cli/getting_started_with_CLI:Getting Started with CLI>`
- An easy-to-use CLI tool :doc:`gas </tensorbay_cli/getting_started_with_cli>`
(Graviti AI service) to communicate with TensorBay.
- A consistent :ref:`dataset structure <reference/dataset_structure:Dataset Structure>`
- A consistent :doc:`dataset structure </reference/dataset_structure>`
to read and write datasets.

.. _OpenAPI: https://docs.graviti.cn/dev-doc/tools/api-center
14 changes: 7 additions & 7 deletions docs/source/quick_start/examples/BSTLD.rst
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
########

This topic describes how to manage the `BSTLD Dataset <https://gas.graviti.cn/dataset/data-decorators/BSTLD>`_,
which is a dataset with :ref:`reference/label_format/Box2D:Box2D` label(:numref:`Fig. %s <example-bstld>`).
which is a dataset with :doc:`/reference/label_format/Box2D` label(:numref:`Fig. %s <example-bstld>`).

.. _example-bstld:

@@ -55,7 +55,7 @@ is typically stored in a json file like ``catalog.json``.
:name: BSTLD-catalog
:linenos:

The only annotation type for "BSTLD" is :ref:`reference/label_format/Box2D:Box2D`, and there are 13
The only annotation type for "BSTLD" is :doc:`/reference/label_format/Box2D`, and there are 13
:ref:`reference/label_format/CommonLabelProperties:category` types and one :ref:`reference/label_format/CommonLabelProperties:attributes` type.

.. note::
@@ -76,7 +76,7 @@ A :ref:`reference/glossary:dataloader` is needed to organize the dataset into a
:name: BSTLD-dataloader
:linenos:

See :ref:`Box2D annotation <reference/label_format/Box2D:Box2D>` for more details.
See :doc:`Box2D annotation </reference/label_format/Box2D>` for more details.

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.
@@ -100,7 +100,7 @@ Thus, instead of writing, importing an available dataloader is also feasible.

Optionally, the organized dataset can be visualized by **Pharos**, which is a TensorBay SDK plug-in.
This step can help users to check whether the dataset is correctly organized.
Please see :ref:`features/visualization:Visualization` for more details.
Please see :doc:`/features/visualization` for more details.

****************
Upload Dataset
@@ -119,7 +119,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/index:Version Control` for more details.
Please see :doc:`/features/version_control/index` for more details.

**************
Read Dataset
@@ -158,7 +158,7 @@ which can be obtained by index.
:end-before: """"""

In each :ref:`reference/dataset_structure:data`,
there is a sequence of :ref:`reference/label_format/Box2D:Box2D` annotations,
there is a sequence of :doc:`/reference/label_format/Box2D` annotations,
which can be obtained by index.

.. literalinclude:: ../../../../docs/code/BSTLD.py
@@ -170,7 +170,7 @@ There is only one label type in "BSTLD" dataset, which is ``box2d``.
The information stored in :ref:`reference/label_format/CommonLabelProperties:category` is
one of the names in "categories" list of :ref:`catalog.json <BSTLD-catalog>`. The information stored
in :ref:`reference/label_format/CommonLabelProperties:attributes` is one or several of the attributes in "attributes" list of :ref:`catalog.json <BSTLD-catalog>`.
See :ref:`reference/label_format/Box2D:Box2D` label format for more details.
See :doc:`/reference/label_format/Box2D` label format for more details.

****************
Delete Dataset
14 changes: 7 additions & 7 deletions docs/source/quick_start/examples/DogsVsCats.rst
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
##############

This topic describes how to manage the `Dogs vs Cats Dataset <https://gas.graviti.cn/dataset/data-decorators/DogsVsCats>`_,
which is a dataset with :ref:`reference/label_format/Classification:Classification` label.
which is a dataset with :doc:`/reference/label_format/Classification` label.

*****************************
Authorize a Client Instance
@@ -47,7 +47,7 @@ is typically stored in a json file like ``catalog.json``.
:name: dogsvscats-catalog
:linenos:

The only annotation type for "Dogs vs Cats" is :ref:`reference/label_format/Classification:Classification`, and there are 2
The only annotation type for "Dogs vs Cats" is :doc:`/reference/label_format/Classification`, and there are 2
:ref:`reference/label_format/CommonLabelProperties:category` types.

.. note::
@@ -69,7 +69,7 @@ a :class:`~tensorbay.dataset.dataset.Dataset` instance.
:name: dogsvscats-dataloader
:linenos:

See :ref:`Classification annotation <reference/label_format/Classification:Classification>` for more details.
See :doc:`Classification annotation </reference/label_format/Classification>` for more details.


There are already a number of dataloaders in TensorBay SDK provided by the community.
@@ -94,7 +94,7 @@ Thus, instead of writing, importing an available dataloadert is also feasible.

Optionally, the organized dataset can be visualized by **Pharos**, which is a TensorBay SDK plug-in.
This step can help users to check whether the dataset is correctly organized.
Please see :ref:`features/visualization:Visualization` for more details.
Please see :doc:`/features/visualization` for more details.

****************
Upload Dataset
@@ -109,7 +109,7 @@ The organized "Dogs vs Cats" dataset can be uploaded to TensorBay for sharing, r

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/index:Version Control` for more details.
Please see :doc:`/features/version_control/index` for more details.

**************
Read Dataset
@@ -147,7 +147,7 @@ which can be obtained by index.
:end-before: """"""

In each :ref:`reference/dataset_structure:data`,
there is a sequence of :ref:`reference/label_format/Classification:Classification` annotations,
there is a sequence of :doc:`/reference/label_format/Classification` annotations,
which can be obtained by index.

.. literalinclude:: ../../../../docs/code/DogsVsCats.py
@@ -157,7 +157,7 @@ which can be obtained by index.

There is only one label type in "Dogs vs Cats" dataset, which is ``classification``. The information stored in :ref:`reference/label_format/CommonLabelProperties:category` is
one of the names in "categories" list of :ref:`catalog.json <dogsvscats-catalog>`.
See :ref:`reference/label_format/Classification:Classification` label format for more details.
See :doc:`/reference/label_format/Classification` label format for more details.

****************
Delete Dataset
Loading

0 comments on commit 27f0aa4

Please sign in to comment.