Skip to Content
API Reference@ignitionai/coreSrcInterfacesInterface: TrainingEnv

ignition-monorepo


ignition-monorepo / core/src / TrainingEnv

Interface: TrainingEnv

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

Contract for a training environment. The developer implements this to describe their game/simulation for RL training.

Properties

actions

actions: number | string[]

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

Available actions: named list or count

Methods

observe()

observe(): number[]

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

Return the current observation as a number array

Returns

number[]


step()

step(action): void

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

Apply an action to the environment

Parameters

action

number | number[]

Returns

void


reward()

reward(): number

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

Return the reward for the current state

Returns

number


done()

done(): boolean

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

Return true if the episode is over

Returns

boolean


reset()

reset(): void

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

Reset the environment for a new episode

Returns

void

Last updated on