Interface ScoringFunction

ScoringFunction specifies a method of scoring a Scenario.

interface ScoringFunction {
    name: string;
    scorer:
        | AstGrepScoringFunction
        | BashScriptScoringFunction
        | CommandScoringFunction
        | CustomScoringFunction
        | PythonScriptScoringFunction
        | ScoringFunction.TestBasedScoringFunction;
    weight: number;
}

Index

Properties

name scorer weight

Properties

name

name: string

Name of scoring function. Names must only contain [a-zA-Z0-9_-].

scorer

scorer:
    | AstGrepScoringFunction
    | BashScriptScoringFunction
    | CommandScoringFunction
    | CustomScoringFunction
    | PythonScriptScoringFunction
    | ScoringFunction.TestBasedScoringFunction

The scoring function to use for evaluating this scenario. The type field determines which built-in function to use.

weight

weight: number

Weight to apply to scoring function score. Weights of all scoring functions should sum to 1.0.