ignition-monorepo / core/src / IgnitionEnv

Class: IgnitionEnv

Defined in: core/src/ignition-env.ts:5

Constructors

Constructor

new IgnitionEnv(env): IgnitionEnv

Defined in: core/src/ignition-env.ts:22

Parameters

env

TrainingEnv

Returns

IgnitionEnv

Properties

stepCount

stepCount: number = 0

Defined in: core/src/ignition-env.ts:10

stepIntervalMs

stepIntervalMs: number = 50

Defined in: core/src/ignition-env.ts:13

Milliseconds between steps. Lower = faster training. Default 50ms (20 steps/sec).

stepsPerTick

stepsPerTick: number = 1

Defined in: core/src/ignition-env.ts:16

Number of steps to run per tick. >1 = batch multiple steps before yielding to the event loop.

factories

protected factories: Record<string, AgentFactory> = {}

Defined in: core/src/ignition-env.ts:18

algorithmDefaults

protected algorithmDefaults: Record<string, Record<string, unknown>> = {}

Defined in: core/src/ignition-env.ts:19

Accessors

agent

Get Signature

get agent(): AgentInterface | null

Defined in: core/src/ignition-env.ts:28

Returns

AgentInterface | null

Set Signature

set agent(value): void

Defined in: core/src/ignition-env.ts:32

Parameters

value

AgentInterface | null

Returns

void

Methods

train()

train(algorithm?, overrides?): void

Defined in: core/src/ignition-env.ts:36

Parameters

algorithm?

AlgorithmType

overrides?

Record<string, unknown>

Returns

void

step()

step(): Promise<StepResult>

Defined in: core/src/ignition-env.ts:71

Returns

Promise<StepResult>

inferStep()

inferStep(): Promise<StepResult>

Defined in: core/src/ignition-env.ts:109

Returns

Promise<StepResult>

infer()

infer(): void

Defined in: core/src/ignition-env.ts:135

Returns

void

start()

start(): void

Defined in: core/src/ignition-env.ts:155

Returns

void

stop()

stop(): void

Defined in: core/src/ignition-env.ts:171

Returns

void

reset()

reset(): void

Defined in: core/src/ignition-env.ts:175

Returns

void

setSpeed()

setSpeed(multiplier): void

Defined in: core/src/ignition-env.ts:184

Set training speed. Multiplier: 1x = normal (50ms, 1 step/tick), 10x = fast, 50x = turbo.

Parameters

multiplier

number

Returns

void

save()

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

Defined in: core/src/ignition-env.ts:204

Save the current agent model + training state. Requires the agent to implement save().

Parameters

modelId

string

metadata?

Record<string, unknown>

Returns

Promise<string | void>

load()

load(modelId): Promise<void>

Defined in: core/src/ignition-env.ts:221

Load a previously saved agent model + training state. Requires the agent to implement load().

Parameters

modelId

string

Returns

Promise<void>