Skip to content

Commit

Permalink
docs: sort the entries of glossay in alphabetic order
Browse files Browse the repository at this point in the history
  • Loading branch information
machearn committed Jun 3, 2021
1 parent 5afeec1 commit 155bf8b
Showing 1 changed file with 74 additions and 78 deletions.
152 changes: 74 additions & 78 deletions docs/source/reference/glossary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,30 +16,33 @@ For the usage of accesskey via Tensorbay SDK or CLI,
please see :ref:`SDK authorization <quick_start/getting_started_with_tensorbay:Authorize a Client Instance>`
or :ref:`CLI configration <tensorbay_cli/getting_started_with_cli:Configuration>`.

dataset
=======
branch
======

A uniform dataset format defined by TensorBay,
which only contains one type of data collected from one sensor or without sensor information.
According to the time continuity of data inside the dataset, a dataset can be a discontinuous dataset or a continuous dataset.
:ref:`Notes <reference/dataset_structure:notes>` can be used to specify whether a dataset is continuous.
Similar to git, a branch is a lightweight pointer to one of the commits.

The corresponding class of dataset is :class:`~tensorbay.dataset.dataset.Dataset`.
Currently, TensorBay only supports a single branch, which is the default "main" branch.

See :ref:`reference/dataset_structure:Dataset Structure` for more details.
Every time a :ref:`reference/glossary:commit` is submitted,
the main branch pointer moves forward automatically to the latest commit.

fusion dataset
==============
commit
======

A uniform dataset format defined by Tensorbay,
which contains data collected from multiple sensors.
Similar with Git, a commit is a version of a dataset,
which contains the changes compared with the former commit.

According to the time continuity of data inside the dataset, a fusion dataset can be a discontinuous fusion dataset or a continuous fusion dataset.
:ref:`Notes <reference/dataset_structure:notes>` can be used to specify whether a fusion dataset is continuous.
Each commit has a unique commit ID, which is a uuid in a 36-byte hexadecimal string.
A certain commit of a dataset can be accessed by passing the corresponding commit ID
or other forms of :ref:`reference/glossary:revision`.

The corresponding class of fusion dataset is :class:`~tensorbay.dataset.dataset.FusionDataset`.
A commit is readable, but is not writable.
Thus, only read operations such as getting catalog, files and labels are allowed.
To change a dataset, please create a new commit.
See :ref:`reference/glossary:draft` for details.

See :ref:`advanced_features/fusion_dataset/fusion_dataset_structure:Fusion Dataset Structure` for more details.
On the other hand,
"commit" also represents the action to save the changes inside a :ref:`reference/glossary:draft` into a commit.

continuity
==========
Expand All @@ -53,16 +56,6 @@ The continuity can be set in :ref:`reference/dataset_structure:notes`.

Only continuous datasets can have :ref:`reference/glossary:tracking` labels.

tracking
========

Tracking is a characteristic to describe the labels within a :ref:`reference/glossary:dataset` or a :ref:`reference/glossary:fusion dataset`.

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.

dataloader
==========

Expand Down Expand Up @@ -120,90 +113,93 @@ Here are some dataloader examples of datasets with different label types and con

See more dataloader examples in :ref:`api/opendataset/opendataset_module:tensorbay.opendataset`.

TBRN
====
dataset
=======

TBRN is the abbreviation for TensorBay Resource Name, which represents the data or a collection of data stored in TensorBay uniquely.
A uniform dataset format defined by TensorBay,
which only contains one type of data collected from one sensor or without sensor information.
According to the time continuity of data inside the dataset, a dataset can be a discontinuous dataset or a continuous dataset.
:ref:`Notes <reference/dataset_structure:notes>` can be used to specify whether a dataset is continuous.

Note that TBRN is only used in :ref:`CLI<tensorbay_cli/getting_started_with_cli:Getting Started with CLI>`.
The corresponding class of dataset is :class:`~tensorbay.dataset.dataset.Dataset`.

TBRN begins with ``tb:``, followed by the dataset name, the segment name and the file name.
See :ref:`reference/dataset_structure:Dataset Structure` for more details.

The following is the general format for TBRN:
draft
=====

.. code::
Similar with Git, a draft is a workspace in which changing the dataset is allowed.

tb:[dataset_name]:[segment_name]://[remote_path]
A draft is created based on a :ref:`reference/glossary:commit`,
and the changes inside it will be made into a commit.

Suppose there is an image ``000000.jpg`` under the default segment of a dataset named ``example``,
then the TBRN of this image should be:
There are scenarios when modifications of a dataset are required,
such as correcting errors, enlarging dataset, adding more types of labels, etc.
Under these circumstances, create a draft, edit the dataset and commit the draft.

.. code::
fusion dataset
==============

tb:example:://000000.jpg
A uniform dataset format defined by Tensorbay,
which contains data collected from multiple sensors.

.. note::
According to the time continuity of data inside the dataset, a fusion dataset can be a discontinuous fusion dataset or a continuous fusion dataset.
:ref:`Notes <reference/dataset_structure:notes>` can be used to specify whether a fusion dataset is continuous.

Default segment is defined as ``""`` (empty string).
The corresponding class of fusion dataset is :class:`~tensorbay.dataset.dataset.FusionDataset`.

See :ref:`advanced_features/fusion_dataset/fusion_dataset_structure:Fusion Dataset Structure` for more details.

commit
======
revision
========

Similar with Git, a commit is a version of a dataset,
which contains the changes compared with the former commit.
Similar to Git, a revision is a reference to a single :ref:`reference/glossary:commit`.
And many methods in TensorBay SDK take revision as an argument.

Each commit has a unique commit ID, which is a uuid in a 36-byte hexadecimal string.
A certain commit of a dataset can be accessed by passing the corresponding commit ID
or other forms of :ref:`reference/glossary:revision`.
Currently, a revision can be in the following forms:

A commit is readable, but is not writable.
Thus, only read operations such as getting catalog, files and labels are allowed.
To change a dataset, please create a new commit.
See :ref:`reference/glossary:draft` for details.
1. A full :ref:`reference/glossary:commit` ID.
2. A :ref:`reference/glossary:tag`.
3. A :ref:`reference/glossary:branch`.

On the other hand,
"commit" also represents the action to save the changes inside a :ref:`reference/glossary:draft` into a commit.
tag
===

draft
=====
TensorBay SDK has the ability to tag the specific :ref:`reference/glossary:commit` in a dataset's history
as being important. Typically, people use this functionality to mark release points (v1.0, v2.0 and so on).

Similar with Git, a draft is a workspace in which changing the dataset is allowed.
TBRN
====

A draft is created based on a :ref:`reference/glossary:commit`,
and the changes inside it will be made into a commit.
TBRN is the abbreviation for TensorBay Resource Name, which represents the data or a collection of data stored in TensorBay uniquely.

There are scenarios when modifications of a dataset are required,
such as correcting errors, enlarging dataset, adding more types of labels, etc.
Under these circumstances, create a draft, edit the dataset and commit the draft.
Note that TBRN is only used in :ref:`CLI<tensorbay_cli/getting_started_with_cli:Getting Started with CLI>`.

TBRN begins with ``tb:``, followed by the dataset name, the segment name and the file name.

tag
===
The following is the general format for TBRN:

TensorBay SDK has the ability to tag the specific :ref:`reference/glossary:commit` in a dataset's history
as being important. Typically, people use this functionality to mark release points (v1.0, v2.0 and so on).
.. code::
tb:[dataset_name]:[segment_name]://[remote_path]
branch
======
Suppose there is an image ``000000.jpg`` under the default segment of a dataset named ``example``,
then the TBRN of this image should be:

Similar to git, a branch is a lightweight pointer to one of the commits.
.. code::
Currently, TensorBay only supports a single branch, which is the default "main" branch.
tb:example:://000000.jpg
Every time a :ref:`reference/glossary:commit` is submitted,
the main branch pointer moves forward automatically to the latest commit.
.. note::

Default segment is defined as ``""`` (empty string).

revision
tracking
========

Similar to Git, a revision is a reference to a single :ref:`reference/glossary:commit`.
And many methods in TensorBay SDK take revision as an argument.
Tracking is a characteristic to describe the labels within a :ref:`reference/glossary:dataset` or a :ref:`reference/glossary:fusion dataset`.

Currently, a revision can be in the following forms:
The labels of a dataset are tracking means the labels contain tracking information, such as tracking ID, which is used for tracking tasks.

1. A full :ref:`reference/glossary:commit` ID.
2. A :ref:`reference/glossary:tag`.
3. A :ref:`reference/glossary:branch`.
Tracking characteristic is stored in :ref:`reference/dataset_structure:catalog`,
please see :ref:`reference/label_format:Label Format` for more details.

0 comments on commit 155bf8b

Please sign in to comment.