Update doc strings (#1049)

pytorch · Oct 21, 2020 · 41fc76b · 41fc76b
1 parent c320033
commit 41fc76b
Show file tree

Hide file tree

Showing 21 changed files with 161 additions and 238 deletions.
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,3 +1,3 @@
-sphinx
+sphinx==2.4.4
 sphinxcontrib-googleanalytics
 -e git+git://github.com/pytorch/pytorch_sphinx_theme.git#egg=pytorch_sphinx_theme 
diff --git a/docs/source/data/functional.rst b/docs/source/data/functional.rst
diff --git a/docs/source/data/metrics.rst b/docs/source/data/metrics.rst
diff --git a/docs/source/data/utils.rst b/docs/source/data/utils.rst
diff --git a/docs/source/datasets.rst b/docs/source/datasets.rst
@@ -95,66 +95,42 @@ TextClassificationDataset
 AG_NEWS
 ~~~~~~~
 
-AG_NEWS dataset is subclass of ``TextClassificationDataset`` class.
-
-.. autoclass:: AG_NEWS
-  :members: __init__
+.. autofunction:: AG_NEWS
 
 SogouNews
 ~~~~~~~~~
 
-SogouNews dataset is subclass of ``TextClassificationDataset`` class.
-
-.. autoclass:: SogouNews
-  :members: __init__
+.. autofunction:: SogouNews
 
 DBpedia
 ~~~~~~~
 
-DBpedia dataset is subclass of ``TextClassificationDataset`` class.
-
-.. autoclass:: DBpedia
-  :members: __init__
+.. autofunction::  DBpedia
 
 YelpReviewPolarity
 ~~~~~~~~~~~~~~~~~~
 
-YelpReviewPolarity dataset is subclass of ``TextClassificationDataset`` class.
-
-.. autoclass:: YelpReviewPolarity
-  :members: __init__
+.. autofunction:: YelpReviewPolarity
 
 YelpReviewFull
 ~~~~~~~~~~~~~~
 
-YelpReviewFull dataset is subclass of ``TextClassificationDataset`` class.
-
-.. autoclass:: YelpReviewFull
-  :members: __init__
+.. autofunction:: YelpReviewFull
 
 YahooAnswers
 ~~~~~~~~~~~~
 
-YahooAnswers dataset is subclass of ``TextClassificationDataset`` class.
-
-.. autoclass:: YahooAnswers
-  :members: __init__
+.. autofunction:: YahooAnswers
 
 AmazonReviewPolarity
 ~~~~~~~~~~~~~~~~~~~~
 
-AmazonReviewPolarity dataset is subclass of ``TextClassificationDataset`` class.
-
-.. autoclass:: AmazonReviewPolarity
-  :members: __init__
+.. autofunction:: AmazonReviewPolarity
 
 AmazonReviewFull
 ~~~~~~~~~~~~~~~~
 
-AmazonReviewFull dataset is subclass of ``TextClassificationDataset`` class.
-
-.. autoclass:: AmazonReviewFull
-  :members: __init__
+.. autofunction:: AmazonReviewFull
 
 
 Question Classification

diff --git a/docs/source/experimental_datasets.rst b/docs/source/experimental_datasets.rst
@@ -27,88 +27,62 @@ The following datasets are available:
     :local:
 
 
-Sentiment Analysis
-^^^^^^^^^^^^^^^^^^
-
-IMDb
-~~~~
-
-.. autoclass:: IMDB
-  :members: __init__
-
-
 Text Classification
 ^^^^^^^^^^^^^^^^^^^
 
 TextClassificationDataset
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 
+Text classification datasets are subclasses of ``TextClassificationDataset`` class.
+
 .. autoclass:: TextClassificationDataset
   :members: __init__
 
 AG_NEWS
 ~~~~~~~
 
-AG_NEWS dataset is subclass of ``TextClassificationDataset`` class.
+.. autofunction:: AG_NEWS
 
-.. autoclass:: AG_NEWS
-  :members: __init__
 
 SogouNews
 ~~~~~~~~~
 
-SogouNews dataset is subclass of ``TextClassificationDataset`` class.
-
-.. autoclass:: SogouNews
-  :members: __init__
+.. autofunction:: SogouNews
 
 DBpedia
 ~~~~~~~
 
-DBpedia dataset is subclass of ``TextClassificationDataset`` class.
-
-.. autoclass:: DBpedia
-  :members: __init__
+.. autofunction:: DBpedia
 
 YelpReviewPolarity
 ~~~~~~~~~~~~~~~~~~
 
-YelpReviewPolarity dataset is subclass of ``TextClassificationDataset`` class.
-
-.. autoclass:: YelpReviewPolarity
-  :members: __init__
+.. autofunction:: YelpReviewPolarity
 
 YelpReviewFull
 ~~~~~~~~~~~~~~
 
-YelpReviewFull dataset is subclass of ``TextClassificationDataset`` class.
-
-.. autoclass:: YelpReviewFull
-  :members: __init__
+.. autofunction:: YelpReviewFull
 
 YahooAnswers
 ~~~~~~~~~~~~
 
-YahooAnswers dataset is subclass of ``TextClassificationDataset`` class.
-
-.. autoclass:: YahooAnswers
-  :members: __init__
+.. autofunction:: YahooAnswers
 
 AmazonReviewPolarity
 ~~~~~~~~~~~~~~~~~~~~
 
-AmazonReviewPolarity dataset is subclass of ``TextClassificationDataset`` class.
-
-.. autoclass:: AmazonReviewPolarity
-  :members: __init__
+.. autofunction:: AmazonReviewPolarity
 
 AmazonReviewFull
 ~~~~~~~~~~~~~~~~
 
-AmazonReviewFull dataset is subclass of ``TextClassificationDataset`` class.
+.. autofunction:: AmazonReviewFull
 
-.. autoclass:: AmazonReviewFull
-  :members: __init__
+IMDb
+~~~~
+
+.. autofunction:: IMDB
 
 
 Language Modeling
@@ -123,29 +97,25 @@ Language modeling datasets are subclasses of ``LanguageModelingDataset`` class.
 WikiText-2
 ~~~~~~~~~~
 
-.. autoclass:: WikiText2
-  :members: __init__
+.. autofunction:: WikiText2
 
 
 WikiText103
 ~~~~~~~~~~~
 
-.. autoclass:: WikiText103
-  :members: __init__
+.. autofunction:: WikiText103
 
 
 PennTreebank
 ~~~~~~~~~~~~
 
-.. autoclass:: PennTreebank
-  :members: __init__
+.. autofunction:: PennTreebank
 
 
 WMTNewsCrawl
 ~~~~~~~~~~~~
 
-.. autoclass:: WMTNewsCrawl
-  :members: __init__
+.. autofunction:: WMTNewsCrawl
 
 
 Machine Translation
@@ -160,22 +130,19 @@ Language modeling datasets are subclasses of ``TranslationDataset`` class.
 Multi30k
 ~~~~~~~~
 
-.. autoclass:: Multi30k
-  :members: __init__
+.. autofunction:: Multi30k
 
 
 IWSLT
 ~~~~~
 
-.. autoclass:: IWSLT
-  :members: __init__
+.. autofunction:: IWSLT
 
 
 WMT14
 ~~~~~
 
-.. autoclass:: WMT14
-  :members: __init__
+.. autofunction:: WMT14
 
 
 Sequence Tagging
@@ -189,14 +156,12 @@ Language modeling datasets are subclasses of ``SequenceTaggingDataset`` class.
 UDPOS
 ~~~~~
 
-.. autoclass:: UDPOS
-  :members: __init__
+.. autofunction:: UDPOS
 
 CoNLL2000Chunking
-~~~~~
+~~~~~~~~~~~~~~~~~
 
-.. autoclass:: CoNLL2000Chunking
-  :members: __init__
+.. autofunction:: CoNLL2000Chunking
 
 Question Answer
 ^^^^^^^^^^^^^^^
@@ -210,12 +175,10 @@ Question answer datasets are subclasses of ``QuestionAnswerDataset`` class.
 SQuAD 1.0
 ~~~~~~~~~
 
-.. autoclass:: SQuAD1
-  :members: __init__
+.. autofunction:: SQuAD1
 
 
 SQuAD 2.0
 ~~~~~~~~~
 
-.. autoclass:: SQuAD2
-  :members: __init__
+.. autofunction:: SQuAD2