NeuralNetwork (Drools :: PMML - Compiler 6.3.0.CR1 API)

java.lang.Object
- org.dmg.pmml.pmml_4_2.descr.NeuralNetwork

All Implemented Interfaces:: Serializable

public class NeuralNetwork
extends Object
implements Serializable

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"/>
         <element ref="{http://www.dmg.org/PMML-4_2}Extension" maxOccurs="unbounded" 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 ACTIVATIONFUNCTION`	`activationFunction`
`protected String`	`algorithmName`
`protected Double`	`altitude`
`protected List<Serializable>`	`extensionsAndNeuralLayersAndNeuralInputs`
`protected MININGFUNCTION`	`functionName`
`protected Boolean`	`isScorable`
`protected String`	`modelName`
`protected NNNORMALIZATIONMETHOD`	`normalizationMethod`
`protected BigInteger`	`numberOfLayers`
`protected Double`	`threshold`
`protected Double`	`width`

Constructor Summary

Constructors
Constructor and Description

NeuralNetwork()

Constructors
Constructor and Description
`NeuralNetwork()`

Method Summary

Methods
Modifier and Type	Method and Description
`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<Serializable>`	`getExtensionsAndNeuralLayersAndNeuralInputs()` Gets the value of the extensionsAndNeuralLayersAndNeuralInputs property.
`MININGFUNCTION`	`getFunctionName()` Gets the value of the functionName property.
`String`	`getModelName()` Gets the value of the modelName property.
`NNNORMALIZATIONMETHOD`	`getNormalizationMethod()` Gets the value of the normalizationMethod property.
`BigInteger`	`getNumberOfLayers()` Gets the value of the numberOfLayers property.
`double`	`getThreshold()` Gets the value of the threshold property.
`Double`	`getWidth()` Gets the value of the width property.
`boolean`	`isIsScorable()` Gets the value of the isScorable property.
`void`	`setActivationFunction(ACTIVATIONFUNCTION 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(MININGFUNCTION value)` Sets the value of the functionName property.
`void`	`setIsScorable(Boolean value)` Sets the value of the isScorable property.
`void`	`setModelName(String value)` Sets the value of the modelName property.
`void`	`setNormalizationMethod(NNNORMALIZATIONMETHOD value)` Sets the value of the normalizationMethod property.
`void`	`setNumberOfLayers(BigInteger value)` Sets the value of the numberOfLayers property.
`void`	`setThreshold(Double value)` Sets the value of the threshold property.
`void`	`setWidth(Double value)` Sets the value of the width property.

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

- Field Detail
  - extensionsAndNeuralLayersAndNeuralInputs
```
protected List<Serializable> extensionsAndNeuralLayersAndNeuralInputs
```
  - modelName
```
protected String modelName
```
  - functionName
```
protected MININGFUNCTION functionName
```
  - algorithmName
```
protected String algorithmName
```
  - activationFunction
```
protected ACTIVATIONFUNCTION activationFunction
```
  - normalizationMethod
```
protected NNNORMALIZATIONMETHOD normalizationMethod
```
  - threshold
```
protected Double threshold
```
  - width
```
protected Double width
```
  - altitude
```
protected Double altitude
```
  - numberOfLayers
```
protected BigInteger numberOfLayers
```
  - isScorable
```
protected Boolean isScorable
```
- Constructor Detail
  - NeuralNetwork
```
public NeuralNetwork()
```
- Method Detail
  - getExtensionsAndNeuralLayersAndNeuralInputs
```
public List<Serializable> getExtensionsAndNeuralLayersAndNeuralInputs()
```
    Gets the value of the extensionsAndNeuralLayersAndNeuralInputs 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 extensionsAndNeuralLayersAndNeuralInputs property.
    For example, to add a new item, do as follows:
```
    getExtensionsAndNeuralLayersAndNeuralInputs().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list NeuralOutputs Extension ModelVerification LocalTransformations Output NeuralLayer NeuralInputs Targets ModelStats MiningSchema ModelExplanation
  - getModelName
```
public String getModelName()
```
    Gets the value of the modelName property.
    
    Returns:
    possible object is String
  - setModelName
```
public void setModelName(String value)
```
    Sets the value of the modelName property.
    
    Parameters:
    value - allowed object is String
  - getFunctionName
```
public MININGFUNCTION getFunctionName()
```
    Gets the value of the functionName property.
    
    Returns:
    possible object is MININGFUNCTION
  - setFunctionName
```
public void setFunctionName(MININGFUNCTION value)
```
    Sets the value of the functionName property.
    
    Parameters:
    value - allowed object is MININGFUNCTION
  - 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 ACTIVATIONFUNCTION getActivationFunction()
```
    Gets the value of the activationFunction property.
    
    Returns:
    possible object is ACTIVATIONFUNCTION
  - setActivationFunction
```
public void setActivationFunction(ACTIVATIONFUNCTION value)
```
    Sets the value of the activationFunction property.
    
    Parameters:
    value - allowed object is ACTIVATIONFUNCTION
  - getNormalizationMethod
```
public NNNORMALIZATIONMETHOD getNormalizationMethod()
```
    Gets the value of the normalizationMethod property.
    
    Returns:
    possible object is NNNORMALIZATIONMETHOD
  - setNormalizationMethod
```
public void setNormalizationMethod(NNNORMALIZATIONMETHOD value)
```
    Sets the value of the normalizationMethod property.
    
    Parameters:
    value - allowed object is NNNORMALIZATIONMETHOD
  - 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 BigInteger getNumberOfLayers()
```
    Gets the value of the numberOfLayers property.
    
    Returns:
    possible object is BigInteger
  - setNumberOfLayers
```
public void setNumberOfLayers(BigInteger value)
```
    Sets the value of the numberOfLayers property.
    
    Parameters:
    value - allowed object is BigInteger
  - isIsScorable
```
public boolean isIsScorable()
```
    Gets the value of the isScorable property.
    
    Returns:
    possible object is Boolean
  - setIsScorable
```
public void setIsScorable(Boolean value)
```
    Sets the value of the isScorable property.
    
    Parameters:
    value - allowed object is Boolean

Class NeuralNetwork

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

extensionsAndNeuralLayersAndNeuralInputs

modelName

functionName

algorithmName

activationFunction

normalizationMethod

threshold

width

altitude

numberOfLayers

isScorable

Constructor Detail

NeuralNetwork

Method Detail

getExtensionsAndNeuralLayersAndNeuralInputs

getModelName

setModelName

getFunctionName

setFunctionName

getAlgorithmName

setAlgorithmName

getActivationFunction

setActivationFunction

getNormalizationMethod

setNormalizationMethod

getThreshold

setThreshold

getWidth

setWidth

getAltitude

setAltitude

getNumberOfLayers

setNumberOfLayers

isIsScorable

setIsScorable