make up general structure

Author: voorhs

docs/source/conf.py

@@ -30,6 +30,7 @@
     "sphinx.ext.doctest",
     "sphinx.ext.autosummary",
     "nbsphinx",
+    "sphinx.ext.todo",
 ]
 
 templates_path = ["_templates"]
@@ -42,6 +43,7 @@
 html_theme = "alabaster"
 html_static_path = ["_static"]
 
+todo_include_todos = True
 
 autodoc_default_options = {
     "members": True,

docs/source/guides/embeddings_proxy_optimization.rst

@@ -0,0 +1,4 @@
+Proxy Optimization of Embedding Model
+=====================================
+
+В этом разделе вы познакомитесь с опциональным узлом оптимизации ``EmbeddingNode``.

docs/source/guides/index.rst

@@ -0,0 +1,9 @@
+Guides
+======
+
+.. toctree::
+    :glob:
+    :maxdepth: 1
+    :caption: Contents:
+
+    ./*

docs/source/guides/optimization_results.rst

@@ -0,0 +1,4 @@
+Optimization Results
+====================
+
+В этом гайде вы узнаете, что сохраняется по результатам автоконфигурации классификатора и как это контролировать.

docs/source/guides/search_space_configuration.rst

@@ -0,0 +1,4 @@
+Search Space Configuration
+==========================
+
+В этом гайде вы узнаете как настраивать кастомное пространство поиска гипепараметров.

docs/source/index.rst

@@ -16,32 +16,19 @@ AutoIntent documentation
 
    This project is under active development.
 
-Задача распознавания интентов является одной из основных подзадач создания задачеориентированных диалоговых систем наряду с написанием сценария и заполнением слотов. Диалоговая система в широком смысле --- это текстовый интерфейс взаимодействия с некоторым сервисом (будь то сервис по заказу еды или по получению информации о банковском счете). Обычно сервис поддерживает конечное количество API методов, которые вызываются во время диалога с пользователем. Чтобы определить, какой метод нужен в данный момент диалога используются классификаторы интентов. Если рассуждать в терминах машинного обучения, то это задача классификации текстов. 
-
-Проект AutoIntent предлагает пользователям следующее:
+Задача распознавания интентов является одной из основных подзадач создания задачеориентированных диалоговых систем наряду с написанием сценария и заполнением слотов. Проект AutoIntent предлагает пользователям следующее:
 
 - удобная библиотека методов для классификации интентов, с которыми можно работать в sklearn-like формате "fit-predict".
 - AutoML-подход к созданию классификаторов, при котором достаточно лишь загрузить небольшой набор размеченных данных
 
-Хороший классификатор интентов должен учитывать особенности задачи создания диалоговой системы:
-
-- Множественность домена. Количество API методов может быть достаточно большим, чтобы самому обучить классификатор
-- Детекция out-of-domain примеров. Необходимо обрабатывать случаи, когда пользователь высказывает неподдерживаемые интенты.
-- Множественность интента. В один момент диалога для некоторых задач может возникать сразу несколько взаимодополняющих интентов, и тогда, если рассуждать в терминах машинного обучения, задача сводится к multilabel классификации.
-- Огромный набор существующих методов и их гиперпараметров. Как говорится, "для данной задачи можно перебрать много гиперпараметров, и вы будете перебирать эти гиперпараметры".
-- Скупость обучающей выборки. Собрать разнообразную выборку из примеров реплик и тем более целых диалогов достаточно сложно.
-- Использование ML-классификаторов совместно с rule-based подходом.
-
-Four of five problems перечисленных в этом списке решаются использованием библиотеки AutoIntent!
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
    :caption: Contents:
 
    quickstart
-   usage
-   api
-   tutorials
    concepts
-
-Try out our :py:func:`autointent.generation.description_generation.get_utterances_by_id` function.
+   tutorials
+   guides/index
+   learn/index
+   api

docs/source/learn/dialogue_systems.rst

@@ -0,0 +1,36 @@
+Dialogue Systems
+================
+
+В этом разделе вы познакомитесь с основами построения диалоговых систем.
+
+Intents
+-----
+
+Диалоговая система в широком смысле --- это текстовый интерфейс взаимодействия с некоторым сервисом (будь то сервис по заказу еды или по получению информации о банковском счете). Обычно сервис поддерживает конечное количество API методов, которые вызываются во время диалога с пользователем. Чтобы определить, какой метод нужен в данный момент диалога используются классификаторы интентов. Если рассуждать в терминах машинного обучения, то это задача классификации текстов. 
+
+Хороший классификатор интентов должен учитывать особенности задачи создания диалоговой системы:
+
+- Множественность домена. Количество API методов может быть достаточно большим, чтобы самому обучить классификатор
+- Детекция out-of-domain примеров. Необходимо обрабатывать случаи, когда пользователь высказывает неподдерживаемые интенты.
+- Множественность интента. В один момент диалога для некоторых задач может возникать сразу несколько взаимодополняющих интентов, и тогда, если рассуждать в терминах машинного обучения, задача сводится к multilabel классификации.
+- Огромный набор существующих методов и их гиперпараметров. Как говорится, "для данной задачи можно перебрать много гиперпараметров, и вы будете перебирать эти гиперпараметры".
+- Скупость обучающей выборки. Собрать разнообразную выборку из примеров реплик и тем более целых диалогов достаточно сложно.
+- Использование ML-классификаторов совместно с rule-based подходом.
+
+Four of five problems перечисленных в этом списке решаются использованием библиотеки AutoIntent!
+
+Slots
+-----
+
+.. todo::
+
+    когда-нибудь
+
+
+Script
+------
+
+.. todo::
+
+    когда-нибудь
+    

docs/source/learn/embeddings.rst

@@ -0,0 +1,4 @@
+Embeddings
+==========
+
+В этом разделе вы узнаете зачем нужны эмбединги для задач NLP.

docs/source/learn/greedy_optimization.rst

@@ -0,0 +1,4 @@
+Greedy Optimization
+===================
+
+В этом разделе вы узнаете, как работает жадная стратегия оптимизации в нашей библиотеке

docs/source/learn/index.rst

@@ -0,0 +1,9 @@
+Learn AutoIntent
+================
+
+.. toctree::
+    :glob:
+    :maxdepth: 1
+    :caption: Contents:
+
+    ./*