RLPack
 
Loading...
Searching...
No Matches
rlpack.utils.base.register.Register Class Reference

This abstract class contains all the necessary information about agents and models for setting them up. More...

+ Inheritance diagram for rlpack.utils.base.register.Register:

Public Member Functions

def __init__ (self)
 

Static Public Member Functions

def get_prefix_path ()
 Gets prefix path for rlpack package, from python installation. More...
 

Data Fields

 activation_init_args
 The activation initialization arguments when using in-built models. More...
 
 activation_map
 The mapping between given keyword and PyTorch activation function class. More...
 
 agent_args
 The mapping between given keyword and agent agents' arguments. More...
 
 agent_args_default
 The mapping between given keyword and agent agent's default arguments. More...
 
 agent_init_args
 The mandatory agent initialisation arguments. More...
 
 agents
 The mapping between given keyword and agents models. More...
 
 distributions_map
 The mapping between given keyword and PyTorch Distribution class. More...
 
 loss_function_map
 The mapping between given keyword and PyTorch loss function class. More...
 
 lr_scheduler_init_args
 The LR Scheduler initialization arguments. More...
 
 lr_scheduler_map
 The mapping between given keyword and PyTorch LR Scheduler class. More...
 
 mandatory_distributed_agents
 
 mandatory_distribution_required_agents
 
 mandatory_keys
 The tuple for mandatory keys (or keyword arguments) always expected. More...
 
 model_args
 The mapping between given keyword and in-built models' arguments. More...
 
 model_args_default
 The mapping between given keyword and in-built model's default arguments. More...
 
 model_args_to_optimize
 The mapping between keyword and agents' model arguments to wrap optimizer with. More...
 
 model_init_args
 The model initialization arguments when using in-built models. More...
 
 models
 The mapping between given keyword and in-built models. More...
 
 optimizer_init_args
 The optimizer initialization arguments for given models. More...
 
 optimizer_map
 The mapping between given keyword and PyTorch optimizer class. More...
 

Detailed Description

This abstract class contains all the necessary information about agents and models for setting them up.

Constructor & Destructor Documentation

◆ __init__()

def rlpack.utils.base.register.Register.__init__ (   self)

Member Function Documentation

◆ get_prefix_path()

def rlpack.utils.base.register.Register.get_prefix_path ( )
static

Gets prefix path for rlpack package, from python installation.

Returns
: str: The prefix path to rlpack.

Field Documentation

◆ activation_init_args

rlpack.utils.base.register.Register.activation_init_args

The activation initialization arguments when using in-built models.

◆ activation_map

rlpack.utils.base.register.Register.activation_map

The mapping between given keyword and PyTorch activation function class.

◆ agent_args

rlpack.utils.base.register.Register.agent_args

The mapping between given keyword and agent agents' arguments.

◆ agent_args_default

rlpack.utils.base.register.Register.agent_args_default

The mapping between given keyword and agent agent's default arguments.

◆ agent_init_args

rlpack.utils.base.register.Register.agent_init_args

The mandatory agent initialisation arguments.

◆ agents

rlpack.utils.base.register.Register.agents

The mapping between given keyword and agents models.

◆ distributions_map

rlpack.utils.base.register.Register.distributions_map

The mapping between given keyword and PyTorch Distribution class.

◆ loss_function_map

rlpack.utils.base.register.Register.loss_function_map

The mapping between given keyword and PyTorch loss function class.

◆ lr_scheduler_init_args

rlpack.utils.base.register.Register.lr_scheduler_init_args

The LR Scheduler initialization arguments.

◆ lr_scheduler_map

rlpack.utils.base.register.Register.lr_scheduler_map

The mapping between given keyword and PyTorch LR Scheduler class.

◆ mandatory_distributed_agents

rlpack.utils.base.register.Register.mandatory_distributed_agents

◆ mandatory_distribution_required_agents

rlpack.utils.base.register.Register.mandatory_distribution_required_agents

◆ mandatory_keys

rlpack.utils.base.register.Register.mandatory_keys

The tuple for mandatory keys (or keyword arguments) always expected.

◆ model_args

rlpack.utils.base.register.Register.model_args

The mapping between given keyword and in-built models' arguments.

◆ model_args_default

rlpack.utils.base.register.Register.model_args_default

The mapping between given keyword and in-built model's default arguments.

◆ model_args_to_optimize

rlpack.utils.base.register.Register.model_args_to_optimize

The mapping between keyword and agents' model arguments to wrap optimizer with.

◆ model_init_args

rlpack.utils.base.register.Register.model_init_args

The model initialization arguments when using in-built models.

◆ models

rlpack.utils.base.register.Register.models

The mapping between given keyword and in-built models.

◆ optimizer_init_args

rlpack.utils.base.register.Register.optimizer_init_args

The optimizer initialization arguments for given models.

◆ optimizer_map

rlpack.utils.base.register.Register.optimizer_map

The mapping between given keyword and PyTorch optimizer class.