docs: refactor structure, add tutorials

deeppavlov · Jul 23, 2018 · 5e6633a · 5e6633a
1 parent 3c10c31
commit 5e6633a
Show file tree

Hide file tree

Showing 19 changed files with 113 additions and 25 deletions.
diff --git a/docs/userdocs/classifiers.rst → docs/components/classifiers.rst b/docs/userdocs/classifiers.rst → docs/components/classifiers.rst
diff --git a/docs/userdocs/go_bot.rst → docs/components/go_bot.rst b/docs/userdocs/go_bot.rst → docs/components/go_bot.rst
diff --git a/docs/userdocs/morphotagger.rst → docs/components/morphotagger.rst b/docs/userdocs/morphotagger.rst → docs/components/morphotagger.rst
diff --git a/docs/userdocs/ner.rst → docs/components/ner.rst b/docs/userdocs/ner.rst → docs/components/ner.rst
diff --git a/docs/userdocs/neural_ranking.rst → docs/components/neural_ranking.rst b/docs/userdocs/neural_ranking.rst → docs/components/neural_ranking.rst
diff --git a/docs/userdocs/seq2seq_go_bot.rst → docs/components/seq2seq_go_bot.rst b/docs/userdocs/seq2seq_go_bot.rst → docs/components/seq2seq_go_bot.rst
diff --git a/docs/userdocs/slot_filling.rst → docs/components/slot_filling.rst b/docs/userdocs/slot_filling.rst → docs/components/slot_filling.rst
diff --git a/docs/userdocs/spelling_correction.rst → docs/components/spelling_correction.rst b/docs/userdocs/spelling_correction.rst → docs/components/spelling_correction.rst
diff --git a/docs/userdocs/squad.rst → docs/components/squad.rst b/docs/userdocs/squad.rst → docs/components/squad.rst
diff --git a/docs/userdocs/tfidf_ranking.rst → docs/components/tfidf_ranking.rst b/docs/userdocs/tfidf_ranking.rst → docs/components/tfidf_ranking.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,38 +1,42 @@
-.. DeepPavlov documentation master file, created by
-   sphinx-quickstart on Mon Jul 16 10:56:14 2018.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
 Welcome to DeepPavlov's documentation!
 ======================================
 
 .. toctree::
    :glob:
    :maxdepth: 1
-   :caption: Getting Started
+   :caption: Intro
 
-   Installation <userdocs/installation>
-   Hello bot! <userdocs/hello_bot>
-   Pre-trained word vectors <userdocs/pretrained_vectors>
-   Parameters evolution <userdocs/parameters_evolution>
+   Hello bot! <intro/hello_bot>
+   Installation <intro/installation>
+   Pre-trained word vectors <intro/pretrained_vectors>
+   Parameters evolution <intro/parameters_evolution>
+   Tutorials <intro/tutorials>
 
 
 .. toctree::
    :glob:
    :maxdepth: 1
    :caption: Components
 
-   Classification <userdocs/classifiers>
-   Slot filling <userdocs/slot_filling>
-   Goal-Oriented Dialogue Bot <userdocs/go_bot>
-   Sequence-To-Sequence Dialogue Bot <userdocs/seq2seq_go_bot>
-   Named Entity Recognition <userdocs/ner>
-   Spelling Correction <userdocs/spelling_correction>
-   TF-IDF Ranking <userdocs/tfidf_ranking>
-   Neural Ranking <userdocs/neural_ranking>
-   Context Question Answering <userdocs/squad>
-   Open-Domain Question Answering <userdocs/odqa>
-   Morphological Tagger <userdocs/morphotagger>
+   Classification <components/classifiers>
+   Slot filling <components/slot_filling>
+   Goal-Oriented Dialogue Bot <components/go_bot>
+   Sequence-To-Sequence Dialogue Bot <components/seq2seq_go_bot>
+   Named Entity Recognition <components/ner>
+   Spelling Correction <components/spelling_correction>
+   TF-IDF Ranking <components/tfidf_ranking>
+   Neural Ranking <components/neural_ranking>
+   Context Question Answering <components/squad>
+   Morphological Tagger <components/morphotagger>
+
+
+.. toctree::
+   :glob:
+   :maxdepth: 1
+   :caption: Skills
+
+   Pattern Matching <skills/pattern_matching>
+   Open-Domain Question Answering <skills/odqa>
 
 
 .. toctree::

diff --git a/docs/intro/hello_bot.rst b/docs/intro/hello_bot.rst
@@ -0,0 +1,33 @@
+This is "Hello, World!" example of simple bot implemented in DeepPavlov
+=======================================================================
+
+Import key components to build HelloBot.
+
+.. code:: python
+
+    from deeppavlov.core.agent import Agent, HighestConfidenceSelector
+    from deeppavlov.skills.pattern_matching_skill import PatternMatchingSkill
+
+Create skills as pre-defined responses for a user's input containing
+specific keywords. Every skill returns response and confidence.
+
+.. code:: python
+
+    hello = PatternMatchingSkill(responses=['Hello world! :)'], patterns=["hi", "hello", "good day"])
+    bye = PatternMatchingSkill(['Goodbye world! :(', 'See you around.'], ["bye", "chao", "see you"])
+    fallback = PatternMatchingSkill(["I don't understand, sorry :/", 'I can say "Hello world!" 8)'])
+
+Agent executes skills and then takes response from the skill with the
+highest confidence.
+
+.. code:: python
+
+    HelloBot = Agent([hello, bye, fallback], skills_selector=HighestConfidenceSelector())
+
+Give the floor to the HelloBot!
+
+.. code:: python
+
+    print(HelloBot(['Hello!', 'Boo...', 'Bye.']))
+
+`Jupyter notebook with HelloBot example. <https://github.com/deepmipt/DeepPavlov/blob/master/examples/hello_bot.ipynb>`__
diff --git a/docs/userdocs/installation.rst → docs/intro/installation.rst b/docs/userdocs/installation.rst → docs/intro/installation.rst
diff --git a/docs/userdocs/parameters_evolution.rst → docs/intro/parameters_evolution.rst b/docs/userdocs/parameters_evolution.rst → docs/intro/parameters_evolution.rst
diff --git a/docs/userdocs/pretrained_vectors.rst → docs/intro/pretrained_vectors.rst b/docs/userdocs/pretrained_vectors.rst → docs/intro/pretrained_vectors.rst
diff --git a/docs/intro/tutorials.rst b/docs/intro/tutorials.rst
@@ -0,0 +1,53 @@
+DeepPavlov tutorials
+====================
+
+Introduction to DeepPavlov
+--------------------------
+
+`Jupyter notebook <https://github.com/deepmipt/DeepPavlov/tree/master/examples/tutorials/00_deeppavlov_intro.ipynb>`__ \|
+`slides <https://github.com/deepmipt/DeepPavlov/tree/master/examples/tutorials/00_deeppavlov_intro.pdf>`__
+
+Install the library and understand a simple "Hello World!" Bot written
+in 7 lines of code. Experiment with basic pattern matching rule-based
+bot.
+
+Data preparation in DeepPavlov
+------------------------------
+
+`Jupyter notebook <https://github.com/deepmipt/DeepPavlov/tree/master/examples/tutorials/01_deeppavlov_data.ipynb>`__
+
+Learn how to read and prepare data for trainable components.
+
+Named Entity Recognition with DeepPavlov
+----------------------------------------
+
+`Jupyter notebook <https://github.com/deepmipt/DeepPavlov/tree/master/examples/tutorials/02_deeppavlov_ner.ipynb>`__ \|
+`slides <https://github.com/deepmipt/DeepPavlov/tree/master/examples/tutorials/02_deeppavlov_ner.pdf>`__ \|
+`video <https://youtu.be/6HlL87PWxXU>`__
+
+Build a simple convolutional neural network to solve the named entity
+recognition task. Master data downloading, preprocessing and batching
+then train and score the model.
+
+Task-oriented bot with DeepPavlov
+---------------------------------
+
+`Jupyter notebook <https://github.com/deepmipt/DeepPavlov/tree/master/examples/tutorials/03_deeppavlov_gobot.ipynb>`__ \|
+`slides <https://github.com/deepmipt/DeepPavlov/tree/master/examples/tutorials/03_deeppavlov_gobot.pdf>`__ \|
+`video <https://youtu.be/uvH1zB7qahI>`__
+
+Intro to DeepPavlov configs - a powerfull method to stack models. Study
+how to train 4 different task-oriented bots on DSTC2 dataset. These
+include (1) a basic bot, (2) a bot with a database of restaurants, (3) a
+bot with fasttext embeddings, (4) a bot with attention mechanism over
+input words.
+
+Chit-chat bot with DeepPavlov
+-----------------------------
+
+`Jupyter notebook <https://github.com/deepmipt/DeepPavlov/tree/master/examples/tutorials/04_deeppavlov_chitchat.ipynb>`__ \|
+`slides <https://github.com/deepmipt/DeepPavlov/tree/master/examples/tutorials/04_deeppavlov_chitchat.pdf>`__ \|
+`video <https://youtu.be/G1TkCkoghC8>`__
+
+Implement in DeepPavlov sequence-to-sequence encoder-decoder model with
+attention mechanism and teacher forcing for chit-chat.
diff --git a/docs/userdocs/odqa.rst → docs/skills/odqa.rst b/docs/userdocs/odqa.rst → docs/skills/odqa.rst
diff --git a/docs/skills/pattern_matching.rst b/docs/skills/pattern_matching.rst
@@ -0,0 +1,2 @@
+Pattern Matching Skill
+======================
diff --git a/docs/userdocs/hello_bot.rst b/docs/userdocs/hello_bot.rst