# 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