Documentation Github NPM Package

Class

Environment

(abstract) Environment()

The Environment Interface

Constructor

# abstract new Environment()

View Source core/src/RLInterface/Environment.ts, line 7

Methods

# abstract actionSpace() → {Array}

The action space

View Source core/src/RLInterface/Environment.ts, line 35

Array

# abstract encodeStateToIndices(state) → {Array.<number>}

encode the state into an number array

Parameters:
Name Type Description
state object

the state to encode

View Source core/src/RLInterface/Environment.ts, line 123

an numbers array

Array.<number>

# abstract init(optionsnullable, initialStatenullable) → {void}

initialize the environment

Parameters:
Name Type Attributes Description
options EnvOptions <nullable>

the environment options
initialState object <nullable>

the optional initial state of the environment

View Source core/src/RLInterface/Environment.ts, line 92

void

# abstract isTerminal() → {boolean}

Whether the enviroment state is terminal

View Source core/src/RLInterface/Environment.ts, line 51

boolean

# abstract iteration() → {number}

The current iteration

View Source core/src/RLInterface/Environment.ts, line 67

number

# abstract name() → {string}

The enviromnet name

View Source core/src/RLInterface/Environment.ts, line 83

string

# abstract options() → {EnvOptions|undefined}

The current options

View Source core/src/RLInterface/Environment.ts, line 59

EnvOptions | undefined

# abstract reset() → {boolean}

The reset the environment

View Source core/src/RLInterface/Environment.ts, line 107

boolean

# abstract resetStats() → {boolean}

reset the stats accumulated over the life time of the environment

View Source core/src/RLInterface/Environment.ts, line 130

True if the reset was sucessfull

boolean

# abstract setOptions(optionsnullable) → {void}

Set the environment options

Parameters:
Name Type Attributes Description
options EnvOptions <nullable>

View Source core/src/RLInterface/Environment.ts, line 115

void

# abstract state() → {object}

The state

View Source core/src/RLInterface/Environment.ts, line 43

object

# abstract stateDim() → {Array}

The state dimension

View Source core/src/RLInterface/Environment.ts, line 27

Array

# abstract stats() → {object}

The current environment stats

View Source core/src/RLInterface/Environment.ts, line 75

object

# abstract step(action) → {StepResult}

take an action in the environment

Parameters:
Name Type Description
action string

the action to take

View Source core/src/RLInterface/Environment.ts, line 100

the result of the taken action

StepResult