# tf.contrib.seq2seq.SampleEmbeddingHelper

<br />

|---|
| [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/tensorflow/tensorflow/blob/v1.15.0/tensorflow/contrib/seq2seq/python/ops/helper.py#L631-L678) |

A helper for use during inference.

Inherits From: [`GreedyEmbeddingHelper`](https://www.tensorflow.org/versions/r1.15/api_docs/python/tf/contrib/seq2seq/GreedyEmbeddingHelper)

    tf.contrib.seq2seq.SampleEmbeddingHelper(
        embedding, start_tokens, end_token, softmax_temperature=None, seed=None
    )

Uses sampling (from a distribution) instead of argmax and passes the
result through an embedding layer to get the next input.

<br />

<br />

<br />

| ## Args ||
|---|---|
| `embedding` | A callable that takes a vector tensor of `ids` (argmax ids), or the `params` argument for `embedding_lookup`. The returned tensor will be passed to the decoder input. |
| `start_tokens` | `int32` vector shaped `[batch_size]`, the start tokens. |
| `end_token` | `int32` scalar, the token that marks end of decoding. |
| `softmax_temperature` | (Optional) `float32` scalar, value to divide the logits by before computing the softmax. Larger values (above 1.0) result in more random samples, while smaller values push the sampling distribution towards the argmax. Must be strictly greater than 0. Defaults to 1.0. |
| `seed` | (Optional) The sampling seed. |

<br />

<br />

<br />

<br />

| ## Raises ||
|---|---|
| `ValueError` | if `start_tokens` is not a 1D tensor or `end_token` is not a scalar. |

<br />

<br />

<br />

<br />

| ## Attributes ||
|---|---|
| `batch_size` | Batch size of tensor returned by `sample`. <br /> Returns a scalar int32 tensor. |
| `sample_ids_dtype` | DType of tensor returned by `sample`. <br /> Returns a DType. |
| `sample_ids_shape` | Shape of tensor returned by `sample`, excluding the batch dimension. <br /> Returns a `TensorShape`. |

<br />

## Methods

### `initialize`

[View source](https://github.com/tensorflow/tensorflow/blob/v1.15.0/tensorflow/contrib/seq2seq/python/ops/helper.py#L604-L606)

    initialize(
        name=None
    )

Returns `(initial_finished, initial_inputs)`.

### `next_inputs`

[View source](https://github.com/tensorflow/tensorflow/blob/v1.15.0/tensorflow/contrib/seq2seq/python/ops/helper.py#L618-L628)

    next_inputs(
        time, outputs, state, sample_ids, name=None
    )

next_inputs_fn for GreedyEmbeddingHelper.

### `sample`

[View source](https://github.com/tensorflow/tensorflow/blob/v1.15.0/tensorflow/contrib/seq2seq/python/ops/helper.py#L664-L678)

    sample(
        time, outputs, state, name=None
    )

sample for SampleEmbeddingHelper.