The
ax experiments commands are currently in BETA. The API may change without notice. A one-time warning is emitted on first use. The ax experiments export command is in ALPHA. The ax experiments list-runs command is in ALPHA.ax experiments commands let you create, retrieve, and manage experiments on the Arize platform.
ax experiments list
List all experiments, optionally filtered by dataset.
Example:
ax experiments create
Create a new experiment from a local file. Pass --dataset to attach the experiment to a dataset, or --space to create a standalone experiment that has none — one of the two is required. The file must contain an output column, plus an example_id column when attaching to a dataset. Extra columns are passed through as additional fields.
Examples:
ax experiments get
Retrieve an experiment by name or ID.
Examples:
ax experiments run
Run an experiment task against a dataset and upload results. The task file must define a top-level task function that accepts a dataset example and returns the task output.
Task file format:
--dry-run to validate locally before uploading.
Examples:
ax experiments delete
Delete an experiment.
Examples:
ax experiments export
Export runs from an experiment to a JSON file.
Examples:
ax experiments annotate-runs
Annotate a batch of runs in an experiment. Provide annotations via --file (JSON, JSONL, CSV, or Parquet; use - for stdin). Each record must have a record_id (the experiment run ID) and values (a list of annotation dicts with at least name, plus optionally score, label, or text). Annotations are upserted; up to 1000 runs may be annotated per request.
Examples:
ax experiments list-runs
List runs for an experiment (paginated table view). For bulk export of all runs, use ax experiments export instead.
Examples: