AxMiPRO
Abstract base class for optimizers that provides common functionality and standardized handling of AxOptimizerArgs
Extends
AxBaseOptimizer
<IN
,OUT
>
Type Parameters
Type Parameter | Default type |
---|---|
IN extends AxGenIn | AxGenIn |
OUT extends AxGenOut | AxGenOut |
Constructors
Constructor
new AxMiPRO<IN, OUT>(args: Readonly<AxOptimizerArgs>): AxMiPRO<IN, OUT>;
Parameters
Parameter | Type |
---|---|
args | Readonly <AxOptimizerArgs > |
Returns
AxMiPRO
<IN
, OUT
>
Overrides
Methods
compile()
compile(
program: Readonly<AxGen<IN, OUT>>,
metricFn: AxMetricFn,
options?: AxCompileOptions): Promise<AxMiPROResult<IN, OUT>>;
The main compile method to run MIPROv2 optimization
Parameters
Parameter | Type |
---|---|
program | Readonly <AxGen <IN , OUT >> |
metricFn | AxMetricFn |
options? | AxCompileOptions |
Returns
Promise
<AxMiPROResult
<IN
, OUT
>>
Overrides
compilePareto()
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#L1579
Multi-objective optimization using Pareto frontier Default implementation that leverages the single-objective compile method
Parameters
Parameter | Type | Description |
---|---|---|
program | Readonly <AxGen <IN , OUT >> | The program to optimize |
metricFn | AxMultiMetricFn | Multi-objective metric function that returns multiple scores |
options? | AxCompileOptions | Optional configuration options |
Returns
Promise
<AxParetoResult
<OUT
>>
Pareto optimization result with frontier of non-dominated solutions
Inherited from
compileStream()
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#L1468
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
Inherited from
configureAuto()
configureAuto(level: "medium" | "light" | "heavy"): void;
Configures the optimizer for light, medium, or heavy optimization
Parameters
Parameter | Type | Description |
---|---|---|
level | "medium" | "light" | "heavy" | The optimization level: “light”, “medium”, or “heavy” |
Returns
void
getConfiguration()
getConfiguration(): Record<string, unknown>;
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#L2492
Get current optimization statistics
Returns
Current optimization statistics
Inherited from
reset()
reset(): void;
Reset optimizer state for reuse with different programs
Returns
void
Overrides
updateConfiguration()
updateConfiguration(config: Readonly<Record<string, unknown>>): void;
Update optimizer configuration
Parameters
Parameter | Type | Description |
---|---|---|
config | Readonly <Record <string , unknown >> | New configuration to merge with existing |
Returns
void
validateProgram()
validateProgram(_program: Readonly<AxGen<IN, OUT>>): object;
Validate that the optimizer can handle the given program
Parameters
Parameter | Type |
---|---|
_program | Readonly <AxGen <IN , OUT >> |
Returns
object
Validation result with any issues found
Name | Type |
---|---|
issues | string [] |
isValid | boolean |
suggestions | string [] |