docs(client): update module docstring for client

tensorbay/client/cloud_storage.py

@@ -3,11 +3,7 @@
 # Copyright 2021 Graviti. Licensed under MIT License.
 #
 
-"""Class CloudClient.
-
-The :class:`CloudClient` defines the initial client to interact between local and cloud platform.
-
-"""
+"""Related classes for the Storage Config."""
 
 from typing import Any, Dict, Iterator, List, Type, TypeVar
 

tensorbay/client/dataset.py

@@ -3,24 +3,7 @@
 # Copyright 2021 Graviti. Licensed under MIT License.
 #
 
-"""Class DatasetClientBase, DatasetClient and FusionDatasetClient.
-
-:class:`DatasetClient` is a remote concept. It contains the information
-needed for determining a unique dataset on TensorBay, and provides a series of methods within
-dataset scope, such as :meth:`DatasetClient.get_segment`, :meth:`DatasetClient.list_segment_names`,
-:meth:`DatasetClient.commit <DatasetClientBase.commit>`, and so on.
-In contrast to the :class:`DatasetClient`,
-:class:`~tensorbay.dataset.dataset.Dataset` is a local concept. It represents a
-dataset created locally. Please refer to
-:class:`~tensorbay.dataset.dataset.Dataset` for more information.
-
-Similar to the :class:`DatasetClient`, the
-:class:`FusionDatasetClient` represents
-the fusion dataset on TensorBay, and its local counterpart is
-:class:`~tensorbay.dataset.dataset.FusionDataset`.
-Please refer to :class:`~tensorbay.dataset.dataset.FusionDataset` for more information.
-
-"""
+"""The remote dataset on TensorBay."""
 
 import logging
 import os

tensorbay/client/diff.py

@@ -3,27 +3,7 @@
 # Copyright 2021 Graviti. Licensed under MIT License.
 #
 
-"""Class about the diff.
-
-:class:`DiffBase` defines the basic structure of a diff.
-
-:class:`NotesDiff` defines the basic structure of a brief diff of notes.
-
-:class:`CatalogDiff` defines the basic structure of a brief diff of catalog.
-
-:class:`FileDiff` defines the basic structure of a brief diff of data file.
-
-:class:`LabelDiff` defines the basic structure of a brief diff of data label.
-
-:class:`SensorDiff` defines the basic structure of a brief diff of sensor.
-
-:class:`DataDiff` defines the basic structure of a brief diff of data.
-
-:class:`SegmentDiff` defines the basic structure of a brief diff of a segment.
-
-:class:`DatasetDiff` defines the basic structure of a brief diff of a dataset.
-
-"""
+"""Related classes for the diff."""
 
 from typing import Any, Dict, Sequence, Tuple, Type, TypeVar, Union, overload
 

tensorbay/client/gas.py

@@ -3,15 +3,7 @@
 # Copyright 2021 Graviti. Licensed under MIT License.
 #
 
-"""Class GAS.
-
-The :class:`GAS` defines the initial client to interact between local and TensorBay.
-It provides some operations on datasets level such as :meth:`GAS.create_dataset`,
-:meth:`GAS.list_dataset_names` and :meth:`GAS.get_dataset`.
-
-AccessKey is required when operating with dataset.
-
-"""
+"""The implementation of the gas."""
 
 import logging
 from typing import Any, Dict, Generator, Optional, Type, Union, overload

tensorbay/client/lazy.py

@@ -3,7 +3,7 @@
 # Copyright 2021 Graviti. Licensed under MIT License.
 #
 
-"""Lazy evaluation related classes."""
+"""Related classes for the lazy evaluation."""
 
 from itertools import repeat, zip_longest
 from typing import (

tensorbay/client/log.py

@@ -3,11 +3,7 @@
 # Copyright 2021 Graviti. Licensed under MIT License.
 #
 
-"""Logging utility functions.
-
-:meth:`Dump_request_and_response <dump_request_and_response>` dumps http request and response.
-
-"""
+"""The implementation of logging utilities."""
 
 import json
 from typing import MutableMapping

tensorbay/client/profile.py

@@ -3,11 +3,7 @@
 # Copyright 2021 Graviti. Licensed under MIT License.
 #
 
-"""Statistical.
-
-:class:`Profile` is a class used to save statistical summary.
-
-"""
+"""Record statistics of the interface that interacts with TensorBay."""
 
 import csv
 import json

tensorbay/client/requests.py

@@ -3,13 +3,7 @@
 # Copyright 2021 Graviti. Licensed under MIT License.
 #
 
-"""Class Client and method multithread_upload.
-
-:class:`Client` can send POST, PUT, and GET requests to the TensorBay Dataset Open API.
-
-:meth:`multithread_upload` creates a multi-thread framework for uploading.
-
-"""
+"""The multi-thread uploading framework and request senders of the TensorBay Dataset Open API."""
 
 import logging
 import os

tensorbay/client/segment.py

@@ -3,25 +3,7 @@
 # Copyright 2021 Graviti. Licensed under MIT License.
 #
 
-"""SegmentClientBase, SegmentClient and FusionSegmentClient.
-
-The :class:`SegmentClient` is a remote concept. It
-contains the information needed for determining a unique segment in a dataset
-on TensorBay, and provides a series of methods within a segment scope,
-such as :meth:`SegmentClient.upload_label`, :meth:`SegmentClient.upload_data`,
-:meth:`SegmentClient.list_data` and so on.
-In contrast to the :class:`SegmentClient`,
-:class:`~tensorbay.dataset.segment.Segment` is a local concept.
-It represents a segment created locally. Please refer to
-:class:`~tensorbay.dataset.segment.Segment` for more information.
-
-Similarly to the :class:`SegmentClient`, the :class:`FusionSegmentClient` represents
-the fusion segment in a fusion dataset on TensorBay, and its local counterpart
-is :class:`~tensorbay.dataset.segment.FusionSegment`.
-Please refer to :class:`~tensorbay.dataset.segment.FusionSegment`
-for more information.
-
-"""
+"""The segment of remote dataset on TensorBay."""
 
 import os
 import time

tensorbay/client/statistics.py

@@ -3,12 +3,8 @@
 # Copyright 2021 Graviti. Licensed under MIT License.
 #
 
-"""Class Statistics.
+"""The basic structure of the label statistics."""
 
-:class:`Statistics` defines the basic structure of the label statistics obtained by
-:meth:`DatasetClientBase.get_label_statistics`.
-
-"""
 from typing import Any, Dict
 
 from tensorbay.utility import UserMapping

tensorbay/client/status.py

@@ -3,7 +3,7 @@
 # Copyright 2021 Graviti. Licensed under MIT License.
 #
 
-"""Class Status."""
+"""The basic concept of the status."""
 
 
 from typing import Any, Dict, Optional

tensorbay/client/struct.py

@@ -3,19 +3,7 @@
 # Copyright 2021 Graviti. Licensed under MIT License.
 #
 
-"""User, Commit, Tag, Branch and Draft classes.
-
-:class:`User` defines the basic concept of a user with an action.
-
-:class:`Commit` defines the structure of a commit.
-
-:class:`Tag` defines the structure of a commit tag.
-
-:class:`Branch` defines the structure of a branch.
-
-:class:`Draft` defines the structure of a draft.
-
-"""
+"""Structures of dataset-scopic actions on the TensorBay."""
 
 from functools import partial
 from typing import Any, Dict, Optional, Tuple, Type, TypeVar

tensorbay/client/version.py

@@ -3,7 +3,7 @@
 # Copyright 2021 Graviti. Licensed under MIT License.
 #
 
-"""TensorBay dataset version control related classes."""
+"""Related methods of the TensorBay version control."""
 
 from typing import Any, Dict, Generator, Optional, Union