Update Docs & Update Embeddings

PetrochukM · Mar 8, 2018 · c71365e · c71365e
1 parent 212d191
commit c71365e
Show file tree

Hide file tree

Showing 21 changed files with 304 additions and 423 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # PyTorch-NLP
 
-PyTorch-NLP is a library for Natural Language Processing in Python. It's built with the very latest research in mind, and was designed from day one to support rapid prototyping. PyTorch-NLP comes with pre-trained word vectors, iterators, dataset library, metrics, and tokenization. It's commercial open-source software, released under the BSD3 license. 
+PyTorch-NLP is a library for Natural Language Processing in Python. It's built with the very latest research in mind, and was designed from day one to support rapid prototyping. PyTorch-NLP comes with pre-trained word vectors, iterators, dataset library, metrics, and tokenization. It's open-source software, released under the BSD3 license. 
 
 [![codecov](https://codecov.io/gh/PetrochukM/PyTorch-NLP/branch/master/graph/badge.svg)](https://codecov.io/gh/PetrochukM/PyTorch-NLP) 
 [![Documentation Status](https://readthedocs.org/projects/pytorchnlp/badge/?version=latest)](http://pytorchnlp.readthedocs.io/en/latest/?badge=latest)

diff --git a/docs/conf.py b/docs/conf.py
@@ -15,12 +15,10 @@
 import os
 import sys
 sys.path.insert(0, os.path.abspath('../torchnlp'))
+import torchnlp
 
 # -- Project information -----------------------------------------------------
 
-import io
-import re
-
 project = 'PyTorch-NLP'
 copyright = '2018, Michael Petrochuk'
 author = 'Michael Petrochuk'

diff --git a/docs/index.rst b/docs/index.rst
@@ -1,25 +1,28 @@
-.. Pytorch-NLP documentation master file, created by
-   sphinx-quickstart on Tue Feb 27 18:27:23 2018.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
+
+:github_url: https://github.com/pytorch/pytorch
 
 Welcome to Pytorch-NLP's documentation!
 =======================================
 
+PyTorch-NLP is a library for Natural Language Processing in Python. It's built with the very latest
+research in mind, and was designed from day one to support rapid prototyping. PyTorch-NLP comes with 
+pre-trained word vectors, iterators, dataset library, metrics, and tokenization. It's
+open-source software, released under the BSD3 license. 
+
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
    :caption: Package Reference
 
-   source/torchnlp
    source/torchnlp.datasets
    source/torchnlp.metrics
    source/torchnlp.nn
    source/torchnlp.samplers
    source/torchnlp.text_encoders
+   source/torchnlp.embeddings
+   source/torchnlp.utils
 
 Indices and tables
 ==================
 
 * :ref:`genindex`
 * :ref:`modindex`
-* :ref:`search`
diff --git a/docs/source/torchnlp.datasets.rst b/docs/source/torchnlp.datasets.rst
@@ -1,52 +1,8 @@
 torchnlp.datasets package
 =========================
 
-Submodules
-----------
-
-torchnlp.datasets.count module
-------------------------------
-
-.. automodule:: torchnlp.datasets.count
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-torchnlp.datasets.dataset module
---------------------------------
-
-.. automodule:: torchnlp.datasets.dataset
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-torchnlp.datasets.reverse module
---------------------------------
-
-.. automodule:: torchnlp.datasets.reverse
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-torchnlp.datasets.simple\_qa module
------------------------------------
-
-.. automodule:: torchnlp.datasets.simple_qa
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-torchnlp.datasets.zero\_to\_zero module
----------------------------------------
-
-.. automodule:: torchnlp.datasets.zero_to_zero
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-
-Module contents
----------------
+All datasets are subclasses of :class:`torchnlp.datasets.Dataset`, which inherits from
+:class:`torch.utils.data.Dataset`.
 
 .. automodule:: torchnlp.datasets
     :members:

diff --git a/docs/source/torchnlp.embeddings.rst b/docs/source/torchnlp.embeddings.rst
@@ -0,0 +1,7 @@
+torchnlp.embeddings package
+===========================
+
+.. automodule:: torchnlp.embeddings
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/torchnlp.metrics.rst b/docs/source/torchnlp.metrics.rst
@@ -1,29 +1,6 @@
 torchnlp.metrics package
 ========================
 
-Submodules
-----------
-
-torchnlp.metrics.accuracy module
---------------------------------
-
-.. automodule:: torchnlp.metrics.accuracy
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-torchnlp.metrics.bleu module
-----------------------------
-
-.. automodule:: torchnlp.metrics.bleu
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-
-Module contents
----------------
-
 .. automodule:: torchnlp.metrics
     :members:
     :undoc-members:

diff --git a/docs/source/torchnlp.nn.rst b/docs/source/torchnlp.nn.rst
@@ -1,29 +1,6 @@
 torchnlp.nn package
 ===================
 
-Submodules
-----------
-
-torchnlp.nn.attention module
-----------------------------
-
-.. automodule:: torchnlp.nn.attention
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-torchnlp.nn.lock\_dropout module
---------------------------------
-
-.. automodule:: torchnlp.nn.lock_dropout
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-
-Module contents
----------------
-
 .. automodule:: torchnlp.nn
     :members:
     :undoc-members:

diff --git a/docs/source/torchnlp.rst b/docs/source/torchnlp.rst
diff --git a/docs/source/torchnlp.samplers.rst b/docs/source/torchnlp.samplers.rst
@@ -1,45 +1,6 @@
 torchnlp.samplers package
 =========================
 
-Submodules
-----------
-
-torchnlp.samplers.bucket\_batch\_sampler module
------------------------------------------------
-
-.. automodule:: torchnlp.samplers.bucket_batch_sampler
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-torchnlp.samplers.noisy\_sorted\_sampler module
------------------------------------------------
-
-.. automodule:: torchnlp.samplers.noisy_sorted_sampler
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-torchnlp.samplers.random\_batch\_sampler module
------------------------------------------------
-
-.. automodule:: torchnlp.samplers.random_batch_sampler
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-torchnlp.samplers.sorted\_sampler module
-----------------------------------------
-
-.. automodule:: torchnlp.samplers.sorted_sampler
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-
-Module contents
----------------
-
 .. automodule:: torchnlp.samplers
     :members:
     :undoc-members:

diff --git a/docs/source/torchnlp.text_encoders.rst b/docs/source/torchnlp.text_encoders.rst
@@ -1,109 +1,6 @@
 torchnlp.text\_encoders package
 ===============================
 
-Submodules
-----------
-
-torchnlp.text\_encoders.character\_encoder module
--------------------------------------------------
-
-.. automodule:: torchnlp.text_encoders.character_encoder
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-torchnlp.text\_encoders.delimiter\_encoder module
--------------------------------------------------
-
-.. automodule:: torchnlp.text_encoders.delimiter_encoder
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-torchnlp.text\_encoders.identity\_encoder module
-------------------------------------------------
-
-.. automodule:: torchnlp.text_encoders.identity_encoder
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-torchnlp.text\_encoders.moses\_encoder module
----------------------------------------------
-
-.. automodule:: torchnlp.text_encoders.moses_encoder
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-torchnlp.text\_encoders.reserved\_tokens module
------------------------------------------------
-
-.. automodule:: torchnlp.text_encoders.reserved_tokens
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-torchnlp.text\_encoders.spacy\_encoder module
----------------------------------------------
-
-.. automodule:: torchnlp.text_encoders.spacy_encoder
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-torchnlp.text\_encoders.static\_tokenizer\_encoder module
----------------------------------------------------------
-
-.. automodule:: torchnlp.text_encoders.static_tokenizer_encoder
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-torchnlp.text\_encoders.subword\_encoder module
------------------------------------------------
-
-.. automodule:: torchnlp.text_encoders.subword_encoder
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-torchnlp.text\_encoders.subword\_text\_tokenizer module
--------------------------------------------------------
-
-.. automodule:: torchnlp.text_encoders.subword_text_tokenizer
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-torchnlp.text\_encoders.text\_encoders module
----------------------------------------------
-
-.. automodule:: torchnlp.text_encoders.text_encoders
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-torchnlp.text\_encoders.treebank\_encoder module
-------------------------------------------------
-
-.. automodule:: torchnlp.text_encoders.treebank_encoder
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-torchnlp.text\_encoders.word\_encoder module
---------------------------------------------
-
-.. automodule:: torchnlp.text_encoders.word_encoder
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-
-Module contents
----------------
-
 .. automodule:: torchnlp.text_encoders
     :members:
     :undoc-members:

diff --git a/docs/source/torchnlp.utils.rst b/docs/source/torchnlp.utils.rst
@@ -0,0 +1,7 @@
+torchnlp.utils package
+===============================
+
+.. automodule:: torchnlp.utils
+    :members:
+    :undoc-members:
+    :show-inheritance: