Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

More documentation updates #887

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

More documentation updates #887

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cc10b43
Doc TODO comments
bpkroth Nov 22, 2024
59353ea
Merge branch 'main' into more-docs
bpkroth Nov 25, 2024
267ac5f
fix broken links
bpkroth Nov 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ MLOS Documentation
.. image:: badges/coverage.svg
:target: htmlcov/index.html

`MLOS <source_tree_docs/index.html>`_ is a project to enable `autotuning </autoapi/mlos_core/index.html>` with `mlos_core </autoapi/mlos_core/index.html>`_ for systems via `automated benchmarking </autoapi/mlos_bench/index.html>`_ with `mlos_bench </autoapi/mlos_bench/index.html>`_ including managing the storage and `visualization </autoapi/mlos_viz/index.html>`_ of the results via `mlos_viz </autoapi/mlos_viz/index.html>`_.
`MLOS <source_tree_docs/index.html>`_ is a project to enable `autotuning <autoapi/mlos_core/index.html>`_ with `mlos_core <autoapi/mlos_core/index.html>`_ for systems via `automated benchmarking <autoapi/mlos_bench/index.html>`_ with `mlos_bench </autoapi/mlos_bench/index.html>`_ including managing the storage and `visualization <autoapi/mlos_viz/index.html>`_ of the results via `mlos_viz <autoapi/mlos_viz/index.html>`_.

See below for additional documentation sections.

Expand Down
3 changes: 3 additions & 0 deletions mlos_bench/mlos_bench/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 7 additions & 1 deletion mlos_core/mlos_core/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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,
Expand Down
Loading