Skip to content

Latest commit

 

History

History
43 lines (30 loc) · 1.48 KB

index.rst

File metadata and controls

43 lines (30 loc) · 1.48 KB

MLOS Documentation

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.

Documentation is generated from both the source tree markdown and the Python docstrings for each of the packages with navigation links on the side.

MLOS also has a fairly large test suite, so when in doubt, check the code for additional examples or reach out to the maintainers on Github!

.. toctree::
   :caption: Source Tree Documentation
   :maxdepth: 4
   :hidden:

   source_tree_docs/index
   source_tree_docs/mlos_core/index
   source_tree_docs/mlos_bench/index
   source_tree_docs/mlos_viz/index

.. toctree::
   :caption: API Reference
   :maxdepth: 2

   autoapi/mlos_core/index
   autoapi/mlos_bench/index
   autoapi/mlos_viz/index

.. toctree::
   :caption: mlos_bench CLI usage
   :maxdepth: 1

   mlos_bench.run.usage

.. toctree::
   :maxdepth: 1
   :caption: References

   Github Source Tree <https://github.com/microsoft/MLOS>