Package org.dmg.pmml.neural_network

Class NeuralNetwork

java.lang.Object

org.dmg.pmml.PMMLObject

org.dmg.pmml.Model

org.dmg.pmml.neural_network.NeuralNetwork

All Implemented Interfaces:

java.io.Serializable, HasExtensions<NeuralNetwork>, HasLocator, HasActivationFunction<NeuralNetwork>, HasNormalizationMethod<NeuralNetwork>, Visitable

public class NeuralNetwork
extends Model
implements HasExtensions<NeuralNetwork>, HasActivationFunction<NeuralNetwork>, HasNormalizationMethod<NeuralNetwork>

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NeuralNetwork.ActivationFunction
static class	NeuralNetwork.NormalizationMethod

Constructor Summary

Constructors

Constructor	Description
NeuralNetwork()
NeuralNetwork(MiningFunction miningFunction, NeuralNetwork.ActivationFunction activationFunction, MiningSchema miningSchema, NeuralInputs neuralInputs, java.util.List<NeuralLayer> neuralLayers)

Method Summary

Modifier and Type	Method	Description
VisitorAction	accept(Visitor visitor)
NeuralNetwork	addExtensions(Extension... extensions)
NeuralNetwork	addNeuralLayers(NeuralLayer... neuralLayers)
NeuralNetwork.ActivationFunction	getActivationFunction()
java.lang.String	getAlgorithmName()
java.lang.Number	getAltitude()
java.util.List<Extension>	getExtensions()
java.lang.Number	getLeakage()
LocalTransformations	getLocalTransformations()
MathContext	getMathContext()
MiningFunction	getMiningFunction()
MiningSchema	getMiningSchema()
ModelExplanation	getModelExplanation()
java.lang.String	getModelName()
ModelStats	getModelStats()
ModelVerification	getModelVerification()
NeuralInputs	getNeuralInputs()
java.util.List<NeuralLayer>	getNeuralLayers()
NeuralOutputs	getNeuralOutputs()
NeuralNetwork.NormalizationMethod	getNormalizationMethod()
java.lang.Integer	getNumberOfLayers()
Output	getOutput()
Targets	getTargets()
java.lang.Number	getThreshold()
java.lang.Number	getWidth()
boolean	hasExtensions()
boolean	hasNeuralLayers()
boolean	isScorable()
NeuralNetwork.ActivationFunction	requireActivationFunction()
MiningFunction	requireMiningFunction()
MiningSchema	requireMiningSchema()
NeuralInputs	requireNeuralInputs()
java.util.List<NeuralLayer>	requireNeuralLayers()
NeuralOutputs	requireNeuralOutputs()
NeuralNetwork	setActivationFunction(NeuralNetwork.ActivationFunction activationFunction)
NeuralNetwork	setAlgorithmName(java.lang.String algorithmName)
NeuralNetwork	setAltitude(java.lang.Number altitude)
NeuralNetwork	setLeakage(java.lang.Number leakage)
NeuralNetwork	setLocalTransformations(LocalTransformations localTransformations)
NeuralNetwork	setMathContext(MathContext mathContext)
NeuralNetwork	setMiningFunction(MiningFunction miningFunction)
NeuralNetwork	setMiningSchema(MiningSchema miningSchema)
NeuralNetwork	setModelExplanation(ModelExplanation modelExplanation)
NeuralNetwork	setModelName(java.lang.String modelName)
NeuralNetwork	setModelStats(ModelStats modelStats)
NeuralNetwork	setModelVerification(ModelVerification modelVerification)
NeuralNetwork	setNeuralInputs(NeuralInputs neuralInputs)
NeuralNetwork	setNeuralOutputs(NeuralOutputs neuralOutputs)
NeuralNetwork	setNormalizationMethod(NeuralNetwork.NormalizationMethod normalizationMethod)
NeuralNetwork	setNumberOfLayers(java.lang.Integer numberOfLayers)
NeuralNetwork	setOutput(Output output)
NeuralNetwork	setScorable(java.lang.Boolean scorable)
NeuralNetwork	setTargets(Targets targets)
NeuralNetwork	setThreshold(java.lang.Number threshold)
NeuralNetwork	setWidth(java.lang.Number width)

Methods inherited from class org.dmg.pmml.PMMLObject

getLocator, getSchemaVersion, getSchemaVersion, hasLocator, setLocator

Methods inherited from class java.lang.Object

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

Constructor Detail

NeuralNetwork

public NeuralNetwork()

NeuralNetwork

public NeuralNetwork(MiningFunction miningFunction,
                     NeuralNetwork.ActivationFunction activationFunction,
                     MiningSchema miningSchema,
                     NeuralInputs neuralInputs,
                     java.util.List<NeuralLayer> neuralLayers)

Method Detail

getModelName

public java.lang.String getModelName()

Specified by:

getModelName in class Model

setModelName

public NeuralNetwork setModelName(java.lang.String modelName)

Specified by:

setModelName in class Model

requireMiningFunction

public MiningFunction requireMiningFunction()

Specified by:

requireMiningFunction in class Model

getMiningFunction

public MiningFunction getMiningFunction()

Specified by:

getMiningFunction in class Model

setMiningFunction

public NeuralNetwork setMiningFunction(MiningFunction miningFunction)

Specified by:

setMiningFunction in class Model

getAlgorithmName

public java.lang.String getAlgorithmName()

Specified by:

getAlgorithmName in class Model

setAlgorithmName

public NeuralNetwork setAlgorithmName(java.lang.String algorithmName)

Specified by:

setAlgorithmName in class Model

requireActivationFunction

public NeuralNetwork.ActivationFunction requireActivationFunction()

getActivationFunction

public NeuralNetwork.ActivationFunction getActivationFunction()

Specified by:

getActivationFunction in interface HasActivationFunction<NeuralNetwork>

setActivationFunction

public NeuralNetwork setActivationFunction(NeuralNetwork.ActivationFunction activationFunction)

Specified by:

setActivationFunction in interface HasActivationFunction<NeuralNetwork>

getNormalizationMethod

public NeuralNetwork.NormalizationMethod getNormalizationMethod()

Specified by:

getNormalizationMethod in interface HasNormalizationMethod<NeuralNetwork>

setNormalizationMethod

public NeuralNetwork setNormalizationMethod(NeuralNetwork.NormalizationMethod normalizationMethod)

Specified by:

setNormalizationMethod in interface HasNormalizationMethod<NeuralNetwork>

getThreshold

public java.lang.Number getThreshold()

Specified by:

getThreshold in interface HasActivationFunction<NeuralNetwork>

See Also:

NeuralNetwork.ActivationFunction.THRESHOLD

setThreshold

public NeuralNetwork setThreshold(java.lang.Number threshold)

Specified by:

setThreshold in interface HasActivationFunction<NeuralNetwork>

getLeakage

public java.lang.Number getLeakage()

Specified by:

getLeakage in interface HasActivationFunction<NeuralNetwork>

See Also:

NeuralNetwork.ActivationFunction.RECTIFIER

setLeakage

public NeuralNetwork setLeakage(java.lang.Number leakage)

Specified by:

setLeakage in interface HasActivationFunction<NeuralNetwork>

getWidth

public java.lang.Number getWidth()

Specified by:

getWidth in interface HasActivationFunction<NeuralNetwork>

See Also:

NeuralNetwork.ActivationFunction.RADIAL_BASIS

setWidth

public NeuralNetwork setWidth(java.lang.Number width)

Specified by:

setWidth in interface HasActivationFunction<NeuralNetwork>

getAltitude

public java.lang.Number getAltitude()

Specified by:

getAltitude in interface HasActivationFunction<NeuralNetwork>

See Also:

NeuralNetwork.ActivationFunction.RADIAL_BASIS

setAltitude

public NeuralNetwork setAltitude(java.lang.Number altitude)

Specified by:

setAltitude in interface HasActivationFunction<NeuralNetwork>

getNumberOfLayers

public java.lang.Integer getNumberOfLayers()

setNumberOfLayers

public NeuralNetwork setNumberOfLayers(java.lang.Integer numberOfLayers)

isScorable

public boolean isScorable()

Specified by:

isScorable in class Model

setScorable

public NeuralNetwork setScorable(java.lang.Boolean scorable)

Specified by:

setScorable in class Model

getMathContext

public MathContext getMathContext()

Specified by:

getMathContext in class Model

setMathContext

public NeuralNetwork setMathContext(MathContext mathContext)

Specified by:

setMathContext in class Model

hasExtensions

public boolean hasExtensions()

Specified by:

hasExtensions in interface HasExtensions<NeuralNetwork>

getExtensions

public java.util.List<Extension> getExtensions()

Specified by:

getExtensions in interface HasExtensions<NeuralNetwork>

addExtensions

public NeuralNetwork addExtensions(Extension... extensions)

Specified by:

addExtensions in interface HasExtensions<NeuralNetwork>

requireMiningSchema

public MiningSchema requireMiningSchema()

Specified by:

requireMiningSchema in class Model

getMiningSchema

public MiningSchema getMiningSchema()

Specified by:

getMiningSchema in class Model

setMiningSchema

public NeuralNetwork setMiningSchema(MiningSchema miningSchema)

Specified by:

setMiningSchema in class Model

getOutput

public Output getOutput()

Overrides:

getOutput in class Model

setOutput

public NeuralNetwork setOutput(Output output)

Overrides:

setOutput in class Model

getModelStats

public ModelStats getModelStats()

Overrides:

getModelStats in class Model

setModelStats

public NeuralNetwork setModelStats(ModelStats modelStats)

Overrides:

setModelStats in class Model

getModelExplanation

public ModelExplanation getModelExplanation()

Overrides:

getModelExplanation in class Model

setModelExplanation

public NeuralNetwork setModelExplanation(ModelExplanation modelExplanation)

Overrides:

setModelExplanation in class Model

getTargets

public Targets getTargets()

Overrides:

getTargets in class Model

setTargets

public NeuralNetwork setTargets(Targets targets)

Overrides:

setTargets in class Model

getLocalTransformations

public LocalTransformations getLocalTransformations()

Specified by:

getLocalTransformations in class Model

setLocalTransformations

public NeuralNetwork setLocalTransformations(LocalTransformations localTransformations)

Specified by:

setLocalTransformations in class Model

requireNeuralInputs

public NeuralInputs requireNeuralInputs()

getNeuralInputs

public NeuralInputs getNeuralInputs()

setNeuralInputs

public NeuralNetwork setNeuralInputs(NeuralInputs neuralInputs)

hasNeuralLayers

public boolean hasNeuralLayers()

requireNeuralLayers

public java.util.List<NeuralLayer> requireNeuralLayers()

getNeuralLayers

public java.util.List<NeuralLayer> getNeuralLayers()

addNeuralLayers

public NeuralNetwork addNeuralLayers(NeuralLayer... neuralLayers)

requireNeuralOutputs

public NeuralOutputs requireNeuralOutputs()

getNeuralOutputs

public NeuralOutputs getNeuralOutputs()

setNeuralOutputs

public NeuralNetwork setNeuralOutputs(NeuralOutputs neuralOutputs)

getModelVerification

public ModelVerification getModelVerification()

Overrides:

getModelVerification in class Model

setModelVerification

public NeuralNetwork setModelVerification(ModelVerification modelVerification)

Overrides:

setModelVerification in class Model

accept

public VisitorAction accept(Visitor visitor)

Specified by:

accept in interface Visitable