from malib.utils.typing import Dict, Callable, Union
[docs]class Registry:
"""Global registry of algorithms, models, preprocessors and environments
Examples:
>>> # register custom model
>>> Registry.register_custom_model("MyCustomModel", model_class)
>>> # register custom policy
>>> Registry.register_custom_policy("MyCustomPolicy", policy_class)
>>> # register custom environment
>>> Registry.register_custom_env("MyCustomEnvironment", environment_class)
>>> # register custom algorithm
>>> Registry.register_custom_algorithm(
... name="MyCustomAlgo",
... policy="registered_policy_name_or_cls",
... trainer="registered_trainer_name_or_cls",
... loss="registered_loss_name_or_cls")
>>>
"""
[docs] @staticmethod
def register_custom_algorithm(
name: str,
policy: Union[type, str],
trainer: Union[type, str],
loss: Union[type, str] = None,
) -> None:
"""Register a custom algorithm by name.
:param name: str, Name to register the algorithm under.
:param policy: Union[type, str], Python class or registered name of policy.
:param trainer: Union[type, str], Python class or registered name of trainer.
:param loss: Union[type, str], Python class or registered name of loss function.
:return:
"""
# _global_registry.register(ALGORITHM, name, policy, trainer, loss)
pass
[docs] @staticmethod
def register_custom_model(name: str, model_class: type) -> None:
"""Register a custom model by name.
:param name: str, Name to register the model under.
:param model_class: type, Python class of the model.
:return:
"""
# _global_registry.register(MODEL, name, model_class)
pass
[docs] @staticmethod
def register_custom_policy(name: str, policy_class: type) -> None:
"""Register a custom policy by name.
:param name: str, Name to register the policy under.
:param policy_class: type, Python class of the policy.
"""
pass
[docs] @staticmethod
def register_custom_env(name: str, env_class: type) -> None:
"""Register a custom environment by name.
:param name: str, Name to register the environment under.
:param env_class: type, Python class of the environment.
"""
pass