Builders¶

Builder Class

ExplorerBuilder¶

class nnabla_rl.builders.ExplorerBuilder[source]¶

Explorer builder interface class

build_explorer(env_info: EnvironmentInfo, algorithm_config: AlgorithmConfig, algorithm: Algorithm, **kwargs) → EnvironmentExplorer[source]¶

Build explorer.

Parameters:

env_info (EnvironmentInfo) – environment information
algorithm_config (AlgorithmConfig) – configuration class of target algorithm. Actual type differs depending on the algorithm.
algorithm (Algorithm) – target algorithm. Actual type differs depending on the algorithm.

Returns:

explorer instance.

Return type:

EnvironmentExplorer

ModelBuilder¶

class nnabla_rl.builders.ModelBuilder(*args, **kwds)[source]¶

Model builder interface class

build_model(scope_name: str, env_info: EnvironmentInfo, algorithm_config: AlgorithmConfig, **kwargs) → T[source]¶

Build model.

Parameters:

scope_name (str) – the scope name of model
env_info (EnvironmentInfo) – environment information
algorithm_config (AlgorithmConfig) – configuration class of target algorithm. Actual type differs depending on the algorithm.

Returns:

model instance. The type of the model depends on the builder’s generic type.

Return type:

T

PreprocessorBuilder¶

class nnabla_rl.builders.PreprocessorBuilder[source]¶

Preprocessor builder interface class

build_preprocessor(scope_name: str, env_info: EnvironmentInfo, algorithm_config: AlgorithmConfig, **kwargs) → Preprocessor[source]¶

Build preprocessor

Parameters:

scope_name (str) – the scope name of model
env_info (EnvironmentInfo) – environment information
algorithm_config (AlgorithmConfig) – configuration class of target algorithm. Actual type differs depending on the algorithm.

Returns:

preprocessor instance.

Return type:

Preprocessor

ReplayBufferBuilder¶

class nnabla_rl.builders.ReplayBufferBuilder[source]¶

ReplayBuffer builder interface class

build_replay_buffer(env_info: EnvironmentInfo, algorithm_config: AlgorithmConfig, **kwargs) → ReplayBuffer[source]¶

Build replay buffer

Parameters:

env_info (EnvironmentInfo) – environment information
algorithm_config (AlgorithmParam) – configuration class of the algorithm

Returns:

replay buffer instance.

Return type:

ReplayBuffer

SolverBuilder¶

class nnabla_rl.builders.SolverBuilder[source]¶

Solver builder interface class

build_solver(env_info: EnvironmentInfo, algorithm_config: AlgorithmConfig, **kwargs) → Solver[source]¶

Build solver function

Parameters:

env_info (EnvironmentInfo) – environment information
algorithm_config (AlgorithmConfig) – configuration class of the target algorithm

Returns:

solver instance.

Return type:

Solver