org.dmg.pmml

Class NeuralNetwork

java.lang.Object

org.dmg.pmml.PMMLObject

org.dmg.pmml.Model

org.dmg.pmml.NeuralNetwork

All Implemented Interfaces:

java.io.Serializable, HasExtensions, HasLocator, Visitable

public class NeuralNetwork
extends Model
implements HasExtensions

Java class for anonymous complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType>
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{http://www.dmg.org/PMML-4_2}Extension" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_2}MiningSchema"/>
         <element ref="{http://www.dmg.org/PMML-4_2}Output" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_2}ModelStats" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_2}ModelExplanation" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_2}Targets" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_2}LocalTransformations" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_2}NeuralInputs"/>
         <element ref="{http://www.dmg.org/PMML-4_2}NeuralLayer" maxOccurs="unbounded"/>
         <element ref="{http://www.dmg.org/PMML-4_2}NeuralOutputs" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_2}ModelVerification" minOccurs="0"/>
       </sequence>
       <attribute name="modelName" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="functionName" use="required" type="{http://www.dmg.org/PMML-4_2}MINING-FUNCTION" />
       <attribute name="algorithmName" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="activationFunction" use="required" type="{http://www.dmg.org/PMML-4_2}ACTIVATION-FUNCTION" />
       <attribute name="normalizationMethod" type="{http://www.dmg.org/PMML-4_2}NN-NORMALIZATION-METHOD" default="none" />
       <attribute name="threshold" type="{http://www.dmg.org/PMML-4_2}REAL-NUMBER" default="0" />
       <attribute name="width" type="{http://www.dmg.org/PMML-4_2}REAL-NUMBER" />
       <attribute name="altitude" type="{http://www.dmg.org/PMML-4_2}REAL-NUMBER" default="1.0" />
       <attribute name="numberOfLayers" type="{http://www.w3.org/2001/XMLSchema}nonNegativeInteger" />
       <attribute name="isScorable" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
     </restriction>
   </complexContent>
 </complexType>
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected ActivationFunctionType	activationFunction
protected java.lang.String	algorithmName
protected java.lang.Double	altitude
protected java.util.List<Extension>	extensions
protected MiningFunctionType	functionName
protected LocalTransformations	localTransformations
protected MiningSchema	miningSchema
protected ModelExplanation	modelExplanation
protected java.lang.String	modelName
protected ModelStats	modelStats
protected ModelVerification	modelVerification
protected NeuralInputs	neuralInputs
protected java.util.List<NeuralLayer>	neuralLayers
protected NeuralOutputs	neuralOutputs
protected NnNormalizationMethodType	normalizationMethod
protected java.lang.Integer	numberOfLayers
protected Output	output
protected java.lang.Boolean	scorable
protected Targets	targets
protected java.lang.Double	threshold
protected java.lang.Double	width

Constructor Summary

Constructors

Constructor and Description
NeuralNetwork()
NeuralNetwork(MiningFunctionType functionName, ActivationFunctionType activationFunction, MiningSchema miningSchema, NeuralInputs neuralInputs, java.util.List<NeuralLayer> neuralLayers)

Method Summary

Methods

Modifier and Type	Method and Description
VisitorAction	accept(Visitor visitor)
ActivationFunctionType	getActivationFunction() Gets the value of the activationFunction property.
java.lang.String	getAlgorithmName() Gets the value of the algorithmName property.
double	getAltitude() Gets the value of the altitude property.
java.util.List<Extension>	getExtensions() Gets the value of the extensions property.
MiningFunctionType	getFunctionName() Gets the value of the functionName property.
LocalTransformations	getLocalTransformations() Gets the value of the localTransformations property.
MiningSchema	getMiningSchema() Gets the value of the miningSchema property.
ModelExplanation	getModelExplanation() Gets the value of the modelExplanation property.
java.lang.String	getModelName() Gets the value of the modelName property.
ModelStats	getModelStats() Gets the value of the modelStats property.
ModelVerification	getModelVerification() Gets the value of the modelVerification property.
NeuralInputs	getNeuralInputs() Gets the value of the neuralInputs property.
java.util.List<NeuralLayer>	getNeuralLayers() Gets the value of the neuralLayers property.
NeuralOutputs	getNeuralOutputs() Gets the value of the neuralOutputs property.
NnNormalizationMethodType	getNormalizationMethod() Gets the value of the normalizationMethod property.
java.lang.Integer	getNumberOfLayers() Gets the value of the numberOfLayers property.
Output	getOutput() Gets the value of the output property.
Targets	getTargets() Gets the value of the targets property.
double	getThreshold() Gets the value of the threshold property.
java.lang.Double	getWidth() Gets the value of the width property.
boolean	hasExtensions()
boolean	hasNeuralLayers()
boolean	isScorable() Gets the value of the scorable property.
void	setActivationFunction(ActivationFunctionType value) Sets the value of the activationFunction property.
void	setAlgorithmName(java.lang.String value) Sets the value of the algorithmName property.
void	setAltitude(java.lang.Double value) Sets the value of the altitude property.
void	setFunctionName(MiningFunctionType value) Sets the value of the functionName property.
void	setLocalTransformations(LocalTransformations value) Sets the value of the localTransformations property.
void	setMiningSchema(MiningSchema value) Sets the value of the miningSchema property.
void	setModelExplanation(ModelExplanation value) Sets the value of the modelExplanation property.
void	setModelName(java.lang.String value) Sets the value of the modelName property.
void	setModelStats(ModelStats value) Sets the value of the modelStats property.
void	setModelVerification(ModelVerification value) Sets the value of the modelVerification property.
void	setNeuralInputs(NeuralInputs value) Sets the value of the neuralInputs property.
void	setNeuralOutputs(NeuralOutputs value) Sets the value of the neuralOutputs property.
void	setNormalizationMethod(NnNormalizationMethodType value) Sets the value of the normalizationMethod property.
void	setNumberOfLayers(java.lang.Integer value) Sets the value of the numberOfLayers property.
void	setOutput(Output value) Sets the value of the output property.
void	setScorable(java.lang.Boolean value) Sets the value of the scorable property.
void	setTargets(Targets value) Sets the value of the targets property.
void	setThreshold(java.lang.Double value) Sets the value of the threshold property.
void	setWidth(java.lang.Double value) Sets the value of the width property.
NeuralNetwork	withActivationFunction(ActivationFunctionType value)
NeuralNetwork	withAlgorithmName(java.lang.String value)
NeuralNetwork	withAltitude(java.lang.Double value)
NeuralNetwork	withExtensions(java.util.Collection<Extension> values)
NeuralNetwork	withExtensions(Extension... values)
NeuralNetwork	withFunctionName(MiningFunctionType value)
NeuralNetwork	withLocalTransformations(LocalTransformations value)
NeuralNetwork	withMiningSchema(MiningSchema value)
NeuralNetwork	withModelExplanation(ModelExplanation value)
NeuralNetwork	withModelName(java.lang.String value)
NeuralNetwork	withModelStats(ModelStats value)
NeuralNetwork	withModelVerification(ModelVerification value)
NeuralNetwork	withNeuralInputs(NeuralInputs value)
NeuralNetwork	withNeuralLayers(java.util.Collection<NeuralLayer> values)
NeuralNetwork	withNeuralLayers(NeuralLayer... values)
NeuralNetwork	withNeuralOutputs(NeuralOutputs value)
NeuralNetwork	withNormalizationMethod(NnNormalizationMethodType value)
NeuralNetwork	withNumberOfLayers(java.lang.Integer value)
NeuralNetwork	withOutput(Output value)
NeuralNetwork	withScorable(java.lang.Boolean value)
NeuralNetwork	withTargets(Targets value)
NeuralNetwork	withThreshold(java.lang.Double value)
NeuralNetwork	withWidth(java.lang.Double value)

Methods inherited from class org.dmg.pmml.PMMLObject

getLocator, setLocator

Methods inherited from class java.lang.Object

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

Field Detail

modelName

protected java.lang.String modelName

functionName

protected MiningFunctionType functionName

algorithmName

protected java.lang.String algorithmName

activationFunction

protected ActivationFunctionType activationFunction

normalizationMethod

protected NnNormalizationMethodType normalizationMethod

threshold

protected java.lang.Double threshold

width

protected java.lang.Double width

altitude

protected java.lang.Double altitude

numberOfLayers

protected java.lang.Integer numberOfLayers

scorable

protected java.lang.Boolean scorable

extensions

protected java.util.List<Extension> extensions

miningSchema

protected MiningSchema miningSchema

output

protected Output output

modelStats

protected ModelStats modelStats

modelExplanation

protected ModelExplanation modelExplanation

targets

protected Targets targets

localTransformations

protected LocalTransformations localTransformations

neuralInputs

protected NeuralInputs neuralInputs

neuralLayers

protected java.util.List<NeuralLayer> neuralLayers

neuralOutputs

protected NeuralOutputs neuralOutputs

modelVerification

protected ModelVerification modelVerification

Constructor Detail

NeuralNetwork

public NeuralNetwork()

NeuralNetwork

public NeuralNetwork(MiningFunctionType functionName,
             ActivationFunctionType activationFunction,
             MiningSchema miningSchema,
             NeuralInputs neuralInputs,
             java.util.List<NeuralLayer> neuralLayers)

Method Detail

getModelName

public java.lang.String getModelName()

Gets the value of the modelName property.

Specified by:

getModelName in class Model

Returns:

possible object is String

setModelName

public void setModelName(java.lang.String value)

Sets the value of the modelName property.

Specified by:

setModelName in class Model

Parameters:

value - allowed object is String

getFunctionName

public MiningFunctionType getFunctionName()

Gets the value of the functionName property.

Specified by:

getFunctionName in class Model

Returns:

possible object is MiningFunctionType

setFunctionName

public void setFunctionName(MiningFunctionType value)

Sets the value of the functionName property.

Specified by:

setFunctionName in class Model

Parameters:

value - allowed object is MiningFunctionType

getAlgorithmName

public java.lang.String getAlgorithmName()

Gets the value of the algorithmName property.

Specified by:

getAlgorithmName in class Model

Returns:

possible object is String

setAlgorithmName

public void setAlgorithmName(java.lang.String value)

Sets the value of the algorithmName property.

Specified by:

setAlgorithmName in class Model

Parameters:

value - allowed object is String

getActivationFunction

public ActivationFunctionType getActivationFunction()

Gets the value of the activationFunction property.

Returns:

possible object is ActivationFunctionType

setActivationFunction

public void setActivationFunction(ActivationFunctionType value)

Sets the value of the activationFunction property.

Parameters:

value - allowed object is ActivationFunctionType

getNormalizationMethod

public NnNormalizationMethodType getNormalizationMethod()

Gets the value of the normalizationMethod property.

Returns:

possible object is NnNormalizationMethodType

setNormalizationMethod

public void setNormalizationMethod(NnNormalizationMethodType value)

Sets the value of the normalizationMethod property.

Parameters:

value - allowed object is NnNormalizationMethodType

getThreshold

public double getThreshold()

Gets the value of the threshold property.

Returns:

possible object is Double

setThreshold

public void setThreshold(java.lang.Double value)

Sets the value of the threshold property.

Parameters:

value - allowed object is Double

getWidth

public java.lang.Double getWidth()

Gets the value of the width property.

Returns:

possible object is Double

setWidth

public void setWidth(java.lang.Double value)

Sets the value of the width property.

Parameters:

value - allowed object is Double

getAltitude

public double getAltitude()

Gets the value of the altitude property.

Returns:

possible object is Double

setAltitude

public void setAltitude(java.lang.Double value)

Sets the value of the altitude property.

Parameters:

value - allowed object is Double

getNumberOfLayers

public java.lang.Integer getNumberOfLayers()

Gets the value of the numberOfLayers property.

Returns:

possible object is String

setNumberOfLayers

public void setNumberOfLayers(java.lang.Integer value)

Sets the value of the numberOfLayers property.

Parameters:

value - allowed object is String

isScorable

public boolean isScorable()

Gets the value of the scorable property.

Specified by:

isScorable in class Model

Returns:

possible object is Boolean

setScorable

public void setScorable(java.lang.Boolean value)

Sets the value of the scorable property.

Specified by:

setScorable in class Model

Parameters:

value - allowed object is Boolean

getExtensions

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

Gets the value of the extensions property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the extensions property.

For example, to add a new item, do as follows:

    getExtensions().add(newItem);
 

Objects of the following type(s) are allowed in the list Extension

Specified by:

getExtensions in interface HasExtensions

getMiningSchema

public MiningSchema getMiningSchema()

Gets the value of the miningSchema property.

Specified by:

getMiningSchema in class Model

Returns:

possible object is MiningSchema

setMiningSchema

public void setMiningSchema(MiningSchema value)

Sets the value of the miningSchema property.

Specified by:

setMiningSchema in class Model

Parameters:

value - allowed object is MiningSchema

getOutput

public Output getOutput()

Gets the value of the output property.

Specified by:

getOutput in class Model

Returns:

possible object is Output

setOutput

public void setOutput(Output value)

Sets the value of the output property.

Specified by:

setOutput in class Model

Parameters:

value - allowed object is Output

getModelStats

public ModelStats getModelStats()

Gets the value of the modelStats property.

Specified by:

getModelStats in class Model

Returns:

possible object is ModelStats

setModelStats

public void setModelStats(ModelStats value)

Sets the value of the modelStats property.

Specified by:

setModelStats in class Model

Parameters:

value - allowed object is ModelStats

getModelExplanation

public ModelExplanation getModelExplanation()

Gets the value of the modelExplanation property.

Specified by:

getModelExplanation in class Model

Returns:

possible object is ModelExplanation

setModelExplanation

public void setModelExplanation(ModelExplanation value)

Sets the value of the modelExplanation property.

Specified by:

setModelExplanation in class Model

Parameters:

value - allowed object is ModelExplanation

getTargets

public Targets getTargets()

Gets the value of the targets property.

Specified by:

getTargets in class Model

Returns:

possible object is Targets

setTargets

public void setTargets(Targets value)

Sets the value of the targets property.

Specified by:

setTargets in class Model

Parameters:

value - allowed object is Targets

getLocalTransformations

public LocalTransformations getLocalTransformations()

Gets the value of the localTransformations property.

Specified by:

getLocalTransformations in class Model

Returns:

possible object is LocalTransformations

setLocalTransformations

public void setLocalTransformations(LocalTransformations value)

Sets the value of the localTransformations property.

Specified by:

setLocalTransformations in class Model

Parameters:

value - allowed object is LocalTransformations

getNeuralInputs

public NeuralInputs getNeuralInputs()

Gets the value of the neuralInputs property.

Returns:

possible object is NeuralInputs

setNeuralInputs

public void setNeuralInputs(NeuralInputs value)

Sets the value of the neuralInputs property.

Parameters:

value - allowed object is NeuralInputs

getNeuralLayers

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

Gets the value of the neuralLayers property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the neuralLayers property.

For example, to add a new item, do as follows:

    getNeuralLayers().add(newItem);
 

Objects of the following type(s) are allowed in the list NeuralLayer

getNeuralOutputs

public NeuralOutputs getNeuralOutputs()

Gets the value of the neuralOutputs property.

Returns:

possible object is NeuralOutputs

setNeuralOutputs

public void setNeuralOutputs(NeuralOutputs value)

Sets the value of the neuralOutputs property.

Parameters:

value - allowed object is NeuralOutputs

getModelVerification

public ModelVerification getModelVerification()

Gets the value of the modelVerification property.

Specified by:

getModelVerification in class Model

Returns:

possible object is ModelVerification

setModelVerification

public void setModelVerification(ModelVerification value)

Sets the value of the modelVerification property.

Specified by:

setModelVerification in class Model

Parameters:

value - allowed object is ModelVerification

withModelName

public NeuralNetwork withModelName(java.lang.String value)

withFunctionName

public NeuralNetwork withFunctionName(MiningFunctionType value)

withAlgorithmName

public NeuralNetwork withAlgorithmName(java.lang.String value)

withActivationFunction

public NeuralNetwork withActivationFunction(ActivationFunctionType value)

withNormalizationMethod

public NeuralNetwork withNormalizationMethod(NnNormalizationMethodType value)

withThreshold

public NeuralNetwork withThreshold(java.lang.Double value)

withWidth

public NeuralNetwork withWidth(java.lang.Double value)

withAltitude

public NeuralNetwork withAltitude(java.lang.Double value)

withNumberOfLayers

public NeuralNetwork withNumberOfLayers(java.lang.Integer value)

withScorable

public NeuralNetwork withScorable(java.lang.Boolean value)

withExtensions

public NeuralNetwork withExtensions(Extension... values)

withExtensions

public NeuralNetwork withExtensions(java.util.Collection<Extension> values)

withMiningSchema

public NeuralNetwork withMiningSchema(MiningSchema value)

withOutput

public NeuralNetwork withOutput(Output value)

withModelStats

public NeuralNetwork withModelStats(ModelStats value)

withModelExplanation

public NeuralNetwork withModelExplanation(ModelExplanation value)

withTargets

public NeuralNetwork withTargets(Targets value)

withLocalTransformations

public NeuralNetwork withLocalTransformations(LocalTransformations value)

withNeuralInputs

public NeuralNetwork withNeuralInputs(NeuralInputs value)

withNeuralLayers

public NeuralNetwork withNeuralLayers(NeuralLayer... values)

withNeuralLayers

public NeuralNetwork withNeuralLayers(java.util.Collection<NeuralLayer> values)

withNeuralOutputs

public NeuralNetwork withNeuralOutputs(NeuralOutputs value)

withModelVerification

public NeuralNetwork withModelVerification(ModelVerification value)

hasExtensions

public boolean hasExtensions()

Specified by:

hasExtensions in interface HasExtensions

hasNeuralLayers

public boolean hasNeuralLayers()

accept

public VisitorAction accept(Visitor visitor)

Specified by:

accept in interface Visitable