Skip to content

Commit

Permalink
docs: rewrite the docstrings of dataloaders about dataset link
Browse files Browse the repository at this point in the history
PR Closed: #1089
  • Loading branch information
watsonvv committed Nov 5, 2021
1 parent 7d1fa11 commit d537690
Show file tree
Hide file tree
Showing 56 changed files with 73 additions and 190 deletions.
2 changes: 1 addition & 1 deletion tensorbay/opendataset/AADB/loader.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@


def AADB(path: str) -> Dataset:
"""Load the AADB to TensorBay.
"""`AADB <https://www.ics.uci.edu/~skong2/aesthetics.html>`_ dataset.
The file structure looks like:
Expand Down
8 changes: 2 additions & 6 deletions tensorbay/opendataset/AnimalPose/loader.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,7 @@


def AnimalPose5(path: str) -> Dataset:
"""Dataloader of the `5 Categories Animal-Pose`_ dataset.
.. _5 Categories Animal-Pose: https://sites.google.com/view/animal-pose/
"""`5 Categories Animal-Pose <https://sites.google.com/view/animal-pose/>`_ dataset.
The file structure should be like::
Expand Down Expand Up @@ -187,9 +185,7 @@ def _get_data_part2(root_path: str, aniamls: Iterable[str]) -> Iterator[Data]:


def AnimalPose7(path: str) -> Dataset:
"""Dataloader of `7 Categories Animal-Pose`_ dataset.
.. _7 Categories Animal-Pose: https://sites.google.com/view/animal-pose/
"""`7 Categories Animal-Pose <https://sites.google.com/view/animal-pose/>`_ dataset.
The file structure should be like::
Expand Down
4 changes: 1 addition & 3 deletions tensorbay/opendataset/AnimalsWithAttributes2/loader.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,7 @@


def AnimalsWithAttributes2(path: str) -> Dataset:
"""Dataloader of the `Animals with attributes 2`_ dataset.
.. _Animals with attributes 2: https://cvml.ist.ac.at/AwA2/
"""`Animals with attributes 2 <https://cvml.ist.ac.at/AwA2/>`_ dataset.
The file structure should be like::
Expand Down
8 changes: 2 additions & 6 deletions tensorbay/opendataset/BDD100K/loader.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,7 @@


def BDD100K(path: str) -> Dataset:
"""Dataloader of the `BDD100K`_ dataset.
.. _bdd100k: https://bdd-data.berkeley.edu
"""`BDD100K <https://bdd-data.berkeley.edu>`_ dataset.
The file structure should be like::
Expand Down Expand Up @@ -85,9 +83,7 @@ def BDD100K(path: str) -> Dataset:


def BDD100K_10K(path: str) -> Dataset:
"""Dataloader of the `BDD100K_10K`_ dataset.
.. _bdd100k_10k: https://bdd-data.berkeley.edu
"""`BDD100K_10K <https://bdd-data.berkeley.edu>`_ dataset.
The file structure should be like::
Expand Down
8 changes: 2 additions & 6 deletions tensorbay/opendataset/BDD100K_MOT2020/loader.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,7 @@


def BDD100K_MOTS2020(path: str) -> Dataset:
"""Dataloader of the `BDD100K_MOTS2020`_ dataset.
.. _bdd100k_mots2020: https://bdd-data.berkeley.edu
"""`BDD100K_MOTS2020 <https://bdd-data.berkeley.edu>`_ dataset.
The file structure should be like::
Expand Down Expand Up @@ -91,9 +89,7 @@ def BDD100K_MOTS2020(path: str) -> Dataset:


def BDD100K_MOT2020(path: str) -> Dataset:
"""Dataloader of the `BDD100K_MOT2020`_ dataset.
.. _bdd100k_mot2020: https://bdd-data.berkeley.edu
"""`BDD100K_MOT2020 <https://bdd-data.berkeley.edu>`_ dataset.
The file structure should be like::
Expand Down
5 changes: 2 additions & 3 deletions tensorbay/opendataset/BSTLD/loader.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,8 @@


def BSTLD(path: str) -> Dataset:
"""Dataloader of the `BSTLD`_ dataset.
.. _BSTLD: https://hci.iwr.uni-heidelberg.de/content/bosch-small-traffic-lights-dataset
"""`BSTLD <https://hci.iwr.uni-heidelberg.de/content\
/bosch-small-traffic-lights-dataset>`_ dataset.
The file structure should be like::
Expand Down
4 changes: 1 addition & 3 deletions tensorbay/opendataset/BioIDFace/loader.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,7 @@


def BioIDFace(path: str) -> Dataset:
"""Dataloader of `The BioID Face`_ Dataset.
.. _The BioID Face: https://www.bioid.com/facedb/
"""`BioID Face <https://www.bioid.com/facedb/>`_ dataset.
The folder structure should be like::
Expand Down
4 changes: 1 addition & 3 deletions tensorbay/opendataset/CACD/loader.py
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,7 @@


def CACD(path: str) -> Dataset:
"""Dataloader of `Cross-Age Celebrity Dataset (CACD)`_ dataset.
.. _Cross-Age Celebrity Dataset (CACD): https://bcsiriuschen.github.io/CARC/
"""`Cross-Age Celebrity Dataset (CACD) <https://bcsiriuschen.github.io/CARC/>`_ dataset.
The file structure should be like::
Expand Down
4 changes: 1 addition & 3 deletions tensorbay/opendataset/CADC/loader.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,7 @@


def CADC(path: str) -> FusionDataset:
"""Dataloader of the `CADC`_ dataset.
.. _CADC: http://cadcd.uwaterloo.ca/index.html
"""`CADC <http://cadcd.uwaterloo.ca/index.html>`_ dataset.
The file structure should be like::
Expand Down
8 changes: 2 additions & 6 deletions tensorbay/opendataset/CCPD/loader.py
Original file line number Diff line number Diff line change
Expand Up @@ -125,9 +125,7 @@


def CCPD(path: str) -> Dataset:
"""Dataloader of CCPD open dataset.
.. _CCPD: https://github.com/detectRecog/CCPD
"""`CCPD <https://github.com/detectRecog/CCPD>`_ dataset.
The file structure should be like::
Expand Down Expand Up @@ -187,9 +185,7 @@ def CCPD(path: str) -> Dataset:


def CCPDGreen(path: str) -> Dataset:
"""Dataloader of CCPDGreen open dataset.
.. _CCPD: https://github.com/detectRecog/CCPD
"""`CCPDGreen <https://github.com/detectRecog/CCPD>`_ dataset.
The file structure should be like::
Expand Down
4 changes: 1 addition & 3 deletions tensorbay/opendataset/CIHP/loader.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,7 @@


def CIHP(path: str) -> Dataset:
"""Dataloader of the `CIHP`_ dataset.
.. _CIHP: https://github.com/Engineering-Course/CIHP_PGN
"""`CIHP <https://github.com/Engineering-Course/CIHP_PGN>`_ dataset.
The file structure should be like::
Expand Down
4 changes: 1 addition & 3 deletions tensorbay/opendataset/COCO2017/loader.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,7 @@


def COCO2017(path: str) -> Dataset:
"""Dataloader of COCO2017 open dataset.
.. _COCO2017: https://cocodataset.org/#home
"""`COCO2017 <https://cocodataset.org/#home>`_ dataset.
The file structure should be like::
Expand Down
4 changes: 1 addition & 3 deletions tensorbay/opendataset/COVIDChestXRay/loader.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,7 @@


def COVIDChestXRay(path: str) -> Dataset:
"""Dataloader of `COVID-chestxray`_ Dataset.
.. _COVID-chestxray: https://github.com/ieee8023/covid-chestxray-dataset
"""`COVID-chestxray <https://github.com/ieee8023/covid-chestxray-dataset>`_ dataset.
The file structure should be like::
Expand Down
4 changes: 1 addition & 3 deletions tensorbay/opendataset/COVID_CT/loader.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,7 @@


def COVID_CT(path: str) -> Dataset:
"""Dataloader of the `COVID-CT`_ dataset.
.. _COVID-CT: https://github.com/UCSD-AI4H/COVID-CT
"""`COVID-CT <https://github.com/UCSD-AI4H/COVID-CT>`_ dataset.
The file structure should be like::
Expand Down
5 changes: 2 additions & 3 deletions tensorbay/opendataset/CarConnection/loader.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,8 @@


def CarConnection(path: str) -> Dataset:
"""Dataloader of `The Car Connection Picture`_ dataset.
.. _The Car Connection Picture: https://github.com/nicolas-gervais/predicting-car-price-from-scraped-data/tree/master/picture-scraper # noqa: E501
"""`Car Connection Picture <https://github.com/nicolas-gervais\
/predicting-car-price-from-scraped-data/tree/master/picture-scraper>`_ dataset.
The file structure should be like::
Expand Down
4 changes: 1 addition & 3 deletions tensorbay/opendataset/CoinImage/loader.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,7 @@


def CoinImage(path: str) -> Dataset:
"""Dataloader of the `Coin Image`_ dataset.
.. _Coin Image: https://cvl.tuwien.ac.at/research/cvl-databases/coin-image-dataset/
"""`Coin Image <https://cvl.tuwien.ac.at/research/cvl-databases/coin-image-dataset/>`_ dataset.
The file structure should be like::
Expand Down
4 changes: 1 addition & 3 deletions tensorbay/opendataset/CompCars/loader.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,7 @@


def CompCars(path: str) -> Dataset:
"""Dataloader of the `CompCars`_ dataset.
.. _CompCars: http://mmlab.ie.cuhk.edu.hk/datasets/comp_cars/index.html
"""`CompCars <http://mmlab.ie.cuhk.edu.hk/datasets/comp_cars/index.html>`_ dataset.
The file structure should be like::
Expand Down
8 changes: 2 additions & 6 deletions tensorbay/opendataset/DAVIS2017/loader.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,7 @@


def DAVIS2017SemiSupervised(path: str) -> Dataset:
"""Dataloader of `DAVIS2017SemiSupervised`_ open dataset.
.. _DAVIS2017SemiSupervised: https://davischallenge.org/davis2017/code.html
"""`DAVIS2017SemiSupervised <https://davischallenge.org/davis2017/code.html>`_ dataset.
The file structure should be like::
Expand Down Expand Up @@ -111,9 +109,7 @@ def DAVIS2017SemiSupervised(path: str) -> Dataset:


def DAVIS2017Unsupervised(path: str) -> Dataset:
"""Dataloader of `DAVIS2017Unsupervised`_ open dataset.
.. _DAVIS2017Unsupervised: https://davischallenge.org/davis2017/code.html
"""`DAVIS2017Unsupervised <https://davischallenge.org/davis2017/code.html>`_ dataset.
The file structure should be like::
Expand Down
5 changes: 2 additions & 3 deletions tensorbay/opendataset/DeepRoute/loader.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,8 @@


def DeepRoute(path: str) -> Dataset:
"""Dataloader of the `DeepRoute Open Dataset`_.
.. _DeepRoute Open Dataset: https://www.graviti.cn/open-datasets/DeepRoute
"""`DeepRoute <https://gas.graviti.cn/dataset/graviti-open-dataset\
/DeepRoute>`_ dataset.
The file structure should be like::
Expand Down
4 changes: 1 addition & 3 deletions tensorbay/opendataset/DogsVsCats/loader.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,7 @@


def DogsVsCats(path: str) -> Dataset:
"""Dataloader of the `Dogs vs Cats`_ dataset.
.. _Dogs vs Cats: https://www.kaggle.com/c/dogs-vs-cats
"""`Dogs vs Cats <https://www.kaggle.com/c/dogs-vs-cats>`_ dataset.
The file structure should be like::
Expand Down
5 changes: 2 additions & 3 deletions tensorbay/opendataset/DownsampledImagenet/loader.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,8 @@


def DownsampledImagenet(path: str) -> Dataset:
"""Dataloader of the `Downsampled Imagenet`_ dataset.
.. _Downsampled Imagenet: http://image-net.org/small/download.php
"""`Downsampled Imagenet <https://www.tensorflow.org/datasets\
/catalog/downsampled_imagenet>`_ dataset.
The file structure should be like::
Expand Down
4 changes: 1 addition & 3 deletions tensorbay/opendataset/Elpv/loader.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,7 @@


def Elpv(path: str) -> Dataset:
"""Dataloader of the `elpv`_ dataset.
.. _elpv: https://github.com/zae-bayern/elpv-dataset
"""`elpv <https://github.com/zae-bayern/elpv-dataset>`_ dataset.
The file structure should be like::
Expand Down
4 changes: 1 addition & 3 deletions tensorbay/opendataset/FLIC/loader.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,7 @@


def FLIC(path: str) -> Dataset:
"""Dataloader of the `FLIC`_ dataset.
.. _FLIC: https://bensapp.github.io/flic-dataset.html
"""`FLIC <https://bensapp.github.io/flic-dataset.html>`_ dataset.
The folder structure should be like::
Expand Down
4 changes: 1 addition & 3 deletions tensorbay/opendataset/FSDD/loader.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,7 @@


def FSDD(path: str) -> Dataset:
"""Dataloader of the `Free Spoken Digit`_ dataset.
.. _Free Spoken Digit: https://github.com/Jakobovski/free-spoken-digit-dataset
"""`Free Spoken Digit <https://github.com/Jakobovski/free-spoken-digit-dataset>`_ dataset.
The file structure should be like::
Expand Down
8 changes: 2 additions & 6 deletions tensorbay/opendataset/Flower/loader.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,7 @@


def Flower17(path: str) -> Dataset:
"""Dataloader of the `17 Category Flower`_ dataset.
.. _17 Category Flower: http://www.robots.ox.ac.uk/~vgg/data/flowers/17/index.html
"""`17 Category Flower <http://www.robots.ox.ac.uk/~vgg/data/flowers/17/index.html>`_ dataset.
The dataset are 3 separate splits.
The results in the paper are averaged over the 3 splits.
Expand Down Expand Up @@ -71,9 +69,7 @@ def Flower17(path: str) -> Dataset:


def Flower102(path: str) -> Dataset:
"""Dataloader of the `102 Category Flower`_ dataset.
.. _102 Category Flower: http://www.robots.ox.ac.uk/~vgg/data/flowers/102/index.html
"""`102 Category Flower <http://www.robots.ox.ac.uk/~vgg/data/flowers/102/index.html>`_ dataset.
The file structure should be like::
Expand Down
5 changes: 2 additions & 3 deletions tensorbay/opendataset/HalpeFullBody/loader.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,8 @@


def HalpeFullBody(path: str) -> Dataset:
"""Dataloader of the `Halpe Full-Body Human Keypoints and HOI-Det`_ dataset.
.. _Halpe Full-Body Human Keypoints and HOI-Det: https://github.com/Fang-Haoshu/Halpe-FullBody/ # noqa: E501
"""`Halpe Full-Body Human Keypoints and HOI-Det <https://github.com\
/Fang-Haoshu/Halpe-FullBody/>`_ dataset.
The folder structure should be like::
Expand Down
4 changes: 1 addition & 3 deletions tensorbay/opendataset/HardHatWorkers/loader.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,7 @@


def HardHatWorkers(path: str) -> Dataset:
"""Dataloader of the `Hard Hat Workers`_ dataset.
.. _Hard Hat Workers: https://makeml.app/datasets/hard-hat-workers
"""`Hard Hat Workers <https://makeml.app/datasets/hard-hat-workers>`_ dataset.
The file structure should be like::
Expand Down
5 changes: 2 additions & 3 deletions tensorbay/opendataset/HeadPoseImage/loader.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,8 @@


def HeadPoseImage(path: str) -> Dataset:
"""Dataloader of the `Head Pose Image`_ dataset.
.. _Head Pose Image: http://www-prima.inrialpes.fr/perso/Gourier/Faces/HPDatabase.html
"""`Head Pose Image <http://crowley-coutaz.fr\
/Head%20Pose%20Image%20Database.html>`_ dataset.
The file structure should be like::
Expand Down
8 changes: 2 additions & 6 deletions tensorbay/opendataset/ImageEmotion/loader.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,7 @@


def ImageEmotionAbstract(path: str) -> Dataset:
"""Dataloader of the `Image Emotion-abstract`_ dataset.
.. _Image Emotion-abstract: https://www.imageemotion.org/
"""`Image Emotion-abstract <https://www.imageemotion.org/>`_ dataset.
The file structure should be like::
Expand Down Expand Up @@ -61,9 +59,7 @@ def ImageEmotionAbstract(path: str) -> Dataset:


def ImageEmotionArtphoto(path: str) -> Dataset:
"""Dataloader of the `Image Emotion-art Photo`_ dataset.
.. _Image Emotion-art Photo: https://www.imageemotion.org/
"""`Image Emotion-art Photo <https://www.imageemotion.org/>`_ dataset.
The file structure should be like::
Expand Down

0 comments on commit d537690

Please sign in to comment.