AxOptimizer

Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/optimizer.ts#L974

Type Parameters

Type Parameter	Default type
`IN`	`any`
`OUT` extends `AxGenOut`	`any`

Methods

cancel()?

optional cancel(): Promise<void>;

Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/optimizer.ts#L1024

Cancel ongoing optimization gracefully

Returns

Promise<void>

Promise that resolves when cancellation is complete

compile()

compile(
   program: Readonly<AxGen<IN, OUT>>, 
   metricFn: AxMetricFn, 
options?: AxCompileOptions): Promise<AxOptimizerResult<OUT>>;

Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/optimizer.ts#L982

Optimize a program using the provided metric function

Parameters

Parameter	Type	Description
`program`	`Readonly`<`AxGen`<`IN`, `OUT`>>	The program to optimize (moved from constructor)
`metricFn`	`AxMetricFn`	Evaluation metric function to assess program performance
`options?`	`AxCompileOptions`	Optional configuration options that can override constructor settings

Returns

Promise<AxOptimizerResult<OUT>>

Optimization result containing demos, stats, and configuration

compilePareto()?

optional compilePareto(
   program: Readonly<AxGen<IN, OUT>>, 
   metricFn: AxMultiMetricFn, 
options?: AxCompileOptions): Promise<AxParetoResult<OUT>>;

Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/optimizer.ts#L1008

Multi-objective optimization using Pareto frontier

Parameters

Parameter	Type	Description
`program`	`Readonly`<`AxGen`<`IN`, `OUT`>>	The program to optimize
`metricFn`	`AxMultiMetricFn`	Multi-objective metric function
`options?`	`AxCompileOptions`	Optional configuration options

Returns

Promise<AxParetoResult<OUT>>

Pareto optimization result

compileStream()?

optional compileStream(
   program: Readonly<AxGen<IN, OUT>>, 
   metricFn: AxMetricFn, 
options?: AxCompileOptions): AsyncIterableIterator<AxOptimizationProgress>;

Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/optimizer.ts#L995

Optimize a program with real-time streaming updates

Parameters

Parameter	Type	Description
`program`	`Readonly`<`AxGen`<`IN`, `OUT`>>	The program to optimize
`metricFn`	`AxMetricFn`	Evaluation metric function
`options?`	`AxCompileOptions`	Optional configuration options

Returns

AsyncIterableIterator<AxOptimizationProgress>

Async iterator yielding optimization progress

getConfiguration()?

optional getConfiguration(): Record<string, unknown>;

Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/optimizer.ts#L1035

Get optimizer-specific configuration

Returns

Record<string, unknown>

Current optimizer configuration

getStats()

getStats(): AxOptimizationStats;

Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/optimizer.ts#L1018

Get current optimization statistics

Returns

AxOptimizationStats

Current optimization statistics

reset()?

optional reset(): void;

Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/optimizer.ts#L1029

Reset optimizer state for reuse with different programs

Returns

void

updateConfiguration()?

optional updateConfiguration(config: Readonly<Record<string, unknown>>): void;

Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/optimizer.ts#L1041

Update optimizer configuration

Parameters

Parameter	Type	Description
`config`	`Readonly`<`Record`<`string`, `unknown`>>	New configuration to merge with existing

Returns

void

validateProgram()?

optional validateProgram(program: Readonly<AxGen<IN, OUT>>): object;

Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/optimizer.ts#L1048

Validate that the optimizer can handle the given program

Parameters

Parameter	Type	Description
`program`	`Readonly`<`AxGen`<`IN`, `OUT`>>	Program to validate

Returns

object

Validation result with any issues found

Name	Type
`issues`	`string`[]
`isValid`	`boolean`
`suggestions`	`string`[]