docs: disable properties, add them into the attributes list

PR Closed: #373

docs/source/api/client/dataset.rst

@@ -4,4 +4,4 @@ tensorbay.client.dataset
 .. automodule:: tensorbay.client.dataset
    :members:
    :show-inheritance:
-   :exclude-members:
+   :exclude-members: name, dataset_id, status

docs/source/api/client/requests.rst

@@ -4,3 +4,4 @@ tensorbay.client.requests
 .. automodule:: tensorbay.client.requests
    :members:
    :show-inheritance:
+   :exclude-members: is_intern

docs/source/api/client/segment.rst

@@ -4,4 +4,4 @@ tensorbay.client.segment
 .. automodule:: tensorbay.client.segment
    :members:
    :show-inheritance:
-   :exclude-members:
+   :exclude-members: name, status

docs/source/api/dataset/data.rst

@@ -4,3 +4,4 @@ tensorbay.dataset.data
 .. automodule:: tensorbay.dataset.data
    :members:
    :show-inheritance:
+   :exclude-members: target_remote_path

docs/source/api/dataset/dataset.rst

@@ -4,5 +4,5 @@ tensorbay.dataset.dataset
 .. automodule:: tensorbay.dataset.dataset
    :members:
    :show-inheritance:
-   :exclude-members:
+   :exclude-members: catalog, notes
 

docs/source/api/label/supports.rst

@@ -4,3 +4,4 @@ tensorbay.label.supports
 .. automodule:: tensorbay.label.supports
    :members:
    :show-inheritance:
+   :exclude-members: number

docs/source/api/sensor/intrinsics.rst

@@ -4,3 +4,4 @@ tensorbay.sensor.intrinsics
 .. automodule:: tensorbay.sensor.intrinsics
    :members:
    :show-inheritance:
+   :exclude-members: camera_matrix, distortion_coefficients

docs/source/api/utility/name.rst

@@ -4,3 +4,4 @@ tensorbay.utility.name
 .. automodule:: tensorbay.utility.name
    :members:
    :show-inheritance:
+   :exclude-members: name

docs/source/api/utility/tbrn.rst

@@ -4,3 +4,4 @@ tensorbay.utility.tbrn
 .. automodule:: tensorbay.utility.tbrn
    :members:
    :show-inheritance:
+   :exclude-members: dataset_name, segment_name, frame_index, sensor_name, remote_path, type

tensorbay/client/dataset.py

@@ -51,6 +51,11 @@ class DatasetClientBase:  # pylint: disable=too-many-public-methods
         dataset_id: Dataset ID.
         gas_client: The initial client to interact between local and TensorBay.
 
+    Attributes:
+        name: Dataset name.
+        dataset_id: Dataset ID.
+        status: The status of the dataset client.
+
     """
 
     _client: Client

tensorbay/client/requests.py

@@ -48,7 +48,12 @@
 
 
 class Config:  # pylint: disable=too-few-public-methods
-    """This is a base class defining the concept of Request Config."""
+    """This is a base class defining the concept of Request Config.
+
+    Attributes:
+         is_intern: Whether the request is from intern.
+
+    """
 
     def __init__(self) -> None:
 

tensorbay/client/segment.py

@@ -61,6 +61,10 @@ class SegmentClientBase:  # pylint: disable=too-many-instance-attributes
         name: Segment name.
         dataset_client: The dataset client.
 
+    Attributes:
+        name: Segment name.
+        status: The status of the dataset client.
+
     """
 
     _EXPIRED_IN_SECOND = 240

tensorbay/dataset/data.py

@@ -117,6 +117,7 @@ class Data(DataBase):
         path: The file local path.
         timestamp: The timestamp for the file.
         labels: The :class:`Labels` that contains all the label information of the file.
+        target_remote_path: The target remote path of the data.
 
     """
 

tensorbay/dataset/dataset.py

@@ -93,6 +93,10 @@ class DatasetBase(NameMixin, Sequence[_T]):  # pylint: disable=too-many-ancestor
     Arguments:
         name: The name of the dataset.
 
+    Attributes:
+        catalog: The :class:`~tensorbay.label.catalog.Catalog` of the dataset.
+        notes: The :class:`Notes` of the dataset.
+
     """
 
     _repr_type = ReprType.SEQUENCE

tensorbay/label/supports.py

@@ -105,6 +105,7 @@ class KeypointsInfo(ReprMixin, EqMixin):
         description: The description of the keypoints.
 
     Attributes:
+        number: The number of the set of keypoints.
         names: All the names of the keypoints.
         skeleton: The skeleton of the keypoints
             indicating which keypoint should connect with another.

tensorbay/sensor/intrinsics.py

@@ -493,9 +493,9 @@ class CameraIntrinsics(ReprMixin):
         **kwargs: Float values to initialize :class:`DistortionCoefficients`.
 
     Attributes:
-        _camera_matrix: A 3x3 Sequence of the camera matrix.
-        _distortion_coefficients: It is the deviation from rectilinear projection. It includes
-            radial distortion and tangential distortion.
+        camera_matrix: A 3x3 Sequence of the camera matrix.
+        distortion_coefficients: It is the deviation from rectilinear projection. It includes
+        radial distortion and tangential distortion.
 
     Examples:
         >>> matrix = [[1, 3, 3],

tensorbay/utility/name.py

@@ -35,6 +35,9 @@ class NameMixin(ReprMixin, EqMixin):
         name: Name of the class.
         description: Description of the class.
 
+    Attributes:
+        name: Name of the class.
+
     """
 
     _P = TypeVar("_P", bound="NameMixin")

tensorbay/utility/tbrn.py

@@ -142,6 +142,14 @@ class TBRN:
         remote_path: Object path of the file.
         tbrn: Full TBRN string.
 
+    Attributes:
+        dataset_name: Name of the dataset.
+        segment_name: Name of the segment.
+        frame_index: Index of the frame.
+        sensor_name: Name of the sensor.
+        remote_path: Object path of the file.
+        type: The type of this TBRN.
+
     Raises:
         TypeError: The TBRN is invalid.