habitat.core.environments.GymRegistryEnv class

A registered environment that wraps a gym environment to be used with habitat-baselines

Class methods

def class_name()

Methods

def close(self)
def render(self, mode = 'human', **kwargs)
def reset(self, **kwargs)
def seed(self, seed = None)
def step(self, action: ActType) -> typing.Tuple[ObsType, float, bool, dict]

Special methods

def __class_getitem__(...): Parameterizes a generic class.
def __enter__(self): Support with-statement for the environment.
def __exit__(self, *args): Support with-statement for the environment.
def __format__(self, format_spec, /): Default object formatter.
def __getattr__(self, name)
def __init__(self, config: DictConfig, dataset: typing.Optional[dataset.Dataset] = None)
def __init_subclass__(...): Function to initialize subclasses.
def __repr__(self)
def __str__(self)

Properties

action_space get set
metadata: dict get set
np_random: gym.utils.seeding.RandomNumberGenerator get set: Initializes the np_random field if not done already.
observation_space: gym.spaces.space.Space get set
reward_range get set
spec get
unwrapped: gym.core.Env get

Method documentation

def habitat.core.environments.GymRegistryEnv.__class_getitem__(...)

Parameterizes a generic class.

At least, parameterizing a generic class is the main thing this method does. For example, for some generic class Foo, this is called when we do Foo[int] - there, with cls=Foo and params=int.

However, note that this method is also called when defining generic classes in the first place with class Foo[T]: ….

def habitat.core.environments.GymRegistryEnv.format(self, format_spec, /)

Default object formatter.

Return str(self) if format_spec is empty. Raise TypeError otherwise.