[docs]class Agent(object):
"""This is an interface for the agent class.
Every agent should sub-class this class.
The entrypoint for this class is the move() function.
"""
def __init__(self, **kwargs):
self.set_memory(None)
[docs] def move(self, state):
"""
Main entry point for the agent class, agent logic goes here.
This function is called by the game runner when it's this
agent's turn to make a move.
:param state: the current game state.
:returns: a valid move.
"""
raise NotImplementedError()
[docs] def observe(self, state):
"""
This function is called by the game engine every time an update to
the game state is available. (Even on other player's turns.)
:param state: the current game state.
"""
pass
[docs] def get_memory(self, default=None):
"""
This function can be used by an agent to get its persistent memory.
This function is also used by site runner to get the agent's memory
at the end of a game and store it in the database.
:param default: if the agent memory is not set, return the default value (None).
:returns: the persistent memory of the agent.
"""
return default if self._data is None else self._data
[docs] def set_memory(self, data):
"""
Set the persistent memory of the agent.
This function should be called by the agent if the persistent memory
needs to be updated.
This function is also called by the site runner at the start of a game.
:param data: the data to save.
"""
self._data = data