popgym.core.observability
=========================

.. py:module:: popgym.core.observability


Attributes
----------

.. autoapisummary::

   popgym.core.observability.OBS
   popgym.core.observability.STATE


Classes
-------

.. autoapisummary::

   popgym.core.observability.Observability


Module Contents
---------------

.. py:data:: OBS
   :value: 'obs'


.. py:data:: STATE
   :value: 'state'


.. py:class:: Observability

   Bases: :py:obj:`enum.IntEnum`


   Defines the observability level of the environment.

   To be used with popgym.wrappers.ObservabilityWrapper.

   - PARTIAL: Partial observation, the Markov state is not returned.
   - FULL_IN_INFO_DICT: Partial observation, the Markov state is provided
       by the info dict.
   - FULL: The Markov state is used as observation.
   - FULL_AND_PARTIAL: The observation is a dict {"obs": obs, "state": state}.


   .. py:attribute:: PARTIAL
      :value: 0



   .. py:attribute:: FULL_IN_INFO_DICT
      :value: 1



   .. py:attribute:: FULL
      :value: 2



   .. py:attribute:: FULL_AND_PARTIAL
      :value: 3