Description

Configurations

The Patronus Experimentation Framework offers several configuration options that can be set in the following ways:

  1. In Code
  2. Environment Variables
  3. YAML Configuration File

Configuration options are prioritized in the order listed above.

Configuration Options

Config nameEnvironment Variable NameDefault Value
api_keyPATRONUS_API_KEY
api_urlPATRONUS_API_URLhttps://api.patronus.ai
ui_urlPATRONUS_UI_URLhttps://app.patronus.ai

Configuration File (patronus.yaml)

You can also provide configuration options using a patronus.yaml file. This file must be present in the working directory when executing your script.

patronus.yaml
api_key: "YOUR_API_KEY"
api_url: "https://api.patronus.ai"
ui_url: "https://app.patronus.ai"

On this page