qgym.templates.state module

Generic abstract base class for States of RL environments.

All states should inherit from State.

class qgym.templates.state.State[source]

Bases: Generic[ObservationT, ActionT]

RL State containing the current state of the problem.

abstract create_observation_space()[source]

Create the corresponding observation space.

abstract is_done()[source]

Boolean value stating whether we are in a final state.

is_truncated()[source]

Boolean value stating whether the episode is truncated.

abstract obtain_info()[source]

Optional debugging info for the current state.

abstract obtain_observation()[source]

Observation based on the current state.

abstract reset(*, seed=None, **_kwargs)[source]

Reset the state.

property rng: Generator

Return the random number generator of this environment. If none is set yet, this will generate a new one using numpy.random.default_rng.

seed(seed=None)[source]

Seed the rng of this space, using numpy.random.default_rng.

Parameters:: seed (int | None) – Seed for the rng. Defaults to None
Return type:: list[int | None]
Returns:: The used seeds.

abstract update_state(action)[source]

Update the state of this Environment using the given action.