From cc10b431ed6b07071e972dcb3d904c434e438abc Mon Sep 17 00:00:00 2001 From: Brian Kroth Date: Fri, 22 Nov 2024 17:31:12 +0000 Subject: [PATCH 1/2] Doc TODO comments --- mlos_bench/mlos_bench/__init__.py | 3 +++ mlos_core/mlos_core/__init__.py | 8 +++++++- 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/mlos_bench/mlos_bench/__init__.py b/mlos_bench/mlos_bench/__init__.py index 1f54f78c44..455c0139ec 100644 --- a/mlos_bench/mlos_bench/__init__.py +++ b/mlos_bench/mlos_bench/__init__.py @@ -21,6 +21,9 @@ :py:class:`~mlos_bench.optimizers.grid_search_optimizer.GridSearchOptimizer` can be used to perform a grid search over the parameter space instead. +TODO: Mention intent and philosophy of the project (repeatable, reproducible, etc.) +TODO: Mention where to find configs and examples and how to think about them. + The other core classes in this package are: - :py:mod:`~mlos_bench.environments` which provide abstractions for representing an diff --git a/mlos_core/mlos_core/__init__.py b/mlos_core/mlos_core/__init__.py index 13b1bf2af8..6db34950e0 100644 --- a/mlos_core/mlos_core/__init__.py +++ b/mlos_core/mlos_core/__init__.py @@ -18,6 +18,12 @@ libraries in order to provide a consistent interface so that the rest of the code using it can easily exchange one optimizer for another (or even stack them). +TODO: Mention LlamaTune and space adapters. + +TODO: Mention ConfigSpace + +TODO: Mention pandas + Specifically: - :py:class:`~mlos_core.optimizers.optimizer.BaseOptimizer` is the base class for all Optimizers @@ -56,7 +62,7 @@ >>> opt = OptimizerFactory.create( ... parameter_space=cs, ... optimization_targets=["y"], -... optimizer_type=OptimizerType.SMAC, +... optimizer_type=OptimizerType.SMAC, # or FLAML, etc. ... optimizer_kwargs=opt_args, ... space_adapter_type=SpaceAdapterType.IDENTITY, # or LLAMATUNE ... space_adapter_kwargs=space_adpaters_kwargs, From 267ac5f790347fe0e428eb6a93e58ddeb052d83a Mon Sep 17 00:00:00 2001 From: Brian Kroth Date: Mon, 25 Nov 2024 21:23:00 +0000 Subject: [PATCH 2/2] fix broken links --- doc/source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/index.rst b/doc/source/index.rst index cea832a860..41b283e0b6 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -6,7 +6,7 @@ MLOS Documentation .. image:: badges/coverage.svg :target: htmlcov/index.html -`MLOS `_ is a project to enable `autotuning ` with `mlos_core `_ for systems via `automated benchmarking `_ with `mlos_bench `_ including managing the storage and `visualization `_ of the results via `mlos_viz `_. +`MLOS `_ is a project to enable `autotuning `_ with `mlos_core `_ for systems via `automated benchmarking `_ with `mlos_bench `_ including managing the storage and `visualization `_ of the results via `mlos_viz `_. See below for additional documentation sections.