Skip to content

Commit

Permalink
docs: change "labels" to "label" in "data.py" and add "label.rst"
Browse files Browse the repository at this point in the history
PR Closed: #679
  • Loading branch information
zhen.chen authored and AChenQ committed Jun 8, 2021
1 parent c001957 commit 69b3057
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 3 deletions.
6 changes: 6 additions & 0 deletions docs/source/api/label/label.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
tensorbay.label.label
=====================

.. automodule:: tensorbay.label.label
:members:
:show-inheritance:
1 change: 1 addition & 0 deletions docs/source/api/label/label_module.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ tensorbay.label
attributes
basic
catalog
label
label_box
label_classification
label_keypoints
Expand Down
9 changes: 6 additions & 3 deletions tensorbay/dataset/data.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,8 @@ class DataBase(AttrsMixin, ReprMixin): # pylint: disable=too-few-public-methods
Attributes:
path: The file path.
timestamp: The timestamp for the file.
labels: The :class:`Labels` that contains all the label information of the file.
label: The :class:`~tensorbay.label.label.Label` that contains
all the label information of the file.
"""

Expand Down Expand Up @@ -104,7 +105,8 @@ class Data(DataBase):
Attributes:
path: The file local path.
timestamp: The timestamp for the file.
labels: The :class:`Labels` that contains all the label information of the file.
label: The :class:`~tensorbay.label.label.Label` that contains
all the label information of the file.
target_remote_path: The target remote path of the data.
"""
Expand Down Expand Up @@ -222,7 +224,8 @@ class RemoteData(DataBase):
Attributes:
path: The file remote path.
timestamp: The timestamp for the file.
labels: The :class:`Labels` that contains all the label information of the file.
label: The :class:`~tensorbay.label.label.Label` that contains
all the label information of the file.
"""

Expand Down

0 comments on commit 69b3057

Please sign in to comment.