Skip to main content

Configuration file

Zeno options are set using a TOML file such as the following:

Example TOML configuration for an image classification task
view = "image-classification"
metadata = "./metadata.csv"
functions = "./tests/"
models = [
data_path = "./data/"
data_column = "id"
data_type = "path"

Which is used to run zeno with zeno config.toml.

Configuration options

The configuration file has the the following options.


The Zeno View used for the given data and task, e.g. image-classification. Required

See Instance views for a list of available views.


Path to a csv or parquet file with metadata for data instances. Required

Must have a column with unique identifiers for each instance, specificed by id_column.

Jupyter: A Pandas DataFrame.


Path to a directory with Python files implementing Zeno functions.

Jupyter: A list of functions with Zeno decorators.


List of models to test.

Can either be paths or strings which are passed directly to the load_model function.


The column with unique identifiers in the metadata file. Optional

By default it is id.


The column with either file names for data instances or raw data (e.g. text). Optional

By default it is id.


The column with either file names for data instances or raw data (e.g. text). Optional

By default it is label.


The directory with data instances. Optional


The directory with label files. Optional


The batch size used when running inference. Optional


Where cache outputs are stored. Optional

By default it is .zeno_cache in the same directory as the TOML file. Cache stores preprocesssing and model outputs.


Number of samples to show by default in view. Default 30. Optional


Whether to calculate metrics for each histogram's bins to color them by metric. Set to false if you have a large dataset where calculating metrics can be costly. Default True. Optional


Whether users should be able to create/delete/edit slices, folder, and reports. If set to false any changes to the frontend will not be saved in the backend. Default True. Optional


Whether Zeno should be served on localhost. If False, the FastAPI instance is returned. Useful for hosting on services such as AWS Lambda. Default True. Optional


The host to run Zeno on, should be changed to run on custom domains. Default localhost. Optional


The port to run Zeno on. Optional