AxOptimizerArgs Generated TypeScript API reference. typescript api api/reference build/apidocs/TypeAlias.AxOptimizerArgs.md type AxOptimizerArgs

AxOptimizerArgs

TypeScript
type AxOptimizerArgs = object;

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

Properties

checkpointInterval?

TypeScript
optional checkpointInterval: number;

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


checkpointLoad?

TypeScript
optional checkpointLoad: AxCheckpointLoadFn;

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


checkpointSave?

TypeScript
optional checkpointSave: AxCheckpointSaveFn;

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


costTracker?

TypeScript
optional costTracker: AxCostTracker;

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


dataAwareProposer?

TypeScript
optional dataAwareProposer: boolean;

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


debugOptimizer?

TypeScript
optional debugOptimizer: boolean;

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


earlyStoppingTrials?

TypeScript
optional earlyStoppingTrials: number;

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


fewshotAwareProposer?

TypeScript
optional fewshotAwareProposer: boolean;

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


initTemperature?

TypeScript
optional initTemperature: number;

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


logger?

TypeScript
optional logger: AxLoggerFunction;

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


minibatch?

TypeScript
optional minibatch: boolean;

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


minibatchFullEvalSteps?

TypeScript
optional minibatchFullEvalSteps: number;

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


minibatchSize?

TypeScript
optional minibatchSize: number;

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


minImprovementThreshold?

TypeScript
optional minImprovementThreshold: number;

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


minSuccessRate?

TypeScript
optional minSuccessRate: number;

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


numCandidates?

TypeScript
optional numCandidates: number;

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


numTrials?

TypeScript
optional numTrials: number;

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


onEarlyStop()?

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

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

Parameters

ParameterType
reasonstring
statsReadonly<AxOptimizationStats>

Returns

void


onProgress()?

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

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

Parameters

ParameterType
progressReadonly<AxOptimizationProgress>

Returns

void


optimizerLogger()?

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

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

Parameters

ParameterType
dataAxOptimizerLoggerData

Returns

void


optimizeTopP?

TypeScript
optional optimizeTopP: boolean;

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


programAwareProposer?

TypeScript
optional programAwareProposer: boolean;

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


resultPicker?

TypeScript
optional resultPicker: AxResultPickerFunction<any>;

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


resumeFromCheckpoint?

TypeScript
optional resumeFromCheckpoint: string;

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


sampleCount?

TypeScript
optional sampleCount: number;

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


seed?

TypeScript
optional seed: number;

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


studentAI

TypeScript
studentAI: AxAIService;

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


targetScore?

TypeScript
optional targetScore: number;

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


teacherAI?

TypeScript
optional teacherAI: AxAIService;

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


tipAwareProposer?

TypeScript
optional tipAwareProposer: boolean;

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


verbose?

TypeScript
optional verbose: boolean;

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


viewDataBatchSize?

TypeScript
optional viewDataBatchSize: number;

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

Docs