# tf.sparse.softmax

<br />

|---|---|
| [![](https://www.tensorflow.org/images/tf_logo_32px.png) TensorFlow 1 version](https://www.tensorflow.org/versions/r1.15/api_docs/python/tf/sparse/softmax) | [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/tensorflow/tensorflow/blob/v2.0.0/tensorflow/python/ops/sparse_ops.py#L2392-L2445) |

Applies softmax to a batched N-D `SparseTensor`.

#### View aliases


**Compat aliases for migration**

See
[Migration guide](https://www.tensorflow.org/guide/migrate) for
more details.

[`tf.compat.v1.sparse.softmax`](https://www.tensorflow.org/api_docs/python/tf/sparse/softmax), [`tf.compat.v1.sparse_softmax`](https://www.tensorflow.org/api_docs/python/tf/sparse/softmax)

<br />

    tf.sparse.softmax(
        sp_input, name=None
    )

The inputs represent an N-D SparseTensor with logical shape `[..., B, C]`
(where `N >= 2`), and with indices sorted in the canonical lexicographic
order.

This op is equivalent to applying the normal [`tf.nn.softmax()`](https://www.tensorflow.org/versions/r2.0/api_docs/python/tf/nn/softmax) to each
innermost logical submatrix with shape `[B, C]`, but with the catch that *the
implicitly zero elements do not participate*. Specifically, the algorithm is
equivalent to:

(1) Applies [`tf.nn.softmax()`](https://www.tensorflow.org/versions/r2.0/api_docs/python/tf/nn/softmax) to a densified view of each innermost
submatrix with shape `[B, C]`, along the size-C dimension;
(2) Masks out the original implicitly-zero locations;
(3) Renormalizes the remaining elements.

Hence, the `SparseTensor` result has exactly the same non-zero indices and
shape.

#### Example:

    # First batch:
    # [?   e.]
    # [1.  ? ]
    # Second batch:
    # [e   ? ]
    # [e   e ]
    shape = [2, 2, 2]  # 3-D SparseTensor
    values = np.asarray([[[0., np.e], [1., 0.]], [[np.e, 0.], [np.e, np.e]]])
    indices = np.vstack(np.where(values)).astype(np.int64).T

    result = tf.sparse.softmax(tf.SparseTensor(indices, values, shape))
    # ...returning a 3-D SparseTensor, equivalent to:
    # [?   1.]     [1    ?]
    # [1.  ? ] and [.5  .5]
    # where ? means implicitly zero.

<br />

<br />

<br />

| ## Args ||
|---|---|
| `sp_input` | N-D `SparseTensor`, where `N >= 2`. |
| `name` | optional name of the operation. |

<br />

<br />

<br />

<br />

| ## Returns ||
|---|---|
| `output` | N-D `SparseTensor` representing the results. |

<br />