Skip to Content
API Reference@ignitionai/environmentsSrcClassesClass: CartPoleEnv

ignition-monorepo


ignition-monorepo / environments/src / CartPoleEnv

Class: CartPoleEnv

Defined in: environments/src/cartpole.ts:23 

Implements

  • TrainingEnv

Constructors

Constructor

new CartPoleEnv(): CartPoleEnv

Defined in: environments/src/cartpole.ts:27 

Returns

CartPoleEnv

Properties

actions

actions: string[]

Defined in: environments/src/cartpole.ts:24 

Available actions: named list or count

Implementation of

TrainingEnv.actions


state

state: CartPoleState

Defined in: environments/src/cartpole.ts:25 

Methods

observe()

observe(): number[]

Defined in: environments/src/cartpole.ts:41 

Return the current observation as a number array

Returns

number[]

Implementation of

TrainingEnv.observe


step()

step(action): void

Defined in: environments/src/cartpole.ts:45 

Apply an action to the environment

Parameters

action

number | number[]

Returns

void

Implementation of

TrainingEnv.step


reward()

reward(): number

Defined in: environments/src/cartpole.ts:67 

Return the reward for the current state

Returns

number

Implementation of

TrainingEnv.reward


done()

done(): boolean

Defined in: environments/src/cartpole.ts:71 

Return true if the episode is over

Returns

boolean

Implementation of

TrainingEnv.done


reset()

reset(): void

Defined in: environments/src/cartpole.ts:79 

Reset the environment for a new episode

Returns

void

Implementation of

TrainingEnv.reset

Last updated on