org.deeplearning4j.optimize.api

Enum InvocationType

java.lang.Object

java.lang.Enum<InvocationType>

org.deeplearning4j.optimize.api.InvocationType

All Implemented Interfaces:

Serializable, Comparable<InvocationType>

public enum InvocationType
extends Enum<InvocationType>

This enum holds options for TrainingListener invocation scheme

Author:

[email protected]

Enum Constant Summary

Enum Constants

Enum Constant and Description
EPOCH_END Iterator will be called on end of epoch
EPOCH_START Iterator will be called on start of epoch.
ITERATION_END Iterator will be called on iteration end

Method Summary

Modifier and Type	Method and Description
static InvocationType	valueOf(String name) Returns the enum constant of this type with the specified name.
static InvocationType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

EPOCH_START

public static final InvocationType EPOCH_START

Iterator will be called on start of epoch. PLEASE NOTE: This option makes sense only for pretrained models.

EPOCH_END

public static final InvocationType EPOCH_END

Iterator will be called on end of epoch

ITERATION_END

public static final InvocationType ITERATION_END

Iterator will be called on iteration end

Method Detail

values

public static InvocationType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (InvocationType c : InvocationType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static InvocationType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null