AxOptimizerArgs

TypeScript

type AxOptimizerArgs = object;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/common_types.ts#L120

Properties

checkpointInterval?

TypeScript

optional checkpointInterval: number;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/common_types.ts#L154

checkpointLoad?

TypeScript

optional checkpointLoad: AxCheckpointLoadFn;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/common_types.ts#L153

checkpointSave?

TypeScript

optional checkpointSave: AxCheckpointSaveFn;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/common_types.ts#L152

costTracker?

TypeScript

optional costTracker: AxCostTracker;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/common_types.ts#L151

dataAwareProposer?

TypeScript

optional dataAwareProposer: boolean;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/common_types.ts#L137

debugOptimizer?

TypeScript

optional debugOptimizer: boolean;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/common_types.ts#L159

earlyStoppingTrials?

TypeScript

optional earlyStoppingTrials: number;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/common_types.ts#L141

fewshotAwareProposer?

TypeScript

optional fewshotAwareProposer: boolean;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/common_types.ts#L140

initTemperature?

TypeScript

optional initTemperature: number;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/common_types.ts#L131

logger?

TypeScript

optional logger: AxLoggerFunction;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/common_types.ts#L156

minibatch?

TypeScript

optional minibatch: boolean;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/common_types.ts#L133

minibatchFullEvalSteps?

TypeScript

optional minibatchFullEvalSteps: number;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/common_types.ts#L135

minibatchSize?

TypeScript

optional minibatchSize: number;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/common_types.ts#L134

minImprovementThreshold?

TypeScript

optional minImprovementThreshold: number;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/common_types.ts#L142

minSuccessRate?

TypeScript

optional minSuccessRate: number;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/common_types.ts#L147

numCandidates?

TypeScript

optional numCandidates: number;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/common_types.ts#L130

numTrials?

TypeScript

optional numTrials: number;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/common_types.ts#L132

onEarlyStop()?

TypeScript

optional onEarlyStop: (reason: string, stats: Readonly<AxOptimizationStats>) => void;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/common_types.ts#L150

Parameters

Parameter	Type
`reason`	`string`
`stats`	`Readonly`<`AxOptimizationStats`>

Returns

void

onProgress()?

TypeScript

optional onProgress: (progress: Readonly<AxOptimizationProgress>) => void;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/common_types.ts#L149

Parameters

Parameter	Type
`progress`	`Readonly`<`AxOptimizationProgress`>

Returns

void

optimizerLogger()?

TypeScript

optional optimizerLogger: (data: AxOptimizerLoggerData) => void;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/common_types.ts#L160

Parameters

Parameter	Type
`data`	`AxOptimizerLoggerData`

Returns

void

optimizeTopP?

TypeScript

optional optimizeTopP: boolean;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/common_types.ts#L146

programAwareProposer?

TypeScript

optional programAwareProposer: boolean;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/common_types.ts#L136

resultPicker?

TypeScript

optional resultPicker: AxResultPickerFunction<any>;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/common_types.ts#L145

resumeFromCheckpoint?

TypeScript

optional resumeFromCheckpoint: string;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/common_types.ts#L155

sampleCount?

TypeScript

optional sampleCount: number;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/common_types.ts#L143

seed?

TypeScript

optional seed: number;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/common_types.ts#L158

studentAI

TypeScript

studentAI: AxAIService;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/common_types.ts#L121

targetScore?

TypeScript

optional targetScore: number;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/common_types.ts#L148

teacherAI?

TypeScript

optional teacherAI: AxAIService;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/common_types.ts#L122

teacherOptions?

TypeScript

optional teacherOptions: AxAIServiceOptions;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/common_types.ts#L129

AI service options for the optimizer’s teacher calls: GEPA feedback and proposals, the ACE reflector and curator, and BootstrapFewShot demo runs. They also apply when those calls fall back to studentAI. Set useExpensiveModel: 'yes' to use a teacher model marked isExpensive.

tipAwareProposer?

TypeScript

optional tipAwareProposer: boolean;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/common_types.ts#L139

verbose?

TypeScript

optional verbose: boolean;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/common_types.ts#L157

viewDataBatchSize?

TypeScript

optional viewDataBatchSize: number;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/dsp/common_types.ts#L138