Module `pacai.core.environment`

Expand source code

import abc

class Environment(abc.ABC):
    @abc.abstractmethod
    def getCurrentState(self):
        """
        Returns the current state of enviornment.
        """

        pass

    @abc.abstractmethod
    def getPossibleActions(self, state):
        """
        Returns possible actions the agent can take in the given state.
        Can return the empty list if we are in a terminal state.
        """

        pass

    @abc.abstractmethod
    def doAction(self, action):
        """
        Performs the given action in the current
        environment state and updates the enviornment.

        Returns a (reward, nextState) pair.
        """

        pass

    @abc.abstractmethod
    def reset(self):
        """
        Resets the current state to the start state.
        """

        pass

    def isTerminal(self):
        """
        Has the enviornment entered a terminal state?
        This means there are no successors.
        """

        state = self.getCurrentState()
        actions = self.getPossibleActions(state)

        return len(actions) == 0

Classes

class Environment (*args, **kwargs)

Helper class that provides a standard way to create an ABC using inheritance.

Expand source code

class Environment(abc.ABC):
    @abc.abstractmethod
    def getCurrentState(self):
        """
        Returns the current state of enviornment.
        """

        pass

    @abc.abstractmethod
    def getPossibleActions(self, state):
        """
        Returns possible actions the agent can take in the given state.
        Can return the empty list if we are in a terminal state.
        """

        pass

    @abc.abstractmethod
    def doAction(self, action):
        """
        Performs the given action in the current
        environment state and updates the enviornment.

        Returns a (reward, nextState) pair.
        """

        pass

    @abc.abstractmethod
    def reset(self):
        """
        Resets the current state to the start state.
        """

        pass

    def isTerminal(self):
        """
        Has the enviornment entered a terminal state?
        This means there are no successors.
        """

        state = self.getCurrentState()
        actions = self.getPossibleActions(state)

        return len(actions) == 0

Ancestors

abc.ABC

Subclasses

Methods

def doAction(self, action)

Performs the given action in the current environment state and updates the enviornment.

Returns a (reward, nextState) pair.

Expand source code

@abc.abstractmethod
def doAction(self, action):
    """
    Performs the given action in the current
    environment state and updates the enviornment.

    Returns a (reward, nextState) pair.
    """

    pass

def getCurrentState(self)

Returns the current state of enviornment.

Expand source code

@abc.abstractmethod
def getCurrentState(self):
    """
    Returns the current state of enviornment.
    """

    pass

def getPossibleActions(self, state)

Returns possible actions the agent can take in the given state. Can return the empty list if we are in a terminal state.

Expand source code

@abc.abstractmethod
def getPossibleActions(self, state):
    """
    Returns possible actions the agent can take in the given state.
    Can return the empty list if we are in a terminal state.
    """

    pass

def isTerminal(self)

Has the enviornment entered a terminal state? This means there are no successors.

Expand source code

def isTerminal(self):
    """
    Has the enviornment entered a terminal state?
    This means there are no successors.
    """

    state = self.getCurrentState()
    actions = self.getPossibleActions(state)

    return len(actions) == 0

def reset(self)

Resets the current state to the start state.

Expand source code

@abc.abstractmethod
def reset(self):
    """
    Resets the current state to the start state.
    """

    pass