habitat.core.registry.Registry class

Class methods

def get_dataset(name: str) -> typing.Type[dataset.Dataset]
def get_env(name: str) -> typing.Type[RLEnv]
def get_measure(name: str) -> typing.Type[embodied_task.Measure]
def get_sensor(name: str) -> typing.Type[simulator.Sensor]
def get_simulator(name: str) -> typing.Type[simulator.Simulator]
def get_task(name: str) -> typing.Type[embodied_task.EmbodiedTask]
def get_task_action(name: str) -> typing.Type[embodied_task.Action]
def register_dataset(to_register = None, *, name: typing.Optional[str] = None): Register a dataset to registry with key name
def register_env(to_register = None, *, name: typing.Optional[str] = None): Register a environment to registry with key ‘name’ currently only support subclass of RLEnv.
def register_measure(to_register = None, *, name: typing.Optional[str] = None): Register a measure to registry with key name
def register_sensor(to_register = None, *, name: typing.Optional[str] = None): Register a sensor to registry with key name
def register_simulator(to_register: None = None, *, name: typing.Optional[str] = None): Register a simulator to registry with key name
def register_task(to_register = None, *, name: typing.Optional[str] = None): Register a task to registry with key name
def register_task_action(to_register = None, *, name: typing.Optional[str] = None): Add a task action in this registry under key ‘name’

Data

mapping: typing.DefaultDict[str, typing.Any] = …

Method documentation

def habitat.core.registry.Registry.register_dataset(to_register = None, *, name: typing.Optional[str] = None) classmethod

Parameters
to_register
name	Key with which the dataset will be registered. If `None` will use the name of the class

def habitat.core.registry.Registry.register_env(to_register = None, *, name: typing.Optional[str] = None) classmethod

Args:

name: Key with which the env will be registered.: If None will use the name of the class.

def habitat.core.registry.Registry.register_measure(to_register = None, *, name: typing.Optional[str] = None) classmethod

Parameters
to_register
name	Key with which the measure will be registered. If `None` will use the name of the class

def habitat.core.registry.Registry.register_sensor(to_register = None, *, name: typing.Optional[str] = None) classmethod

Parameters
to_register
name	Key with which the sensor will be registered. If `None` will use the name of the class

def habitat.core.registry.Registry.register_simulator(to_register: None = None, *, name: typing.Optional[str] = None) classmethod

Parameters
to_register
name	Key with which the simulator will be registered. If `None` will use the name of the class

from habitat.core.registry import registry
from habitat.core.simulator import Simulator

@registry.register_simulator
class MySimulator(Simulator):
    pass


# or

@registry.register_simulator(name="MySimName")
class MySimulator(Simulator):
    pass

def habitat.core.registry.Registry.register_task(to_register = None, *, name: typing.Optional[str] = None) classmethod

Parameters
to_register
name	Key with which the task will be registered. If `None` will use the name of the class

from habitat.core.registry import registry
from habitat.core.embodied_task import EmbodiedTask

@registry.register_task
class MyTask(EmbodiedTask):
    pass


# or

@registry.register_task(name="MyTaskName")
class MyTask(EmbodiedTask):
    pass

def habitat.core.registry.Registry.register_task_action(to_register = None, *, name: typing.Optional[str] = None) classmethod

Add a task action in this registry under key ‘name’

Parameters
to_register
name	Key with which the task action will be registered. If `None` will use the name of the task action’s method.