Type Alias RunExperimentParamsExperimental

RunExperimentParams: ClientFn & {
    dataset: Dataset | string | Example[];
    evaluators?: Evaluator[];
    experimentName?: string;
    logger?: Logger;
    projectName?: string;
    record?: boolean;
    repetitions?: number;
    task: ExperimentTask;
}

Parameters for running an experiment.

This feature is not complete, and will change in the future.

Type declaration

  • dataset: Dataset | string | Example[]

    The dataset to run the experiment on

  • Optionalevaluators?: Evaluator[]

    The evaluators to use

  • OptionalexperimentName?: string

    An optional name for the experiment. Defaults to the dataset name + a timestamp

  • Optionallogger?: Logger

    The logger to use

  • OptionalprojectName?: string

    The project under which the experiment task traces are recorded

  • Optionalrecord?: boolean

    Whether to record the experiment results

  • Optionalrepetitions?: number

    The number of repetitions to run

  • task: ExperimentTask

    The task to run

Deprecated

This function will be un-marked as deprecated once the experimental feature flag is removed.

Settings

Member Visibility