diff --git a/bayesian_learning_control/control/algos/pytorch/common/get_lr_scheduler.py b/bayesian_learning_control/control/algos/pytorch/common/get_lr_scheduler.py index f5eb08de3..b706e7545 100644 --- a/bayesian_learning_control/control/algos/pytorch/common/get_lr_scheduler.py +++ b/bayesian_learning_control/control/algos/pytorch/common/get_lr_scheduler.py @@ -1,13 +1,4 @@ """Contains functions used for creating Pytorch learning rate schedulers. - -.. rubric:: Functions - -.. autosummary:: - :toctree: - - calc_linear_decay_rate - get_exponential_decay_rate - get_lr_scheduler """ from decimal import Decimal diff --git a/docs/source/conf.py b/docs/source/conf.py index fe2a66efa..02a3ff41b 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -23,14 +23,9 @@ import os.path as osp import sys -dirname = osp.dirname -top_folder = dirname(dirname(dirname(__file__))) -sys.path.insert(0, osp.join(top_folder, "bayesian_learning_control")) -sys.path.insert(0, osp.join(top_folder, "examples")) -sys.path.insert(0, osp.join(top_folder, "bayesian_learning_control", "control")) -sys.path.insert(0, osp.join(top_folder, "bayesian_learning_control", "hardware")) -sys.path.insert(0, osp.join(top_folder, "bayesian_learning_control", "modeling")) -sys.path.insert(0, osp.join(top_folder, "bayesian_learning_control", "simzoo")) +sys.path.insert(0, osp.abspath("../../bayesian_learning_control")) +sys.path.insert(1, osp.abspath("../../examples")) +sys.path.insert(2, osp.abspath("../../bayesian_learning_control/simzoo")) # -- General configuration ------------------------------------------------ @@ -62,21 +57,21 @@ def __getattr__(cls, name): extensions = [ "sphinx.ext.todo", "sphinx.ext.imgmath", - "sphinx.ext.viewcode", "sphinx.ext.autodoc", "sphinx.ext.autosummary", "sphinx.ext.napoleon", "sphinx.ext.extlinks", "sphinx.ext.githubpages", "sphinx.ext.intersphinx", - "recommonmark", + "sphinx.ext.viewcode", + "myst_parser", ] # Extension settings autosummary_generate = True autosummary_generate_overwrite = True autodoc_member_order = "bysource" -autosummary_imported_members = True +# autosummary_imported_members = True # imgmath settings imgmath_image_format = "svg" diff --git a/docs/source/control/eval_robustness.rst b/docs/source/control/eval_robustness.rst index 3f3f0f9ba..c3738b2d4 100644 --- a/docs/source/control/eval_robustness.rst +++ b/docs/source/control/eval_robustness.rst @@ -247,7 +247,7 @@ For a good example of how this is done, one can look at the ``_disturb How to find available disturbances ================================== -When using the :ref:`robustness eval CLI ` you can use the ``--list_disturbance_types`` and ``--list_disturbance_variants`` flags to list the available disturbance types and variants for a given agent trained in a given +When using the :ref:`robustness eval CLI ` you can use the ``--list_disturbance_types`` and ``--list_disturbance_variants`` flags to list the available disturbance types and variants for a given agent trained in a given environment. For more details, one should check the check the ``DISTURBANCE_CFG`` constant inside the :class:`~bayesian_learning_control.simzoo.simzoo.common.disturber.Disturber` class file or the environment ``_disturber.py`` file. diff --git a/package-lock.json b/package-lock.json index da12e7f2c..722816136 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "bayesian-learning-control", - "version": "1.1.20", + "version": "1.1.21", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/setup.cfg b/setup.cfg index 2f0dfa3d7..b9143e31e 100644 --- a/setup.cfg +++ b/setup.cfg @@ -69,7 +69,7 @@ docs = sphinx sphinx-autobuild sphinx-rtd-theme - recommonmark + myst_parser dev = %(tf)s %(tuning)s