burlap.behavior.singleagent.learning

Class LearningAgent.LearningAgentBookKeeping

java.lang.Object

burlap.behavior.singleagent.learning.LearningAgent.LearningAgentBookKeeping

Enclosing interface:

LearningAgent

public static class LearningAgent.LearningAgentBookKeeping
extends java.lang.Object

Because LearningAgent is an interface, default methods for managing the history of experienced episodes is not provided. Therefore, this class provides the requisite data members and default methods for making that bookkeeping easy. This allows a class that implements the LearningAgent interface to simply have a data member for this class and allow it to manage the methods. All data members of this class are public. By default the history of learning episodes stored will be just 1. This method also includes a data member maxEpisodeSize which can be optionally used for setting the longest time a learning agent will run when the LearningAgent.runLearningEpisodeFrom(burlap.oomdp.core.State) method is called. By default, it is INT MAX. The class also has a method for automatically adding an episode to its history, will removing the oldest stored episode if the the size of the history is larger than the max history size.

Field Summary

Fields

Modifier and Type	Field and Description
java.util.LinkedList<EpisodeAnalysis>	episodeHistory The history of learning episodes
int	maxEpisodeSize
int	numEpisodesToStore

Constructor Summary

Constructors

Constructor and Description
LearningAgent.LearningAgentBookKeeping()

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<EpisodeAnalysis>	getAllStoredLearningEpisodes() Returns all saved EpisodeAnalysis objects of which the agent has kept track.
EpisodeAnalysis	getLastLearningEpisode() Returns the last learning episode of the agent.
void	offerEpisodeToHistory(EpisodeAnalysis ea) Adds episode ea to this objects history of experienced episodes.
void	setNumEpisodesToStore(int numEps) Tells the agent how many EpisodeAnalysis objects representing learning episodes to internally store.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

episodeHistory

public java.util.LinkedList<EpisodeAnalysis> episodeHistory

The history of learning episodes

numEpisodesToStore

public int numEpisodesToStore

maxEpisodeSize

public int maxEpisodeSize

Constructor Detail

LearningAgent.LearningAgentBookKeeping

public LearningAgent.LearningAgentBookKeeping()

Method Detail

getLastLearningEpisode

public EpisodeAnalysis getLastLearningEpisode()

Returns the last learning episode of the agent.

Returns:

the last learning episode of the agent.

setNumEpisodesToStore

public void setNumEpisodesToStore(int numEps)

Tells the agent how many EpisodeAnalysis objects representing learning episodes to internally store. For instance, if the number of set to 5, then the agent should remember the save the last 5 learning episodes. Note that this number has nothing to do with how learning is performed; it is purely for performance gathering.

Parameters:

numEps - the number of learning episodes to remember.

getAllStoredLearningEpisodes

public java.util.List<EpisodeAnalysis> getAllStoredLearningEpisodes()

Returns all saved EpisodeAnalysis objects of which the agent has kept track.

Returns:

all saved EpisodeAnalysis objects of which the agent has kept track.

offerEpisodeToHistory

public void offerEpisodeToHistory(EpisodeAnalysis ea)

Adds episode ea to this objects history of experienced episodes. If the current size of all episodes stored is equal to the number of episodes this object is supposed to store, it first removes the oldest episodes added before adding ea.

Parameters:

ea - the episode to add to the history of experienced episodes.