AxProgram
Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/dsp/program.ts#L18
Extended by
Type Parameters
Type Parameter |
---|
IN |
OUT |
Implements
Constructors
Constructor
new AxProgram<IN, OUT>(signature:
| undefined
| Readonly<
| string
| AxSignature<Record<string, any>, Record<string, any>>
| AxSignatureConfig>, options?: Readonly<AxProgramOptions>): AxProgram<IN, OUT>;
Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/dsp/program.ts#L32
Parameters
Parameter | Type |
---|---|
signature | | undefined | Readonly < | string | AxSignature <Record <string , any >, Record <string , any >> | AxSignatureConfig > |
options? | Readonly <AxProgramOptions > |
Returns
AxProgram
<IN
, OUT
>
Methods
applyOptimization()
applyOptimization(optimizedProgram: AxOptimizedProgram<OUT>): void;
Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/dsp/program.ts#L213
Apply optimized configuration to this program
Parameters
Parameter | Type | Description |
---|---|---|
optimizedProgram | AxOptimizedProgram <OUT > | The optimized program configuration to apply |
Returns
void
Implementation of
getSignature()
getSignature(): AxSignature;
Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/dsp/program.ts#L56
Returns
getTraces()
getTraces(): AxProgramTrace<IN, OUT>[];
Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/dsp/program.ts#L154
Returns
AxProgramTrace
<IN
, OUT
>[]
Implementation of
getUsage()
getUsage(): AxModelUsage & object[];
Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/dsp/program.ts#L168
Returns
AxModelUsage
& object
[]
Implementation of
register()
register(prog: Readonly<AxTunable<IN, OUT> & AxUsable>): void;
Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/dsp/program.ts#L84
Parameters
Parameter | Type |
---|---|
prog | Readonly <AxTunable <IN , OUT > & AxUsable > |
Returns
void
resetUsage()
resetUsage(): void;
Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/dsp/program.ts#L178
Returns
void
Implementation of
setDemos()
setDemos(demos: readonly AxProgramDemos<IN, OUT>[]): void;
Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/dsp/program.ts#L185
Parameters
Parameter | Type |
---|---|
demos | readonly AxProgramDemos <IN , OUT >[] |
Returns
void
Implementation of
setDescription()
setDescription(description: string): void;
Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/dsp/program.ts#L74
Parameters
Parameter | Type |
---|---|
description | string |
Returns
void
setExamples()
setExamples(examples: Readonly<AxProgramExamples<IN, OUT>>, options?: Readonly<AxSetExamplesOptions>): void;
Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/dsp/program.ts#L104
Parameters
Parameter | Type |
---|---|
examples | Readonly <AxProgramExamples <IN , OUT >> |
options? | Readonly <AxSetExamplesOptions > |
Returns
void
Implementation of
setId()
setId(id: string): void;
Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/dsp/program.ts#L91
Parameters
Parameter | Type |
---|---|
id | string |
Returns
void
Implementation of
setParentId()
setParentId(parentId: string): void;
Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/dsp/program.ts#L98
Parameters
Parameter | Type |
---|---|
parentId | string |
Returns
void
Implementation of
setSignature()
setSignature(signature:
| undefined
| Readonly<
| string
| AxSignature<Record<string, any>, Record<string, any>>
| AxSignatureConfig>): void;
Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/dsp/program.ts#L60
Parameters
Parameter | Type |
---|---|
signature | | undefined | Readonly < | string | AxSignature <Record <string , any >, Record <string , any >> | AxSignatureConfig > |
Returns
void