AxBaseOptimizer Generated TypeScript API reference. typescript api api/reference build/apidocs/Class.AxBaseOptimizer.md class AxBaseOptimizer

AxBaseOptimizer

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/optimizer.ts#L1225

Abstract base class for optimizers that provides common functionality and standardized handling of AxOptimizerArgs

Extended by

Implements

Constructors

Constructor

TypeScript
new AxBaseOptimizer(args: Readonly<AxOptimizerArgs>): AxBaseOptimizer;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/optimizer.ts#L1267

Parameters

ParameterType
argsReadonly<AxOptimizerArgs>

Returns

AxBaseOptimizer

Methods

compile()

TypeScript
abstract compile<IN, OUT>(
   program: Readonly<AxGen<IN, OUT>>, 
   examples: readonly AxTypedExample<IN>[], 
   metricFn: AxMetricFn, 
options?: AxCompileOptions): Promise<AxOptimizerResult<OUT>>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/optimizer.ts#L1559

Abstract method that must be implemented by concrete optimizers

Type Parameters

Type Parameter
IN
OUT extends AxGenOut

Parameters

ParameterType
programReadonly<AxGen<IN, OUT>>
examplesreadonly AxTypedExample<IN>[]
metricFnAxMetricFn
options?AxCompileOptions

Returns

Promise<AxOptimizerResult<OUT>>

Implementation of

AxOptimizer.compile


compilePareto()

TypeScript
compilePareto<IN, OUT>(
   program: Readonly<AxGen<IN, OUT>>, 
   examples: readonly AxTypedExample<IN>[], 
   metricFn: AxMultiMetricFn, 
options?: AxCompileOptions): Promise<AxParetoResult<OUT>>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/optimizer.ts#L1688

Multi-objective optimization using Pareto frontier Default implementation that leverages the single-objective compile method

Type Parameters

Type Parameter
IN
OUT extends AxGenOut

Parameters

ParameterTypeDescription
programReadonly<AxGen<IN, OUT>>The program to optimize
examplesreadonly AxTypedExample<IN>[]Training examples
metricFnAxMultiMetricFnMulti-objective metric function that returns multiple scores
options?AxCompileOptionsOptional configuration options

Returns

Promise<AxParetoResult<OUT>>

Pareto optimization result with frontier of non-dominated solutions

Implementation of

AxOptimizer.compilePareto


compileStream()

TypeScript
compileStream<IN, OUT>(
   program: Readonly<AxGen<IN, OUT>>, 
   examples: readonly AxTypedExample<IN>[], 
   metricFn: AxMetricFn, 
options?: AxCompileOptions): AsyncIterableIterator<AxOptimizationProgress>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/optimizer.ts#L1574

Optimize a program with real-time streaming updates

Type Parameters

Type Parameter
IN
OUT extends AxGenOut

Parameters

ParameterTypeDescription
programReadonly<AxGen<IN, OUT>>The program to optimize
examplesreadonly AxTypedExample<IN>[]Training examples
metricFnAxMetricFnEvaluation metric function
options?AxCompileOptionsOptional configuration options

Returns

AsyncIterableIterator<AxOptimizationProgress>

Async iterator yielding optimization progress

Implementation of

AxOptimizer.compileStream


getStats()

TypeScript
getStats(): AxOptimizationStats;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/optimizer.ts#L2685

Get current optimization statistics

Returns

AxOptimizationStats

Current optimization statistics

Implementation of

AxOptimizer.getStats


reset()

TypeScript
reset(): void;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/dsp/optimizer.ts#L2798

Reset optimizer state for reuse with different programs

Returns

void

Implementation of

AxOptimizer.reset

Docs