Interface ExperimentOptions

interface ExperimentOptions {
    config?: Record<string, JSONType>;
    dataset: Dataset;
    description?: string;
    evaluators?: Record<string, ExperimentEvaluator> | ExperimentEvaluator[];
    name: string;
    projectName?: string;
    runs?: number;
    summaryEvaluators?:
        | Record<string, ExperimentSummaryEvaluator>
        | ExperimentSummaryEvaluator[];
    tags?: Record<string, string>;
    task: ExperimentTask;
}

Index

Properties

config? dataset description? evaluators? name projectName? runs? summaryEvaluators? tags? task

Properties

`Optional`config

config?: Record<string, JSONType>

dataset

dataset: Dataset

`Optional`description

description?: string

`Optional`evaluators

evaluators?: Record<string, ExperimentEvaluator> | ExperimentEvaluator[]

Evaluators keyed by metric label, or named functions or class instances.

name

name: string

`Optional`projectName

projectName?: string

Override the configured project for this experiment.

`Optional`runs

runs?: number

Number of full experiment runs to execute. Default 1.

`Optional`summaryEvaluators

summaryEvaluators?:
| Record<string, ExperimentSummaryEvaluator>
| ExperimentSummaryEvaluator[]

Summary evaluators keyed by metric label, or named functions or class instances.

`Optional`tags

tags?: Record<string, string>

task

task: ExperimentTask