optimize Generated TypeScript API reference. typescript api api/reference build/apidocs/Function.optimize.md function optimize

optimize

TypeScript
function optimize<IN, OUT>(
   program: Readonly<AxProgrammable<IN, OUT>>, 
   examples: readonly AxTypedExample<IN>[], 
   metricFn: 
  | AxMetricFn
  | AxMultiMetricFn, 
options: Readonly<AxOptimizeOptions>): Promise<AxParetoResult<OUT>>;

Defined in: https://github.com/ax-llm/ax/blob/686f8ba96cf652e044cf922b67c16c8f09754a70/src/ax/dsp/optimize.ts#L37

Optimize a program, measuring baselineScore and baselineScores before any bootstrap demos or component changes. Existing caller-supplied demos remain part of the baseline. Bootstrap runs need two validation passes within maxMetricCalls; runs without bootstrap reuse the seed evaluation. The implicit budget is at least 100 and fits the required validation passes. An explicit maxMetricCalls is always respected.

Type Parameters

Type Parameter
IN
OUT extends AxGenOut

Parameters

ParameterType
programReadonly<AxProgrammable<IN, OUT>>
examplesreadonly AxTypedExample<IN>[]
metricFn| AxMetricFn | AxMultiMetricFn
optionsReadonly<AxOptimizeOptions>

Returns

Promise<AxParetoResult<OUT>>

Docs