NeuralNetwork (JPMML model 1.0.12 API)

java.lang.Object
- org.dmg.pmml.PMMLObject
- - org.dmg.pmml.Model
  - - org.dmg.pmml.NeuralNetwork

All Implemented Interfaces:: com.sun.xml.bind.Locatable, Serializable

public class NeuralNetwork
extends Model
implements com.sun.xml.bind.Locatable

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_1}Extension" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_1}MiningSchema"/>
         <element ref="{http://www.dmg.org/PMML-4_1}Output" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_1}ModelStats" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_1}ModelExplanation" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_1}Targets" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_1}LocalTransformations" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_1}NeuralInputs"/>
         <element ref="{http://www.dmg.org/PMML-4_1}NeuralLayer" maxOccurs="unbounded"/>
         <element ref="{http://www.dmg.org/PMML-4_1}NeuralOutputs" minOccurs="0"/>
         <element ref="{http://www.dmg.org/PMML-4_1}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_1}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_1}ACTIVATION-FUNCTION" />
       <attribute name="normalizationMethod" type="{http://www.dmg.org/PMML-4_1}NN-NORMALIZATION-METHOD" default="none" />
       <attribute name="threshold" type="{http://www.dmg.org/PMML-4_1}REAL-NUMBER" default="0" />
       <attribute name="width" type="{http://www.dmg.org/PMML-4_1}REAL-NUMBER" />
       <attribute name="altitude" type="{http://www.dmg.org/PMML-4_1}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 String`	`algorithmName`
`protected Double`	`altitude`
`protected List<Extension>`	`extensions`
`protected MiningFunctionType`	`functionName`
`protected LocalTransformations`	`localTransformations`
`protected Locator`	`locator`
`protected MiningSchema`	`miningSchema`
`protected ModelExplanation`	`modelExplanation`
`protected String`	`modelName`
`protected ModelStats`	`modelStats`
`protected ModelVerification`	`modelVerification`
`protected NeuralInputs`	`neuralInputs`
`protected List<NeuralLayer>`	`neuralLayers`
`protected NeuralOutputs`	`neuralOutputs`
`protected NnNormalizationMethodType`	`normalizationMethod`
`protected Integer`	`numberOfLayers`
`protected Output`	`output`
`protected Boolean`	`scorable`
`protected Targets`	`targets`
`protected Double`	`threshold`
`protected Double`	`width`

Constructor Summary

Constructors
Constructor and Description
`NeuralNetwork()` Deprecated.
`NeuralNetwork(MiningSchema miningSchema, NeuralInputs neuralInputs, MiningFunctionType functionName, ActivationFunctionType activationFunction)`

Method Summary

Methods
Modifier and Type	Method and Description
`ActivationFunctionType`	`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.
`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.
`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.
`NnNormalizationMethodType`	`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`	`isScorable()` Gets the value of the scorable property.
`void`	`setActivationFunction(ActivationFunctionType value)` Sets the value of the activationFunction property.
`void`	`setAlgorithmName(String value)` Sets the value of the algorithmName property.
`void`	`setAltitude(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(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(Integer value)` Sets the value of the numberOfLayers property.
`void`	`setOutput(Output value)` Sets the value of the output property.
`void`	`setScorable(Boolean value)` Sets the value of the scorable property.
`void`	`setSourceLocation(Locator newLocator)`
`void`	`setTargets(Targets value)` Sets the value of the targets property.
`void`	`setThreshold(Double value)` Sets the value of the threshold property.
`void`	`setWidth(Double value)` Sets the value of the width property.
`Locator`	`sourceLocation()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - extensions
```
protected 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 List<NeuralLayer> neuralLayers
```
  - neuralOutputs
```
protected NeuralOutputs neuralOutputs
```
  - modelVerification
```
protected ModelVerification modelVerification
```
  - modelName
```
protected String modelName
```
  - functionName
```
protected MiningFunctionType functionName
```
  - algorithmName
```
protected String algorithmName
```
  - activationFunction
```
protected ActivationFunctionType activationFunction
```
  - normalizationMethod
```
protected NnNormalizationMethodType normalizationMethod
```
  - threshold
```
protected Double threshold
```
  - width
```
protected Double width
```
  - altitude
```
protected Double altitude
```
  - numberOfLayers
```
protected Integer numberOfLayers
```
  - scorable
```
protected Boolean scorable
```
  - locator
```
protected Locator locator
```
- Constructor Detail
  - NeuralNetwork
```
@Deprecated
public NeuralNetwork()
```
    Deprecated.
  - NeuralNetwork
```
public NeuralNetwork(MiningSchema miningSchema,
             NeuralInputs neuralInputs,
             MiningFunctionType functionName,
             ActivationFunctionType activationFunction)
```
- Method Detail
  - 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
  - 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.
    
    Returns:
    possible object is ModelExplanation
  - setModelExplanation
```
public void setModelExplanation(ModelExplanation value)
```
    Sets the value of the modelExplanation property.
    
    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 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.
    
    Returns:
    possible object is ModelVerification
  - setModelVerification
```
public void setModelVerification(ModelVerification value)
```
    Sets the value of the modelVerification property.
    
    Parameters:
    value - allowed object is ModelVerification
  - getModelName
```
public String getModelName()
```
    Gets the value of the modelName property.
    
    Specified by:
    
    getModelName in class Model
    
    Returns:
    possible object is String
  - setModelName
```
public void setModelName(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 String getAlgorithmName()
```
    Gets the value of the algorithmName property.
    
    Returns:
    possible object is String
  - setAlgorithmName
```
public void setAlgorithmName(String value)
```
    Sets the value of the algorithmName property.
    
    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(Double value)
```
    Sets the value of the threshold property.
    
    Parameters:
    value - allowed object is Double
  - getWidth
```
public Double getWidth()
```
    Gets the value of the width property.
    
    Returns:
    possible object is Double
  - setWidth
```
public void setWidth(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(Double value)
```
    Sets the value of the altitude property.
    
    Parameters:
    value - allowed object is Double
  - getNumberOfLayers
```
public Integer getNumberOfLayers()
```
    Gets the value of the numberOfLayers property.
    
    Returns:
    possible object is String
  - setNumberOfLayers
```
public void setNumberOfLayers(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(Boolean value)
```
    Sets the value of the scorable property.
    
    Specified by:
    
    setScorable in class Model
    
    Parameters:
    value - allowed object is Boolean
  - sourceLocation
```
public Locator sourceLocation()
```
    Specified by:
    
    sourceLocation in interface com.sun.xml.bind.Locatable
    
    Specified by:
    
    sourceLocation in class PMMLObject
  - setSourceLocation
```
public void setSourceLocation(Locator newLocator)
```
    Specified by:
    
    setSourceLocation in class PMMLObject

Class NeuralNetwork

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

extensions

miningSchema

output

modelStats

modelExplanation

targets

localTransformations

neuralInputs

neuralLayers

neuralOutputs

modelVerification

modelName

functionName

algorithmName

activationFunction

normalizationMethod

threshold

width

altitude

numberOfLayers

scorable

locator

Constructor Detail

NeuralNetwork

NeuralNetwork

Method Detail

getExtensions

getMiningSchema

setMiningSchema

getOutput

setOutput

getModelStats

setModelStats

getModelExplanation

setModelExplanation

getTargets

setTargets

getLocalTransformations

setLocalTransformations

getNeuralInputs

setNeuralInputs

getNeuralLayers

getNeuralOutputs

setNeuralOutputs

getModelVerification

setModelVerification

getModelName

setModelName

getFunctionName

setFunctionName

getAlgorithmName

setAlgorithmName

getActivationFunction

setActivationFunction

getNormalizationMethod

setNormalizationMethod

getThreshold

setThreshold

getWidth

setWidth

getAltitude

setAltitude

getNumberOfLayers

setNumberOfLayers

isScorable

setScorable

sourceLocation

setSourceLocation