Metadata-Version: 2.1
Name: mlos-viz
Version: 0.6.2
Summary: Visualization Python interface for benchmark automation and optimization results.
Author-email: Microsoft <mlos-maintainers@service.microsoft.com>
Maintainer-email: Microsoft <mlos-maintainers@service.microsoft.com>
License: MIT
Project-URL: Documentation, https://microsoft.github.io/MLOS/source_tree_docs/mlos_viz/
Project-URL: Repository, https://github.com/microsoft/MLOS/
Project-URL: Issues, https://github.com/microsoft/MLOS/issues
Project-URL: Package Source, https://github.com/microsoft/MLOS/tree/main/mlos_viz/
Keywords: autotuning,benchmarking,optimization,systems,visualization
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: mlos-bench==0.6.2
Requires-Dist: dabl>=0.3.2
Requires-Dist: matplotlib
Requires-Dist: seaborn>=0.12.2
Provides-Extra: full
Provides-Extra: full-tests
Requires-Dist: pytest; extra == "full-tests"
Requires-Dist: pytest-forked; extra == "full-tests"
Requires-Dist: pytest-xdist; extra == "full-tests"
Requires-Dist: pytest-cov; extra == "full-tests"
Requires-Dist: pytest-local-badge; extra == "full-tests"

# mlos-viz

The [`mlos_viz`](https://github.com/microsoft/MLOS/tree/main/mlos_viz/./) module is an aid to visualizing experiment benchmarking and optimization results generated and stored by [`mlos_bench`](https://github.com/microsoft/MLOS/tree/main/mlos_viz/../mlos_bench/).

## Overview

Its core API is `mlos_viz.plot(experiment)`, initially implemented as a wrapper around [`dabl`](https://github.com/dabl/dabl) to provide a basic visual overview of the results, where `experiment` is an [`ExperimentData`](https://github.com/microsoft/MLOS/tree/main/mlos_viz/../mlos_bench/mlos_bench/storage/base_experiment_data.py) objected returned from the [`mlos_bench.storage`](https://github.com/microsoft/MLOS/tree/main/mlos_viz/../mlos_bench/mlos_bench/storage/) layer APIs.

In the future, we plan to add more automatic visualizations, interactive visualizations, feedback to the `mlos_bench` experiment trial scheduler, etc.

It's available for `pip install` via the pypi repository at [mlos-viz](https://pypi.org/project/mlos-viz/).

## See Also

- <https://microsoft.github.io/MLOS/autoapi/mlos_viz/> for more documentation details
