From 58fa2a97f0dce24840dd088ddb1aaef0eb49e1cf Mon Sep 17 00:00:00 2001 From: Nico Palm Date: Sun, 3 Mar 2024 18:58:07 +0100 Subject: [PATCH] update layout documentation --- README.md | 2 +- docs/conf.py | 3 +++ docs/description/basics.md | 6 +++--- docs/description/moo-algorithms.md | 4 +++- docs/index.rst | 4 +++- 5 files changed, 13 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index a4b3ed8..4d395cd 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ ![PyPI - Downloads](https://img.shields.io/pypi/dm/paref) -[documentation](https://paref.readthedocs.io/en/latest/)//[notebooks](https://github.com/nicolaipalm/paref/tree/main/docs/notebooks)//[demo](https://huggingface.co/spaces/NicoPalm/paref-showcase)//[paper](https://papers.ssrn.com/sol3/papers.cfm?abstract_id=4668407) +[documentation](https://paref.readthedocs.io/en/latest/index.html)//[notebooks](https://github.com/nicolaipalm/paref/tree/main/docs/notebooks)//[demo](https://huggingface.co/spaces/NicoPalm/paref-showcase)//[paper](https://papers.ssrn.com/sol3/papers.cfm?abstract_id=4668407) # Paref - problem tailored MOO for expensive black-box functions diff --git a/docs/conf.py b/docs/conf.py index 09d034e..d19510a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -63,6 +63,9 @@ 'github_url': 'https://github.com/nicolaipalm/paref', 'search_bar_text': 'Search for treasure...', } +html_sidebars = { + '**': [] +} # remove primary sidebar html_title = 'Paref' diff --git a/docs/description/basics.md b/docs/description/basics.md index a3d0917..1ac03c2 100644 --- a/docs/description/basics.md +++ b/docs/description/basics.md @@ -20,10 +20,10 @@ is desirable. With Paref you can do exactly that. ## Workflow The workflow of Paref is simple: -1. [Implement a blackbox function]() +1. Implement a blackbox function 2. Explore the target space (by calling the blackbox function's ``perform_lhc(n)`` method) -3. [Apply a MOO algorithm reflecting your preference]() -4. [Analyze the output]() +3. Apply a MOO algorithm reflecting your preference +4. Analyze the output 5. Repeat steps 2-4 until satisfied
diff --git a/docs/description/moo-algorithms.md b/docs/description/moo-algorithms.md index 2b5276e..7edfc3e 100644 --- a/docs/description/moo-algorithms.md +++ b/docs/description/moo-algorithms.md @@ -1,9 +1,11 @@ +:html_theme.sidebar_secondary.remove: + # Parefs' MOO algorithms Paref provides a series of ready to use *generic* (mainly minimization algorithms) and *problem tailored* (i.e. targeting certain properties) MOO algorithms implemented in the ``ParefMOO`` interface. -In order to apply any MOO algorithm (except ``ExpressSearch``which only needs the maximum number of iterations) +In order to apply any MOO algorithm (except ``ExpressSearch`` which only needs the maximum number of iterations) you need to initialize (or implement your own) ``StoppingCriteria`` indicating when to stop the optimization process and call the MOO algorithm to it and the black-box function (bbf). diff --git a/docs/index.rst b/docs/index.rst index e8b9b8b..bcb71b1 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,3 +1,5 @@ +:html_theme.sidebar_secondary.remove: + ================================ MOO for Expensive Blackbox-Functions ================================ @@ -8,7 +10,7 @@ MOO for Expensive Blackbox-Functions :hidden: basics <./description/basics.md> - FAQs <./description/faqs.md> + faq <./description/faqs.md> trouble-shooting <./description/trouble-shooting.md> algorithms <./description/moo-algorithms.md> demo