softmax

(To be removed) Softmax transfer function

softmax will be removed in a future release. For more information, see Transition Legacy Neural Network Code to dlnetwork Workflows.

For advice on updating your code, see Version History.

Syntax

A = softmax(N)

info = softmax(code)

Description

Tip

To use a softmax activation for deep learning, use softmaxLayer or the dlarray method softmax.

A = softmax(N) takes a S-by-Q matrix of net input (column) vectors, N, and returns the S-by-Q matrix, A, of the softmax competitive function applied to each column of N.

softmax is a neural transfer function. Transfer functions calculate a layer’s output from its net input.

info = softmax(code) returns information about this function. For more information, see the code argument description.

Examples

Create and Plot the softmax Transfer Function

This example shows how to calculate and plot the softmax transfer function of an input matrix.

Create the input matrix, n. Then call the softmax function and plot the results.

n = [0; 1; -0.5; 0.5];
a = softmax(n);
subplot(2,1,1), bar(n), ylabel('n')
subplot(2,1,2), bar(a), ylabel('a')

Assign this transfer function to layer i of a network.

net.layers{i}.transferFcn = 'softmax';

Input Arguments

N — Input matrix

matrix

Net input column vectors, specified as an S-by-Q matrix.

code — Information option

'name' | 'output' | 'active' | 'fullderiv' | 'fpnames' | 'fpdefaults'

Information you want to retrieve from the function, specified as one of the following:

• 'name' returns the name of this function.

• 'output' returns the [min max] output range.

• 'active' returns the [min max] active input range.

• 'fullderiv' returns 1 or 0, depending on whether dA_dN is S-by-S-by-Q or S-by-Q.

• 'fpnames' returns the names of the function parameters.

• 'fpdefaults' returns the default function parameters.

Output Arguments

A — Output matrix

matrix

Output matrix, returned as an S-by-Q matrix of the softmax competitive function applied to each column of N.

info — Information output

string | vector | scalar

Specific information about the function, according to the option specified in the code argument, returned as either a string, a vector, or a scalar.

Algorithms

a = softmax(n) = exp(n)/sum(exp(n))

Version History

Introduced before R2006a

softmax will be removed

softmax will be removed in a future release.

To learn more about using activation and transfer functions in neural networks, see these examples and topics:

• Build Networks with Deep Network Designer

• List of Deep Learning Layers

• List of Functions with dlarray Support

• Compare Activation Layers

• Example Deep Learning Network Architectures

To include a softmax layer in a layer array or dlnetwork object, use softmaxLayer. To apply the softmax activation to dlarray objects, use the softmax function.

For more information, see Transition Legacy Neural Network Code to dlnetwork Workflows.