fix doc and tutorials

luigibonati · Jun 6, 2024 · 2aec410 · 2aec410
1 parent 0192845
commit 2aec410
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 5 deletions.
diff --git a/docs/api_cvs.rst b/docs/api_cvs.rst
@@ -71,6 +71,8 @@ General framework which allows to optimize a single model with different loss fu
 
 Framework for the numerical determination of the committor function based on its variational principle.
 
+.. rubric:: Committor 
+
 .. currentmodule:: mlcolvar.cvs
 
 .. autosummary::

diff --git a/docs/notebooks/examples/ex_DeepLDA.ipynb b/docs/notebooks/examples/ex_DeepLDA.ipynb
@@ -766,7 +766,7 @@
     }
    ],
    "source": [
-    "from mlcolvar.utils.explain import sensitivity_analysis\n",
+    "from mlcolvar.explain import sensitivity_analysis\n",
     "\n",
     "results = sensitivity_analysis(model, dataset, feature_names=dataset.feature_names, per_class=False, plot_mode='barh')"
    ]

diff --git a/docs/notebooks/tutorials/expl_lasso.ipynb b/docs/notebooks/tutorials/expl_lasso.ipynb
@@ -5,8 +5,8 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# LASSO\n",
-    "### Using sparse linear models (LASSO) to interpret the results"
+    "# Sparse linear models\n",
+    "### Using LASSO to interpret the results"
    ]
   },
   {
@@ -253,10 +253,11 @@
    ]
   },
   {
+   "attachments": {},
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Sparse linear models"
+    "## LASSO"
    ]
   },
   {

diff --git a/docs/tutorials.rst b/docs/tutorials.rst
@@ -29,6 +29,8 @@ How to customize the CVs, either using the multitask framework or by creating ne
 
    tutorials_advanced
 
+.. rubric:: Interpreting CVs
+
 Some examples of how to interpret the CVs, using sensitivity analysis or sparse linear models. 
 
 .. toctree::

diff --git a/docs/tutorials_explain.rst b/docs/tutorials_explain.rst
@@ -5,5 +5,5 @@ Interpreting CVs
    :maxdepth: 1
 
    notebooks/tutorials/expl_features_relevances.ipynb
-   notebooks/tutorials/expl_stateinterpreter.ipynb
    notebooks/tutorials/expl_lasso.ipynb
+   notebooks/tutorials/expl_stateinterpreter.ipynb