Configuration utilities for rl-js: Reinforcement Learning in JavaScript
npm install @rl-js/configurationConfiguration utilities for rl-js: Reinforcement Learning in JavaScript.
````
npm install --save @rl-js/configuration
HyperparameterClass representing a hyperparameter with a discrete
set of possible values
HyperparameterClass representing a hyperparameter in logarithmic space
HyperparameterClass representing a Fixed hyperparameter
HyperparameterClass reperesenting a hyperparameter in linear space
Interface defining hyperparameter configuration
EnvironmentFactoryInterface for an EnvironmentFactory corresponding to an Environment
with a single continuous action and a continuous state space.
The actions should be bounded by some range.
The observation should be an array of numbers.
EnvironmentFactoryInterface for an EnvironmentFactory corresponding to an Environment
with discrete actions and a continuous state space.
The actions should be an array of strings.
The observation should be an array of numbers.
EnvironmentFactoryInterface for an EnvironmentFactory corresponding to an Environment
with discrete actions and a discrete state space.
The actions should be an array of strings.
Kind: global interface
* Hyperparameter
* .getName() ⇒ string
.defaultValue() ⇒ \
.randomValue() ⇒ \
* .discretize(steps) ⇒ array
Hyperparameter string - the name of the hyperparameter Hyperparameter \* - the default value for the hyperparameter Hyperparameter \* - a randomly chosen value for the hyperparameter Kind: instance method of Hyperparameter
Returns: array - an array of hyperparameter values
| Param | Type | Description |
| --- | --- | --- |
| steps | number | an integer number of steps to discretize the range into |
EnvironmentFactoryKind: global interface
Extends: EnvironmentFactory
* ContinuousEnvironmentFactory ⇐ EnvironmentFactory
* .getObservationCount() ⇒ number
* .getActionRange() ⇒ Array.<number>
ContinuousEnvironmentFactory number - The size of the observation array for the environment ContinuousEnvironmentFactory Array.<number> - An array whose first element represents the lower bound of the action, and the second element represents the upper bound. EnvironmentFactoryKind: global interface
Extends: EnvironmentFactory
* DiscreteEnvironmentFactory ⇐ EnvironmentFactory
* .getObservationCount() ⇒ number
* .getActions() ⇒ Array.<string>
DiscreteEnvironmentFactory number - The size of the observation array for the environment DiscreteEnvironmentFactory Array.<string> - The action set for the environment EnvironmentFactoryKind: global interface
Extends: EnvironmentFactory
* TabularEnvironmentFactory ⇐ EnvironmentFactory
* .getStates() ⇒ Array.<string>
* .getActions() ⇒ Array.<string>
TabularEnvironmentFactory Array.<string> - The state set for the environment TabularEnvironmentFactory Array.<string> - The action set for the environment * AgentBuilder
* new AgentBuilder()
* .getName() ⇒ string
* .getId() ⇒ string
* .getHyperparameterDefinitions() ⇒ object
* .buildFactory() ⇒
* .buildAgent() ⇒
* .setEnvironmentFactory(environmentFactory)
* .setHyperparameters(hyperparameters)
* .clone() ⇒
AgentBuilder string - Display name of the Agent AgentBuilder string - The unique identifier for the Agent AgentBuilder object - The hyperparameter definitions and ranges for the Agent AgentBuilder AgentBuilder Kind: instance method of AgentBuilder
| Param | Type |
| --- | --- |
| environmentFactory | EnvironmentFactory |
Kind: instance method of AgentBuilder
| Param | Type |
| --- | --- |
| hyperparameters | Hyperparameters |
Kind: instance method of AgentBuilder
Returns: AgentBuilder
* AgentSuite
* new AgentSuite()
* .getName() ⇒ string
* .getId() ⇒ string
* .listAgents() ⇒ Array.<AgentBuilder>
* .getAgentBuilder(id) ⇒ AgentBuilder
.getEnvironmentType() ⇒ \
AgentSuite string - Display name of the agent suite AgentSuite string - Unique ID of the agent suite AgentSuite Array.<AgentBuilder> - An array of AgentBuilders AgentSuite | Param | Type | Description |
| --- | --- | --- |
| id | string | The unique ID for the AgentBuilder |
Kind: instance method of AgentSuite
Returns: \* - An EnvironmentFactory type
* EnvironmentBuilder
* .getId() ⇒ string
* .getName() ⇒ string
* .buildFactory() ⇒ EnvironmentFactory
* .getHyperparameterDefinitions() ⇒ object
* .setHyperparameters(hyperparameters)
* .buildEnvironment() ⇒ Environment
EnvironmentBuilder string - The unique ID of the EnvironmentBuilder EnvironmentBuilder string - Display name of the EnvironmentBuilder EnvironmentBuilder EnvironmentFactory - Get an instance of EnvironmentFactory EnvironmentBuilder object - The hyperparameter definitions and ranges for the Environment Kind: instance method of EnvironmentBuilder
| Param | Type |
| --- | --- |
| hyperparameters | Hyperparameters |
EnvironmentBuilder Environment - Build an instance of the Environment * EnvironmentSuite
* new EnvironmentSuite()
* .getName() ⇒ string
* .getId() ⇒ string
.getType() ⇒ \
* .listEnvironments() ⇒ Array.<EnvironmentBuilder>
* .getEnvironmentBuilder(environmentName) ⇒
EnvironmentSuite string - The display name of the EnvironmentSuite EnvironmentSuite string - The unique ID of the EnvironmentSuite EnvironmentSuite \* - A subclass of EnvironmentFactory corresponding to the EnvironmentType EnvironmentSuite Array.<EnvironmentBuilder> - An array of the EnvironmentBuilders EnvironmentSuite | Param |
| --- |
| environmentName |
HyperparameterKind: global class
Extends: Hyperparameter
* Discrete ⇐ Hyperparameter
* .getName() ⇒ string
.defaultValue() ⇒ \
.randomValue() ⇒ \
* .discretize(steps) ⇒ array
Discrete getName string - the name of the hyperparameter Discrete defaultValue \* - the default value for the hyperparameter Discrete randomValue \* - a randomly chosen value for the hyperparameter Kind: instance method of Discrete
Overrides: discretize
Returns: array - an array of hyperparameter values
| Param | Type | Description |
| --- | --- | --- |
| steps | number | an integer number of steps to discretize the range into |
HyperparameterKind: global class
Extends: Hyperparameter
* Exponential ⇐ Hyperparameter
* .getName() ⇒ string
.defaultValue() ⇒ \
.randomValue() ⇒ \
* .discretize(steps) ⇒ array
Exponential getName string - the name of the hyperparameter Exponential defaultValue \* - the default value for the hyperparameter Exponential randomValue \* - a randomly chosen value for the hyperparameter Kind: instance method of Exponential
Overrides: discretize
Returns: array - an array of hyperparameter values
| Param | Type | Description |
| --- | --- | --- |
| steps | number | an integer number of steps to discretize the range into |
HyperparameterKind: global class
Extends: Hyperparameter
* Fixed ⇐ Hyperparameter
* .getName() ⇒ string
.defaultValue() ⇒ \
.randomValue() ⇒ \
* .discretize(steps) ⇒ array
Fixed getName string - the name of the hyperparameter Fixed defaultValue \* - the default value for the hyperparameter Fixed randomValue \* - a randomly chosen value for the hyperparameter Kind: instance method of Fixed
Overrides: discretize
Returns: array - an array of hyperparameter values
| Param | Type | Description |
| --- | --- | --- |
| steps | number | an integer number of steps to discretize the range into |
HyperparameterKind: global class
Extends: Hyperparameter
* Linear ⇐ Hyperparameter
* .getName() ⇒ string
.defaultValue() ⇒ \
.randomValue() ⇒ \
* .discretize(steps) ⇒ array
Linear getName string - the name of the hyperparameter Linear defaultValue \* - the default value for the hyperparameter Linear randomValue \* - a randomly chosen value for the hyperparameter Kind: instance method of Linear
Overrides: discretize
Returns: array - an array of hyperparameter values
| Param | Type | Description |
| --- | --- | --- |
| steps | number | an integer number of steps to discretize the range into |