update branch

Author: dariaolshevskaya

docs/source/conf.py

@@ -9,22 +9,22 @@
 import os
 import sys
 
-sys.path.insert(0, os.path.abspath("../../dialogue2graph"))
+sys.path.insert(0, os.path.abspath("../../dialog2graph"))
 
-project = "Dialogue2Graph"
-copyright = "2024, Denis Kuznetsov, Anastasia Voznyuk, Andrey Chirkin"
-author = "Denis Kuznetsov, Anastasia Voznyuk, Andrey Chirkin"
+project = "Dialog2Graph"
+copyright = "2025, Denis Kuznetsov, Anastasia Voznyuk, Andrey Chirkin, Anna Mikhailova, Maria Molchanova, Yuri Peshkichev"
+author = "Denis Kuznetsov, Anastasia Voznyuk, Andrey Chirkin, Anna Mikhailova, Maria Molchanova, Yuri Peshkichev"
 
 # Get the deployment environment
 on_github = os.environ.get("GITHUB_ACTIONS") == "true"
 
 # Configure URLs for GitHub Pages
 if on_github:
-    html_baseurl = "/dialogue2graph/dev/"
+    html_baseurl = "/dialog2graph/dev/"
     html_context = {
         "display_github": True,
         "github_user": "deeppavlov",
-        "github_repo": "dialogue2graph",
+        "github_repo": "dialog2graph",
         "github_version": "dev",
         "conf_py_path": "/docs/source/",
     }
@@ -34,45 +34,75 @@
 
 extensions = [
     "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.doctest",
+    "autoapi.extension",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.todo",
+    "sphinx.ext.coverage",
     "sphinx.ext.viewcode",
     "sphinx.ext.napoleon",
     "sphinx.ext.extlinks",
     "sphinx_autodoc_typehints",
-    "sphinxcontrib.apidoc",
+    "sphinx.ext.graphviz",
 ]
 
-templates_path = ["_templates"]
-
 autodoc_default_options = {
     "members": True,
     "undoc-members": False,
-    "private-members": False,
+    "private-members": True,
     "special-members": "__call__",
     "member-order": "bysource",
     "exclude-members": "_abc_impl, model_fields, model_computed_fields, model_config",
 }
 
-# Mock imports that cause issues
-autodoc_mock_imports = ["datasets"]
-
-apidoc_module_dir = "../../dialogue2graph"
-apidoc_output_dir = "reference"
+autodoc_typehints = "both"
 
+autoapi_dirs = ["../../dialog2graph"]
+autoapi_options = [
+    "members",
+    "undoc-members",
+    "show-inheritance",
+    "show-module-summary",
+    "special-members",
+    "imported-members",
+]
+suppress_warnings = ["autoapi.python_import_resolution"]
+autoapi_ignore = ["*/cli/*.py"]
+
+napoleon_google_docstring = True
+napoleon_include_init_with_doc = False
+napoleon_include_private_with_doc = False
+napoleon_include_special_with_doc = True
+napoleon_use_admonition_for_examples = False
+napoleon_use_admonition_for_notes = False
+napoleon_use_admonition_for_references = False
+napoleon_use_ivar = False
+napoleon_use_param = True
+napoleon_use_rtype = True
+napoleon_preprocess_types = False
+napoleon_type_aliases = None
+napoleon_attr_annotations = True
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
 # html_theme = 'alabaster'
 html_theme = "pydata_sphinx_theme"
 
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ["_static"]
 
+html_show_sourcelink = False
+
 extlinks = {
     "github_source_link": (
-        "https://github.com/deeppavlov/dialogue2graph/tree/dev/%s",
+        "https://github.com/deeppavlov/dialog2graph/tree/dev/%s",
         None,
     ),
 }
@@ -83,22 +113,45 @@
     "scripts/bootstrap.js",
     "scripts/fontawesome.js",
 ]
+html_css_files = [
+    "css/custom.css",
+]
 
 # Fix base URL for GitHub Pages
-html_baseurl = "/dialogue2graph/dev/"
+html_baseurl = "/dialog2graph/dev/"
 
 # Important: Add this to handle static files correctly
 html_theme_options = {
+    "header_links_before_dropdown": 6,
     "use_edit_page_button": False,
     "navigation_depth": 3,
     "show_toc_level": 2,
     # Add this to fix static file paths
-    "static_page_path": "/dialogue2graph/dev/_static/",
+    "static_page_path": "/dialog2graph/dev/_static/",
+    "icon_links": [
+        {
+            "name": "GitHub",
+            "url": "https://github.com/deeppavlov/dialog2graph",
+            "icon": "fa-brands fa-github",
+            "type": "fontawesome",
+        },
+    ],
+    "secondary_sidebar_items": ["example-links", "page-toc"],
 }
 
 # Fix relative URLs for GitHub Pages deployment
 html_use_relative_paths = True
 
 # Ensure all static paths are properly prefixed for GitHub Pages
 if os.environ.get("GITHUB_ACTIONS") == "true":
-    html_static_path_suffix = "/dialogue2graph/dev"
+    html_static_path_suffix = "/dialog2graph/dev"
+
+
+def skip_submodules(app, what, name, obj, skip, options):
+    if what == "module" and "." not in name:
+        skip = True
+    return skip
+
+
+def setup(sphinx):
+    sphinx.connect("autoapi-skip-member", skip_submodules)

docs/source/reference/dialogue2graph.cli.rst

@@ -2,21 +2,21 @@
 
 ## Experiment setup
 
-The incremental approach was tested with the recommended generation models which are: o1-mini, o3-mini, and chatgpt-4o-latest. Test data is example 13 (serial number) from synthetic data subset called "generated_24". This example is one graph with four dialogues sampled from this graph. 
+The incremental approach was tested with the recommended generation models which are: o1-mini, o3-mini, and chatgpt-4o-latest. Test data is example 13 (serial number) from synthetic data subset called "generated_24". This example is one graph with four dialogs sampled from this graph. 
 Tested incrementation pipeline:
 1. take a graph from the example as a true graph
-2. generate the first graph from the first dialogue in the example (same generation method for all models)
-3. generate the next 3 graphs subsequently using the selected incrementation method, adding new dialogues one by one (i.e. in the end we get 4 graphs - for dialogue 0, dialogues 0-1, dialogues 0-2, dialogues 0-3)
+2. generate the first graph from the first dialog in the example (same generation method for all models)
+3. generate the next 3 graphs subsequently using the selected incrementation method, adding new dialogs one by one (i.e. in the end we get 4 graphs - for dialog 0, dialogs 0-1, dialogs 0-2, dialogs 0-3)
 4. if generation is successful, get metrics for the last incremental graph and the true graph
 
 ## Results and observations
 1. The best result was obtained using the ThreeStagesGenerator method and o3-mini as a generation model.
 2. AppendChain method doesn't work well for this task, regardless of the generation model.
 3. chatgpt-4o-latest model has tendency to fail graph generation (returns error with incorrect output format).
-4. In the dialogue 0 two assistant's utterances are the same - doesn't matter?
+4. In the dialog 0 two assistant's utterances are the same - doesn't matter?
 
 ## Future plans and suggestions
 1. Test ThreeStagesGenerator with o3-mini on more complex examples (or on all the dataset), get metrics +/- error analysis
 2. Test other pipelines: 
-    - take the longest dialogue as the first one and continue as before
-    - take all the dialogues at once and generate a general graph of them
+    - take the longest dialog as the first one and continue as before
+    - take all the dialogs at once and generate a general graph of them

docs/source/reference/dialogue2graph.datasets.complex_dialogues.rst

@@ -1,5 +1,5 @@
 {
-    "dialogues": [
+    "dialogs": [
         {
             "messages": [
                 {