Skip to Content
API Reference@ignitionai/backend-tfjsSrcClassesClass: DQNAgent

ignition-monorepo


ignition-monorepo / backend-tfjs/src / DQNAgent

Class: DQNAgent

Defined in: backend-tfjs/src/agents/dqn.ts:12 

Implements

Constructors

Constructor

new DQNAgent(config): DQNAgent

Defined in: backend-tfjs/src/agents/dqn.ts:26 

Parameters

config

DQNConfig

Returns

DQNAgent

Methods

getAction()

getAction(state, greedy?): Promise<number>

Defined in: backend-tfjs/src/agents/dqn.ts:66 

Parameters

state

number[]

greedy?

boolean

Returns

Promise<number>

Implementation of

AgentInterface.getAction


remember()

remember(exp): void

Defined in: backend-tfjs/src/agents/dqn.ts:81 

Parameters

exp

Experience

Returns

void

Implementation of

AgentInterface.remember


updateTargetModel()

updateTargetModel(): Promise<void>

Defined in: backend-tfjs/src/agents/dqn.ts:85 

Returns

Promise<void>


train()

train(): Promise<void>

Defined in: backend-tfjs/src/agents/dqn.ts:89 

Returns

Promise<void>

Implementation of

AgentInterface.train


reset()

reset(): void

Defined in: backend-tfjs/src/agents/dqn.ts:128 

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

Returns

void

Implementation of

AgentInterface.reset


saveToHub()

saveToHub(repoId, token, modelName?, checkpointName?): Promise<void>

Defined in: backend-tfjs/src/agents/dqn.ts:134 

Parameters

repoId

string

token

string

modelName?

string = 'model'

checkpointName?

string = 'last'

Returns

Promise<void>


loadFromHub()

loadFromHub(repoId, modelPath?): Promise<void>

Defined in: backend-tfjs/src/agents/dqn.ts:139 

Parameters

repoId

string

modelPath?

string = 'model.json'

Returns

Promise<void>


saveCheckpoint()

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

Defined in: backend-tfjs/src/agents/dqn.ts:146 

Parameters

repoId

string

token

string

checkpointName

string

Returns

Promise<void>


maybeSaveBestCheckpoint()

maybeSaveBestCheckpoint(repoId, token, reward, step?): Promise<void>

Defined in: backend-tfjs/src/agents/dqn.ts:153 

Parameters

repoId

string

token

string

reward

number

step?

number

Returns

Promise<void>


loadCheckpoint()

loadCheckpoint(repoId, checkpointName): Promise<void>

Defined in: backend-tfjs/src/agents/dqn.ts:163 

Parameters

repoId

string

checkpointName

string

Returns

Promise<void>


saveModel()

saveModel(modelId, metadata?): Promise<string>

Defined in: backend-tfjs/src/agents/dqn.ts:180 

Save the model via the configured storageProvider. Throws if no storageProvider was supplied in DQNConfig.

Parameters

modelId

string

metadata?

Record<string, unknown>

Returns

Promise<string>

the URI returned by the provider (e.g. “hf://user/repo/modelId”)


loadModel()

loadModel(modelId): Promise<void>

Defined in: backend-tfjs/src/agents/dqn.ts:195 

Load a model via the configured storageProvider and replace the current model. Throws if no storageProvider was supplied in DQNConfig.

Parameters

modelId

string

Returns

Promise<void>


getState()

getState(): Record<string, unknown>

Defined in: backend-tfjs/src/agents/dqn.ts:205 

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

Returns

Record<string, unknown>

Implementation of

AgentInterface.getState


setState()

setState(state): void

Defined in: backend-tfjs/src/agents/dqn.ts:213 

Restore internal state from a serialized object.

Parameters

state

Record<string, unknown>

Returns

void

Implementation of

AgentInterface.setState


save()

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

Defined in: backend-tfjs/src/agents/dqn.ts:220 

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

Parameters

modelId

string

metadata?

Record<string, unknown>

Returns

Promise<string>

Implementation of

AgentInterface.save


load()

load(modelId): Promise<void>

Defined in: backend-tfjs/src/agents/dqn.ts:224 

Load a previously saved model and state.

Parameters

modelId

string

Returns

Promise<void>

Implementation of

AgentInterface.load


dispose()

dispose(): void

Defined in: backend-tfjs/src/agents/dqn.ts:228 

Release TF/GPU/WASM resources held by the agent

Returns

void

Implementation of

AgentInterface.dispose

Last updated on