refine_plan.models.semi_mdp
===========================

.. py:module:: refine_plan.models.semi_mdp

.. autoapi-nested-parse::

   Class for semi-MDP based on options.

   Author: Charlie Street
   Owner: Charlie Street



Classes
-------

.. autoapisummary::

   refine_plan.models.semi_mdp.SemiMDP


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

.. py:class:: SemiMDP(sf_list, option_list, labels, initial_state=None)

   Bases: :py:obj:`object`


   Class for semi-MDPs where actions=options.

   .. attribute:: _state_factors

      A dictionary from state factor name to state factor

   .. attribute:: _options

      A dictionary from option name to options

   .. attribute:: _labels

      A list of Labels

   .. attribute:: _initial_state

      A deterministic initial state (if there is one)


   .. py:method:: get_state_factors()

      Return the state factor dictionary.

      :returns: A dictionary from state factor name to state factor



   .. py:method:: get_det_initial_state()

      Return the deterministic initial state, if there is one.

      :returns: The initial state if there is one, None otherwise



   .. py:method:: get_labels()

      Return the list of labels.

      :returns: The list of labels



   .. py:method:: get_transition_prob(state, option, next_state)

      Get the transition probability for executing an option in a state.

      :param state: The current state
      :param option: The name of the option (action) being executed
      :param next_state: The successor state

      :returns: The semi-MDP transition probability

      :raises invalid_opt_exception: Raised if an invalid option is passed in



   .. py:method:: get_reward(state, option)

      Get the reward for executing an option in a state.

      :param state: The current state
      :param option: The name of the option (action) being executed

      :returns: The reward for that option in the semi-MDP

      :raises invalid_opt_exception: Raised if an invalid option is passed in



   .. py:method:: to_prism_string(output_file=None)

      Convert the semi-MDP into a PRISM model.

      Because of the objectives we are handling this is written as an MDP.

      :param output_file: Optional. A file path to write the PRISM string to.

      :returns: The PRISM string