---
hide-toc: true
---

(user-guide-testbed)=

```{image} ../../_static/logo_testbed_light.svg
---
align: center
alt: mlrl-testbed
class: only-light
width: 100%
---
```

```{image} ../../_static/logo_testbed_dark.svg
---
align: center
alt: mlrl-testbed
class: only-dark
width: 100%
---
```

This software package provides **mlrl-testbed - a command line utility for running machine learning experiments**. It implements a *straightforward*, *easily configurable*, and *extensible* workflow for conducting experiments.

```{image} ../../_static/user_guide/testbed/screenshot_light.svg
---
align: center
alt: Log output produced by "mlrl-testbed" when running an experiment
class: only-light
width: 75%
---
```

```{image} ../../_static/user_guide/testbed/screenshot_dark.svg
---
align: center
alt: Log output produced by "mlrl-testbed" when running an experiment
class: only-dark
width: 75%
---
```

<p align="center"><em>Log output produced by "mlrl-testbed" when running an experiment.</em></p>

```{include} README.md
---
start-after: <!-- documentation-start -->
end-before: <!-- documentation-end -->
---
```

## 📚 Documentation

This documentation provides information about the following topics:

```{toctree}
---
maxdepth: 1
---
introduction
datasets
evaluation
pre_processing
outputs
runnables
batch_mode
run_mode
read_mode
arguments
```

If you are a developer, you might also be interested in the {ref}`API reference <python-apidoc>`.