org.deeplearning4j.optimize.listeners

Class CollectScoresIterationListener

java.lang.Object

org.deeplearning4j.optimize.listeners.CollectScoresIterationListener

All Implemented Interfaces:

Serializable, IterationListener

public class CollectScoresIterationListener
extends Object
implements IterationListener

CollectScoresIterationListener simply stores the model scores internally (along with the iteration) every 1 or N iterations (this is configurable). These scores can then be obtained or exported.

Author:

Alex Black

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CollectScoresIterationListener() Constructor for collecting scores with default saving frequency of 1
CollectScoresIterationListener(int frequency) Constructor for collecting scores with the specified frequency.

Method Summary

Modifier and Type	Method and Description
void	exportScores(File file) Export the scores to the specified file in delimited (one per line) UTF-8 format, tab delimited
void	exportScores(File file, String delimiter) Export the scores to the specified file in delimited (one per line) UTF-8 format, using the specified delimiter
void	exportScores(OutputStream outputStream) Export the scores in tab-delimited (one per line) UTF-8 format.
void	exportScores(OutputStream outputStream, String delimiter) Export the scores in delimited (one per line) UTF-8 format with the specified delimiter
List<org.nd4j.linalg.primitives.Pair<Integer,Double>>	getScoreVsIter()
void	invoke() Change invoke to true
boolean	invoked() Get if listener invoked
void	iterationDone(Model model, int iteration) Event listener for each iteration

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectScoresIterationListener

public CollectScoresIterationListener()

Constructor for collecting scores with default saving frequency of 1

CollectScoresIterationListener

public CollectScoresIterationListener(int frequency)

Constructor for collecting scores with the specified frequency.

Parameters:

frequency - Frequency with which to collect/save scores

Method Detail

invoked

public boolean invoked()

Description copied from interface: IterationListener

Get if listener invoked

Specified by:

invoked in interface IterationListener

invoke

public void invoke()

Description copied from interface: IterationListener

Change invoke to true

Specified by:

invoke in interface IterationListener

iterationDone

public void iterationDone(Model model,
                          int iteration)

Description copied from interface: IterationListener

Event listener for each iteration

Specified by:

iterationDone in interface IterationListener

Parameters:

model - the model iterating

iteration - the iteration

getScoreVsIter

public List<org.nd4j.linalg.primitives.Pair<Integer,Double>> getScoreVsIter()

exportScores

public void exportScores(OutputStream outputStream)
                  throws IOException

Export the scores in tab-delimited (one per line) UTF-8 format.

Throws:

IOException

exportScores

public void exportScores(OutputStream outputStream,
                         String delimiter)
                  throws IOException

Export the scores in delimited (one per line) UTF-8 format with the specified delimiter

Parameters:

outputStream - Stream to write to

delimiter - Delimiter to use

Throws:

IOException

exportScores

public void exportScores(File file)
                  throws IOException

Export the scores to the specified file in delimited (one per line) UTF-8 format, tab delimited

Parameters:

file - File to write to

Throws:

IOException

exportScores

public void exportScores(File file,
                         String delimiter)
                  throws IOException

Export the scores to the specified file in delimited (one per line) UTF-8 format, using the specified delimiter

Parameters:

file - File to write to

delimiter - Delimiter to use for writing scores

Throws:

IOException