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:

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_3}Extension" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}MiningSchema"/>
         <element ref="{http://www.dmg.org/PMML-4_3}Output" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}ModelStats" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}ModelExplanation" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}Targets" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}LocalTransformations" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}NeuralInputs"/>
         <element ref="{http://www.dmg.org/PMML-4_3}NeuralLayer" maxOccurs="unbounded"/>
         <element ref="{http://www.dmg.org/PMML-4_3}NeuralOutputs" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_3}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_3}MINING-FUNCTION" />
       <attribute name="algorithmName" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="activationFunction" use="required">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}string">
             <enumeration value="threshold"/>
             <enumeration value="logistic"/>
             <enumeration value="tanh"/>
             <enumeration value="identity"/>
             <enumeration value="exponential"/>
             <enumeration value="reciprocal"/>
             <enumeration value="square"/>
             <enumeration value="Gauss"/>
             <enumeration value="sine"/>
             <enumeration value="cosine"/>
             <enumeration value="Elliott"/>
             <enumeration value="arctan"/>
             <enumeration value="rectifier"/>
             <enumeration value="radialBasis"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="normalizationMethod" default="none">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}string">
             <enumeration value="none"/>
             <enumeration value="simplemax"/>
             <enumeration value="softmax"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="threshold" type="{http://www.dmg.org/PMML-4_3}REAL-NUMBER" default="0" />
       <attribute name="width" type="{http://www.dmg.org/PMML-4_3}REAL-NUMBER" />
       <attribute name="altitude" type="{http://www.dmg.org/PMML-4_3}REAL-NUMBER" default="1.0" />
       <attribute name="numberOfLayers" type="{http://www.dmg.org/PMML-4_3}INT-NUMBER" />
       <attribute name="isScorable" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
     </restriction>
   </complexContent>
 </complexType>
 

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NeuralNetwork.ActivationFunction Java class for null.
static class	NeuralNetwork.NormalizationMethod Java class for null.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
VisitorAction	accept(Visitor visitor)
NeuralNetwork	addExtensions(Extension... extensions)
NeuralNetwork	addNeuralLayers(NeuralLayer... neuralLayers)
NeuralNetwork.ActivationFunction	getActivationFunction() Gets the value of the activationFunction property.
String	getAlgorithmName() Gets the value of the algorithmName property.
Double	getAltitude() Gets the value of the altitude property.
List<Extension>	getExtensions() Gets the value of the extensions property.
LocalTransformations	getLocalTransformations() Gets the value of the localTransformations property.
MiningFunction	getMiningFunction() Gets the value of the miningFunction property.
MiningSchema	getMiningSchema() Gets the value of the miningSchema property.
ModelExplanation	getModelExplanation() Gets the value of the modelExplanation property.
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.
List<NeuralLayer>	getNeuralLayers() Gets the value of the neuralLayers property.
NeuralOutputs	getNeuralOutputs() Gets the value of the neuralOutputs property.
NeuralNetwork.NormalizationMethod	getNormalizationMethod() Gets the value of the normalizationMethod property.
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.
Double	getWidth() Gets the value of the width property.
boolean	hasExtensions()
boolean	hasNeuralLayers()
boolean	isScorable() Gets the value of the scorable property.
NeuralNetwork	setActivationFunction(NeuralNetwork.ActivationFunction activationFunction) Sets the value of the activationFunction property.
NeuralNetwork	setAlgorithmName(String algorithmName) Sets the value of the algorithmName property.
NeuralNetwork	setAltitude(Double altitude) Sets the value of the altitude property.
NeuralNetwork	setLocalTransformations(LocalTransformations localTransformations) Sets the value of the localTransformations property.
NeuralNetwork	setMiningFunction(MiningFunction miningFunction) Sets the value of the miningFunction property.
NeuralNetwork	setMiningSchema(MiningSchema miningSchema) Sets the value of the miningSchema property.
NeuralNetwork	setModelExplanation(ModelExplanation modelExplanation) Sets the value of the modelExplanation property.
NeuralNetwork	setModelName(String modelName) Sets the value of the modelName property.
NeuralNetwork	setModelStats(ModelStats modelStats) Sets the value of the modelStats property.
NeuralNetwork	setModelVerification(ModelVerification modelVerification) Sets the value of the modelVerification property.
NeuralNetwork	setNeuralInputs(NeuralInputs neuralInputs) Sets the value of the neuralInputs property.
NeuralNetwork	setNeuralOutputs(NeuralOutputs neuralOutputs) Sets the value of the neuralOutputs property.
NeuralNetwork	setNormalizationMethod(NeuralNetwork.NormalizationMethod normalizationMethod) Sets the value of the normalizationMethod property.
NeuralNetwork	setNumberOfLayers(Integer numberOfLayers) Sets the value of the numberOfLayers property.
NeuralNetwork	setOutput(Output output) Sets the value of the output property.
NeuralNetwork	setScorable(Boolean scorable) Sets the value of the scorable property.
NeuralNetwork	setTargets(Targets targets) Sets the value of the targets property.
NeuralNetwork	setThreshold(Double threshold) Sets the value of the threshold property.
NeuralNetwork	setWidth(Double width) Sets the value of the width property.

Methods inherited from class org.dmg.pmml.PMMLObject

getLocator, setLocator, traverse, traverse, traverse, traverse, traverseMixed

Methods inherited from class java.lang.Object

clone, equals, finalize, 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,
             List<NeuralLayer> neuralLayers)

Method Detail

getModelName

public String getModelName()

Gets the value of the modelName property.

Specified by:

getModelName in class Model

Returns:

possible object is String

setModelName

public NeuralNetwork setModelName(String modelName)

Sets the value of the modelName property.

Specified by:

setModelName in class Model

Parameters:

modelName - allowed object is String

getMiningFunction

public MiningFunction getMiningFunction()

Gets the value of the miningFunction property.

Specified by:

getMiningFunction in class Model

Returns:

possible object is MiningFunction

setMiningFunction

public NeuralNetwork setMiningFunction(MiningFunction miningFunction)

Sets the value of the miningFunction property.

Specified by:

setMiningFunction in class Model

Parameters:

miningFunction - allowed object is MiningFunction

getAlgorithmName

public String getAlgorithmName()

Gets the value of the algorithmName property.

Specified by:

getAlgorithmName in class Model

Returns:

possible object is String

setAlgorithmName

public NeuralNetwork setAlgorithmName(String algorithmName)

Sets the value of the algorithmName property.

Specified by:

setAlgorithmName in class Model

Parameters:

algorithmName - allowed object is String

getActivationFunction

public NeuralNetwork.ActivationFunction getActivationFunction()

Gets the value of the activationFunction property.

Returns:

possible object is NeuralNetwork.ActivationFunction

setActivationFunction

public NeuralNetwork setActivationFunction(NeuralNetwork.ActivationFunction activationFunction)

Sets the value of the activationFunction property.

Parameters:

activationFunction - allowed object is NeuralNetwork.ActivationFunction

getNormalizationMethod

public NeuralNetwork.NormalizationMethod getNormalizationMethod()

Gets the value of the normalizationMethod property.

Returns:

possible object is NeuralNetwork.NormalizationMethod

setNormalizationMethod

public NeuralNetwork setNormalizationMethod(NeuralNetwork.NormalizationMethod normalizationMethod)

Sets the value of the normalizationMethod property.

Parameters:

normalizationMethod - allowed object is NeuralNetwork.NormalizationMethod

getThreshold

public Double getThreshold()

Gets the value of the threshold property.

Returns:

possible object is Double

setThreshold

public NeuralNetwork setThreshold(Double threshold)

Sets the value of the threshold property.

Parameters:

threshold - allowed object is Double

getWidth

public Double getWidth()

Gets the value of the width property.

Returns:

possible object is Double

setWidth

public NeuralNetwork setWidth(Double width)

Sets the value of the width property.

Parameters:

width - allowed object is Double

getAltitude

public Double getAltitude()

Gets the value of the altitude property.

Returns:

possible object is Double

setAltitude

public NeuralNetwork setAltitude(Double altitude)

Sets the value of the altitude property.

Parameters:

altitude - allowed object is Double

getNumberOfLayers

public Integer getNumberOfLayers()

Gets the value of the numberOfLayers property.

Returns:

possible object is Integer

setNumberOfLayers

public NeuralNetwork setNumberOfLayers(Integer numberOfLayers)

Sets the value of the numberOfLayers property.

Parameters:

numberOfLayers - allowed object is Integer

isScorable

public boolean isScorable()

Gets the value of the scorable property.

Specified by:

isScorable in class Model

Returns:

possible object is Boolean

setScorable

public NeuralNetwork setScorable(Boolean scorable)

Sets the value of the scorable property.

Specified by:

setScorable in class Model

Parameters:

scorable - allowed object is Boolean

getExtensions

public 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 NeuralNetwork setMiningSchema(MiningSchema miningSchema)

Sets the value of the miningSchema property.

Specified by:

setMiningSchema in class Model

Parameters:

miningSchema - allowed object is MiningSchema

getOutput

public Output getOutput()

Gets the value of the output property.

Overrides:

getOutput in class Model

Returns:

possible object is Output

setOutput

public NeuralNetwork setOutput(Output output)

Sets the value of the output property.

Overrides:

setOutput in class Model

Parameters:

output - 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 NeuralNetwork setModelStats(ModelStats modelStats)

Sets the value of the modelStats property.

Specified by:

setModelStats in class Model

Parameters:

modelStats - allowed object is ModelStats

getModelExplanation

public ModelExplanation getModelExplanation()

Gets the value of the modelExplanation property.

Overrides:

getModelExplanation in class Model

Returns:

possible object is ModelExplanation

setModelExplanation

public NeuralNetwork setModelExplanation(ModelExplanation modelExplanation)

Sets the value of the modelExplanation property.

Overrides:

setModelExplanation in class Model

Parameters:

modelExplanation - allowed object is ModelExplanation

getTargets

public Targets getTargets()

Gets the value of the targets property.

Overrides:

getTargets in class Model

Returns:

possible object is Targets

setTargets

public NeuralNetwork setTargets(Targets targets)

Sets the value of the targets property.

Overrides:

setTargets in class Model

Parameters:

targets - 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 NeuralNetwork setLocalTransformations(LocalTransformations localTransformations)

Sets the value of the localTransformations property.

Specified by:

setLocalTransformations in class Model

Parameters:

localTransformations - allowed object is LocalTransformations

getNeuralInputs

public NeuralInputs getNeuralInputs()

Gets the value of the neuralInputs property.

Returns:

possible object is NeuralInputs

setNeuralInputs

public NeuralNetwork setNeuralInputs(NeuralInputs neuralInputs)

Sets the value of the neuralInputs property.

Parameters:

neuralInputs - allowed object is NeuralInputs

getNeuralLayers

public 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 NeuralNetwork setNeuralOutputs(NeuralOutputs neuralOutputs)

Sets the value of the neuralOutputs property.

Parameters:

neuralOutputs - allowed object is NeuralOutputs

getModelVerification

public ModelVerification getModelVerification()

Gets the value of the modelVerification property.

Overrides:

getModelVerification in class Model

Returns:

possible object is ModelVerification

setModelVerification

public NeuralNetwork setModelVerification(ModelVerification modelVerification)

Sets the value of the modelVerification property.

Overrides:

setModelVerification in class Model

Parameters:

modelVerification - allowed object is ModelVerification

hasExtensions

public boolean hasExtensions()

Specified by:

hasExtensions in interface HasExtensions

addExtensions

public NeuralNetwork addExtensions(Extension... extensions)

hasNeuralLayers

public boolean hasNeuralLayers()

addNeuralLayers

public NeuralNetwork addNeuralLayers(NeuralLayer... neuralLayers)

accept

public VisitorAction accept(Visitor visitor)

Specified by:

accept in interface Visitable