Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update doc strings #1049

Merged
merged 14 commits into from Oct 21, 2020
Merged

Update doc strings #1049

Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
13ee4e2
remove unused file
zhangguanheng66 Oct 20, 2020
5af9879
Update MHA doc
zhangguanheng66 Oct 20, 2020
5db174b
checkpoint
zhangguanheng66 Oct 20, 2020
5921284
checkpoint
zhangguanheng66 Oct 20, 2020
12c7e1d
checkpoint
zhangguanheng66 Oct 20, 2020
b5eff98
checkpoint
zhangguanheng66 Oct 20, 2020
a826f3f
checkpoint
zhangguanheng66 Oct 20, 2020
948033b
checkpoint
zhangguanheng66 Oct 20, 2020
3b8839a
flake8
Oct 20, 2020
1257e1b
sync with master
Oct 20, 2020
72c556c
checkpoint
zhangguanheng66 Oct 21, 2020
a2eb9c5
checkpoint
zhangguanheng66 Oct 21, 2020
e65441f
checkpoint
zhangguanheng66 Oct 21, 2020
b518f52
checkpoint
zhangguanheng66 Oct 21, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/requirements.txt
View file
Open in desktop
@@ -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
38 changes: 0 additions & 38 deletions docs/source/data/functional.rst
View file
Open in desktop

This file was deleted.

13 changes: 0 additions & 13 deletions docs/source/data/metrics.rst
View file
Open in desktop

This file was deleted.

13 changes: 0 additions & 13 deletions docs/source/data/utils.rst
View file
Open in desktop

This file was deleted.

89 changes: 26 additions & 63 deletions docs/source/experimental_datasets.rst
View file
Open in desktop
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
^^^^^^^^^^^^^^^
Expand All @@ -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
24 changes: 9 additions & 15 deletions docs/source/experimental_transforms.rst
View file
Open in desktop
Expand Up @@ -22,7 +22,7 @@ torchtext.experimental.transforms
:special-members: __init__

:hidden:`TextSequentialTransforms`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: TextSequentialTransforms
:members:
Expand All @@ -31,19 +31,15 @@ torchtext.experimental.transforms
:hidden:`load_sp_model`
~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: load_sp_model
:members:
:special-members: __init__
.. autofunction:: load_sp_model

:hidden: `sentencepiece_tokenizer`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: sentencepiece_tokenizer
:members:
:special-members: __init__
.. autofunction:: sentencepiece_tokenizer

:hidden:`SentencePieceTokenizer`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: SentencePieceTokenizer
:members:
Expand All @@ -52,26 +48,24 @@ torchtext.experimental.transforms
:hidden: `sentencepiece_processor`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: sentencepiece_processor
:members:
:special-members: __init__
.. autofunction:: sentencepiece_processor

:hidden:`SentencePieceProcessor`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: SentencePieceProcessor
:members:
:special-members: __init__

:hidden:`VocabTransform`
~~~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: VocabTransform
:members:
:special-members: __init__

:hidden:`VectorTransform`
~~~~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: VectorTransform
:members:
Expand Down
8 changes: 4 additions & 4 deletions docs/source/experimental_vocab.rst
View file
Open in desktop
Expand Up @@ -8,24 +8,24 @@ torchtext.experimental.vocab
.. currentmodule:: torchtext.experimental.vocab

:hidden:`Vocab`
~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~

.. autoclass:: Vocab
:members:
:special-members:

:hidden:`vocab`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~

.. autofunction:: vocab

:hidden:`vocab_from_file`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: vocab_from_file

:hidden:`vocab_from_raw_text_file`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: vocab_from_raw_text_file

Expand Down
3 changes: 1 addition & 2 deletions docs/source/index.rst
View file
Open in desktop
Expand Up @@ -33,15 +33,14 @@ popular datasets for natural language.

self
torchtext.data <data>
modules
nn_modules
data_utils
data_functional
data_metrics
torchtext.datasets <datasets>
torchtext.vocab <vocab>
torchtext.utils <utils>
experimental_datasets
experimental_functional
experimental_transforms
experimental_vectors
experimental_vocab
Expand Down
8 changes: 4 additions & 4 deletions docs/source/modules.rst → docs/source/nn_modules.rst
View file
Open in desktop
@@ -1,11 +1,11 @@
.. role:: hidden
:class: hidden-section

torchtext.models.multiheadattention
==================================
torchtext.nn.modules.multiheadattention
=======================================

.. automodule:: torchtext.models.multiheadattention
.. currentmodule:: torchtext.models.multiheadattention
.. automodule:: torchtext.nn.modules.multiheadattention
.. currentmodule:: torchtext.nn.modules.multiheadattention

:hidden:`MultiheadAttentionContainer`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down