Skip to Content
API Reference@ignitionai/coreSrcInterfacesInterface: CheckpointableAgent

ignition-monorepo


ignition-monorepo / core/src / CheckpointableAgent

Interface: CheckpointableAgent

Defined in: core/src/types.ts:81 

Extends AgentInterface with checkpoint persistence. Implement this on agents that support saving to external storage (e.g. HF Hub).

Extends

Methods

getAction()

getAction(observation, greedy?): Promise<number | number[]>

Defined in: core/src/types.ts:54 

Parameters

observation

number[]

greedy?

boolean

Returns

Promise<number | number[]>

Inherited from

AgentInterface.getAction


remember()

remember(experience): void

Defined in: core/src/types.ts:55 

Parameters

experience

Experience

Returns

void

Inherited from

AgentInterface.remember


train()

train(): Promise<void>

Defined in: core/src/types.ts:56 

Returns

Promise<void>

Inherited from

AgentInterface.train


dispose()?

optional dispose(): void

Defined in: core/src/types.ts:58 

Release TF/GPU/WASM resources held by the agent

Returns

void

Inherited from

AgentInterface.dispose


reset()?

optional reset(): void

Defined in: core/src/types.ts:60 

Reset agent internal state (epsilon, memory, counters…)

Returns

void

Inherited from

AgentInterface.reset


save()?

optional save(modelId, metadata?): Promise<string | void>

Defined in: core/src/types.ts:65 

Save the agent’s model and state. Returns URI or void.

Parameters

modelId

string

metadata?

Record<string, unknown>

Returns

Promise<string | void>

Inherited from

AgentInterface.save


load()?

optional load(modelId): Promise<void>

Defined in: core/src/types.ts:68 

Load a previously saved model and state.

Parameters

modelId

string

Returns

Promise<void>

Inherited from

AgentInterface.load


getState()?

optional getState(): Record<string, unknown>

Defined in: core/src/types.ts:71 

Serialize internal state (epsilon, stepCount, etc.) for checkpointing.

Returns

Record<string, unknown>

Inherited from

AgentInterface.getState


setState()?

optional setState(state): void

Defined in: core/src/types.ts:74 

Restore internal state from a serialized object.

Parameters

state

Record<string, unknown>

Returns

void

Inherited from

AgentInterface.setState


saveCheckpoint()

saveCheckpoint(repoId, token, checkpointName): Promise<void>

Defined in: core/src/types.ts:82 

Parameters

repoId

string

token

string

checkpointName

string

Returns

Promise<void>

Last updated on