src.plangym.registry

src.plangym.registry#

Functionality for instantiating the environment by passing the environment id.

Functions#

get_planenv_class(name, domain_name, state)

Return the class corresponding to the environment name.

get_environment_class([name, n_workers, ray, ...])

Get the class and vectorized environment and PlangymEnv class from the make params.

make([name, n_workers, ray, domain_name, state])

Create the appropriate PlangymEnv from the environment name and other parameters.

Module Contents#

src.plangym.registry.get_planenv_class(name, domain_name, state)[source]#

Return the class corresponding to the environment name.

src.plangym.registry.get_environment_class(name=None, n_workers=None, ray=False, domain_name=None, state=None)[source]#

Get the class and vectorized environment and PlangymEnv class from the make params.

Parameters:

  • name (str | None)

  • n_workers (int | None)

  • ray (bool)

  • domain_name (str | None)

  • state (str | None)

src.plangym.registry.make(name=None, n_workers=None, ray=False, domain_name=None, state=None, **kwargs)[source]#

Create the appropriate PlangymEnv from the environment name and other parameters.

Parameters:

  • name (str | None)

  • n_workers (int | None)

  • ray (bool)

  • domain_name (str | None)

  • state (str | None)

Contents