Merge pull request #4869 from RasaHQ/convert-pipeline-doc

Update choosing-a-pipeline.rst
RasaHQ · Dec 6, 2019 · 0151e24 · 0151e24
2 parents acedba4 + 4efb352
commit 0151e24
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -85,3 +85,4 @@ events.db
 env
 venv
 .dir-locals.el
+.history
diff --git a/changelog/4869.doc.rst b/changelog/4869.doc.rst
@@ -0,0 +1 @@
+Document the pipeline for ``pretrained_embeddings_convert`` in the pre-configured pipelines section.
diff --git a/changelog/4894.docs.rst → changelog/4894.doc.rst b/changelog/4894.docs.rst → changelog/4894.doc.rst
diff --git a/docs/nlu/choosing-a-pipeline.rst b/docs/nlu/choosing-a-pipeline.rst
@@ -305,6 +305,27 @@ n-grams, preserving word boundaries. We empirically found the second featurizer
 to be more powerful, but we decided to keep the first featurizer as well to make
 featurization more robust.
 
+.. _section_pretrained_embeddings_convert_pipeline:
+
+pretrained_embeddings_convert
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+To use the ``pretrained_embeddings_convert`` template:
+
+.. literalinclude:: ../../sample_configs/config_pretrained_embeddings_convert.yml
+    :language: yaml
+
+To use the components and configure them separately:
+
+.. code-block:: yaml
+
+    language: "en"
+
+    pipeline:
+    - name: "WhitespaceTokenizer"
+    - name: "ConveRTFeaturizer"
+    - name: "EmbeddingIntentClassifier"
+
 .. _section_pretrained_embeddings_spacy_pipeline:
 
 pretrained_embeddings_spacy