# tf.contrib.seq2seq.ScheduledOutputTrainingHelper

<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#L416-L551) |

A training helper that adds scheduled sampling directly to outputs.

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

    tf.contrib.seq2seq.ScheduledOutputTrainingHelper(
        inputs, sequence_length, sampling_probability, time_major=False, seed=None,
        next_inputs_fn=None, auxiliary_inputs=None, name=None
    )

Returns False for sample_ids where no sampling took place; True elsewhere.

<br />

<br />

<br />

| ## Args ||
|---|---|
| `inputs` | A (structure) of input tensors. |
| `sequence_length` | An int32 vector tensor. |
| `sampling_probability` | A 0D `float32` tensor: the probability of sampling from the outputs instead of reading directly from the inputs. |
| `time_major` | Python bool. Whether the tensors in `inputs` are time major. If `False` (default), they are assumed to be batch major. |
| `seed` | The sampling seed. |
| `next_inputs_fn` | (Optional) callable to apply to the RNN outputs to create the next input when sampling. If `None` (default), the RNN outputs will be used as the next inputs. |
| `auxiliary_inputs` | An optional (structure of) auxiliary input tensors with a shape that matches `inputs` in all but (potentially) the final dimension. These tensors will be concatenated to the sampled output or the `inputs` when not sampling for use as the next input. |
| `name` | Name scope for any created operations. |

<br />

<br />

<br />

<br />

| ## Raises ||
|---|---|
| `ValueError` | if `sampling_probability` is not a scalar or vector. |

<br />

<br />

<br />

<br />

| ## Attributes ||
|---|---|
| `batch_size` | Batch size of tensor returned by `sample`. <br /> Returns a scalar int32 tensor. |
| `inputs` | <br /> <br /> |
| `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`. |
| `sequence_length` | <br /> <br /> |

<br />

## Methods

### `initialize`

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

    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#L494-L551)

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

next_inputs_fn for TrainingHelper.

### `sample`

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

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

Returns `sample_ids`.