habitat.core.registry.Registry class

Contents

Class methods

def get_action_space_configuration(name)
def get_dataset(name)
def get_measure(name)
def get_sensor(name)
def get_simulator(name)
def get_task(name)
def get_task_action(name)
def register_action_space_configuration(to_register = None, *, name: typing.Optional[str] = None)
Register a action space configuration to registry with key name
def register_dataset(to_register = None, *, name: typing.Optional[str] = None)
Register a dataset to registry with key name
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, *, 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 = …

Method documentation

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

Register a action space configuration to registry with key name

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

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

Register a dataset to registry with key name

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_measure(to_register = None, *, name: typing.Optional[str] = None) classmethod

Register a measure to registry with key name

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

Register a sensor to registry with key name

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, *, name: typing.Optional[str] = None) classmethod

Register a simulator to registry with key name

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

Register a task to registry with key name

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.