Skip to content

Configuration

The Azimuth configuration allows defining different fields, some mandatory, that will customize Azimuth.

We grouped the fields in config scopes based on what they control. All classes inherit from one another in a chain, the last one being AzimuthConfig, which contains all fields.

To help with detecting the mandatory fields in the config, the following legend is shown throughout the reference.

  • 🔴 : Mandatory fields in the config.
  • 🟠 : Only mandatory if Azimuth is used to analyze models, and not just a dataset.
  • 🟡 : Usually mandatory fields, but default values exist that may work for some use cases.
  • 🔵 : The default values should work for most use cases.

Config Scopes

  1. Project Config 🔴
    • Mandatory fields to define the name of the project and the dataset information.
  2. Model Contract Config 🟠
    • Defines how Azimuth interacts with the models/pipelines.
  3. Common Fields Config 🔵
    • Fields that are common to many applications (batch size for example).
  4. Customize Azimuth Analyses: In these sections, different analyses in Azimuth can be configured.
    1. Behavioral Testing Config 🔵
      • Defines how the behavioral tests are generated.
    2. Similarity Analysis Config 🔵
      • Modifies the similarity analysis.
    3. Dataset Class Distribution Analysis Config 🔵
      • Configure Dataset Class Distribution Analysis.