Function evaluateExperiment

  • evaluateExperiment(
        __namedParameters: {
            client?: Client<paths, `${string}/${string}`>;
            evaluators: Evaluator[];
            experiment: RanExperiment;
            logger: Logger;
        },
    ): Promise<RanExperiment>
    Experimental

    Evaluate an experiment.

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

    Parameters

    • __namedParameters: {
          client?: Client<paths, `${string}/${string}`>;
          evaluators: Evaluator[];
          experiment: RanExperiment;
          logger: Logger;
      }
      • Optionalclient?: Client<paths, `${string}/${string}`>

        The client to use

      • evaluators: Evaluator[]

        The evaluators to use

      • experiment: RanExperiment

        The experiment to evaluate

        Todo

        also accept Experiment, and attempt to fetch the runs from the server

      • logger: Logger

        The logger to use

    Returns Promise<RanExperiment>

    Deprecated

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

Settings

Member Visibility