docs: update pretrained embeddings readme

deeppavlov · Aug 8, 2018 · a194301 · a194301
1 parent 3f7e2ca
commit a194301
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 6 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -11,7 +11,7 @@ Welcome to DeepPavlov's documentation!
    Conceptual overview <intro/overview>
    Features <intro/features>
    Configuration files <intro/config_description>
-   Pre-trained word vectors <intro/pretrained_vectors>
+   Pre-trained embeddings <intro/pretrained_vectors>
    Parameters evolution <intro/parameters_evolution>
    Tutorials <intro/tutorials>
 

diff --git a/docs/intro/pretrained_vectors.rst b/docs/intro/pretrained_vectors.rst
@@ -1,5 +1,18 @@
-Pre-trained word vectors
-========================
+Pretrained embeddings
+============================
+
+ELMo
+----
+
+| We are publishing :class:`Russian language ELMo embeddings model <deeppavlov.models.embedders.elmo_embedder.ELMoEmbedder>` for tensorflow-hub.
+| ELMo (Embeddings from Language Models) representations are pre-trained contextual representations from
+  large-scale bidirectional language models. See a paper `Deep contextualized word representations
+  <https://arxiv.org/abs/1802.05365>`__ for more information about the algorithm and a detailed analysis.
+| These vectors where trained on `Russian Wikipedia <https://ru.wikipedia.org/>`__.
+
+
+fastText
+--------
 
 We are publishing pre-trained word vectors for Russian language. These
 vectors were trained on joint `Russian
@@ -14,13 +27,13 @@ You can get vectors either in binary or in text (vec) formats both for
 fastText and GloVe.
 
 License
--------
+~~~~~~~
 
 The pre-trained word vectors are distributed under the `License Apache
 2.0 <https://www.apache.org/licenses/LICENSE-2.0>`__.
 
 Downloads
----------
+~~~~~~~~~
 
 The models can be downloaded from:
 
@@ -39,7 +52,7 @@ The models can be downloaded from:
 +-----------------------+---------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 
 Word vectors training parameters
---------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 These word vectors were trained with following parameters ([...] is for
 default value):