org.jpmml.manager

Class NeuralNetworkManager

java.lang.Object

org.jpmml.manager.PMMLManager

org.jpmml.manager.ModelManager<NeuralNetwork>

org.jpmml.manager.NeuralNetworkManager

All Implemented Interfaces:

Serializable, Consumer, HasEntityRegistry<Entity>

public class NeuralNetworkManager
extends ModelManager<NeuralNetwork>
implements HasEntityRegistry<Entity>

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NeuralNetworkManager()
NeuralNetworkManager(PMML pmml)
NeuralNetworkManager(PMML pmml, NeuralNetwork neuralNetwork)

Method Summary

Methods

Modifier and Type	Method and Description
static void	addConnection(NeuralInput from, Neuron to, double weight)
static void	addConnection(Neuron from, Neuron to, double weight)
NeuralInput	addNeuralInput(String id, NormContinuous normContinuous)
NeuralLayer	addNeuralLayer()
NeuralOutput	addNeuralOutput(Neuron neuron, NormContinuous normCountinuous)
static Neuron	addNeuron(NeuralLayer neuralLayer, String id, Double bias)
NeuralNetwork	createModel(MiningFunctionType miningFunction, ActivationFunctionType activationFunction)
com.google.common.collect.BiMap<String,Entity>	getEntityRegistry() Takes the snapshot of all known (ie.
NeuralNetwork	getModel()
List<NeuralInput>	getNeuralInputs()
List<NeuralLayer>	getNeuralLayers()
List<NeuralOutput>	getOrCreateNeuralOutputs()
String	getSummary() Returns a short description of the underlying Model

Methods inherited from class org.jpmml.manager.ModelManager

addField, addMiningField, getActiveFields, getGroupFields, getMiningField, getMiningFields, getMiningSchema, getOrCreateLocalTransformations, getOrCreateOutput, getOrCreateTargets, getOutputField, getOutputFields, getPredictedFields, getTarget, getTargetField, resolveField

Methods inherited from class org.jpmml.manager.PMMLManager

addDataField, find, find, findAll, getDataDictionary, getDataField, getHeader, getModel, getModelManager, getModelManager, getModels, getOrCreateTransformationDictionary, getPmml, resolveFunction

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jpmml.manager.Consumer

getDataField

Constructor Detail

NeuralNetworkManager

public NeuralNetworkManager()

NeuralNetworkManager

public NeuralNetworkManager(PMML pmml)

NeuralNetworkManager

public NeuralNetworkManager(PMML pmml,
                    NeuralNetwork neuralNetwork)

Method Detail

getSummary

public String getSummary()

Description copied from interface: Consumer

Returns a short description of the underlying Model

Specified by:

getSummary in interface Consumer

getModel

public NeuralNetwork getModel()

Specified by:

getModel in class ModelManager<NeuralNetwork>

createModel

public NeuralNetwork createModel(MiningFunctionType miningFunction,
                        ActivationFunctionType activationFunction)

See Also:

getModel()

getNeuralInputs

public List<NeuralInput> getNeuralInputs()

addNeuralInput

public NeuralInput addNeuralInput(String id,
                         NormContinuous normContinuous)

Parameters:

id - Unique identifier

See Also:

getEntityRegistry()

getNeuralLayers

public List<NeuralLayer> getNeuralLayers()

addNeuralLayer

public NeuralLayer addNeuralLayer()

getEntityRegistry

public com.google.common.collect.BiMap<String,Entity> getEntityRegistry()

Description copied from interface: HasEntityRegistry

Takes the snapshot of all known (ie. registered with the class model) Entity instances.

Specified by:

getEntityRegistry in interface HasEntityRegistry<Entity>

Returns:

A bidirectional map between Entity identifiers and Entity instances.

addNeuron

public static Neuron addNeuron(NeuralLayer neuralLayer,
               String id,
               Double bias)

Parameters:

id - Unique identifier

See Also:

getEntityRegistry()

addConnection

public static void addConnection(NeuralInput from,
                 Neuron to,
                 double weight)

addConnection

public static void addConnection(Neuron from,
                 Neuron to,
                 double weight)

getOrCreateNeuralOutputs

public List<NeuralOutput> getOrCreateNeuralOutputs()

addNeuralOutput

public NeuralOutput addNeuralOutput(Neuron neuron,
                           NormContinuous normCountinuous)