Welcome to the Harris Geospatial product documentation center. Here you will find reference guides, help documents, and product libraries.


Harris Geospatial / Docs Center / ENVI API / Classification Framework / ENVICreateSoftmaxRegressionClassifierTask

ENVICreateSoftmaxRegressionClassifierTask

ENVICreateSoftmaxRegressionClassifierTask

This task creates a Softmax Regression classifier. See Softmax Regression Background for details on this algorithm.

Use ENVICreateGradientDescentTrainerTask to train this classifier.

The following diagram shows a typical workflow where this task is used:

 

Example


See Code Example: Softmax Regression Classification Using ENVITasks.

Syntax


Result = ENVITask('CreateSoftmaxRegressionClassifier')

Input properties (Set, Get): CLASS_NAMES, LAMBDA, NATTRIBUTES, NCLASSES, OUTPUT_CLASSIFIER_URI, SEED, THETA

Output properties (Get only): DESCRIPTION, NAME, OUTPUT_CLASSIFIER

Properties marked as "Set" are those that you can set to specific values. You can also retrieve their current values any time. Properties marked as "Get" are those whose values you can retrieve but not set.

Methods


This task inherits the following methods from ENVITask:

AddParameter

Execute

Parameter

ParameterNames

RemoveParameter

Properties


CLASS_NAMES (required)

Specify a string array with the class names.

DESCRIPTION

This property describes the task.

LAMBDA (optional)

Specify the regularization value used to calculate the loss and gradient when training the classifier. The default value is 0.1.

NAME

This property contains the name of the task.

NATTRIBUTES (required)

Specify the number of attributes that the input data will be required to have.

NCLASSES (required)

Specify the number of unique classes that the classifier will have.

OUTPUT_CLASSIFIER

This is a reference to the initialized ENVISoftmaxRegressionClassifier object.

OUTPUT_CLASSIFIER_URI (optional)

Specify a string with the fully qualified filename and path of the output object. If you do not specify this property, the output object (.epo) is only temporary. Once ENVI is closed, it deletes the temporary file. Restore the object later using ENVIRestoreObject.ENVISoftmaxRegressionClassifier is a persistable object that can be saved and restored.

SEED (optional)

If repeatability is desired (such as for testing), specify the seed value used to randomly initialize the weights. This value is ignored if you set the THETA property.

THETA (optional)

Specify an array of weights. The array size is k classes by n attributes. The weights are used in the Softmax Regression activation function, which is used to perform the classification. If you do not set this property, default initial weights will be randomly generated. The default initial weights will usually be sufficient.

Version History


ENVI 5.4

Introduced

API Version


3.1.0

See Also


ENVITask, ENVISoftmaxRegressionClassifier, ENVICreateSVMClassifierTask, ENVIRestoreObject

 



© 2017 Exelis Visual Information Solutions, Inc. |  Legal
My Account    |    Buy    |    Contact Us