# tf.data.Options

<br />

|---|---|
| [![](https://www.tensorflow.org/images/tf_logo_32px.png) TensorFlow 1 version](https://www.tensorflow.org/versions/r1.15/api_docs/python/tf/data/Options) | [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/tensorflow/tensorflow/blob/v2.1.0/tensorflow/python/data/ops/dataset_ops.py#L2601-L2726) |

Represents options for tf.data.Dataset.

#### View aliases


**Compat aliases for migration**

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

[`tf.compat.v1.data.Options`](https://www.tensorflow.org/api_docs/python/tf/data/Options)

<br />

    tf.data.Options()

An `Options` object can be, for instance, used to control which static
optimizations to apply or whether to use performance modeling to dynamically
tune the parallelism of operations such as [`tf.data.Dataset.map`](https://www.tensorflow.org/versions/r2.1/api_docs/python/tf/data/Dataset#map) or
[`tf.data.Dataset.interleave`](https://www.tensorflow.org/versions/r2.1/api_docs/python/tf/data/Dataset#interleave).

After constructing an `Options` object, use `dataset.with_options(options)` to
apply the options to a dataset.

    dataset = tf.data.Dataset.range(3)
    options = tf.data.Options()
    # Set options here.
    dataset = dataset.with_options(options)

<br />

<br />

<br />

| ## Attributes ||
|---|---|
| `experimental_deterministic` | Whether the outputs need to be produced in deterministic order. If None, defaults to True. |
| `experimental_distribute` | The distribution strategy options associated with the dataset. See [`tf.data.experimental.DistributeOptions`](https://www.tensorflow.org/versions/r2.1/api_docs/python/tf/data/experimental/DistributeOptions) for more details. |
| `experimental_external_state_policy` | By default, tf.data will refuse to serialize a dataset or checkpoint its iterator if the dataset contains a stateful op as the serialization / checkpointing won't be able to capture its state. Users can -- at their own risk -- override this restriction by explicitly specifying that they are fine throwing away the state in these ops. There are three settings available - IGNORE: in which wecompletely ignore any state; WARN: We warn the user that some state might be thrown away; FAIL: We fail if any state is being captured. |
| `experimental_optimization` | The optimization options associated with the dataset. See [`tf.data.experimental.OptimizationOptions`](https://www.tensorflow.org/versions/r2.1/api_docs/python/tf/data/experimental/OptimizationOptions) for more details. |
| `experimental_slack` | Whether to introduce 'slack' in the last `prefetch` of the input pipeline, if it exists. This may reduce CPU contention with accelerator host-side activity at the start of a step. The slack frequency is determined by the number of devices attached to this input pipeline. If None, defaults to False. |
| `experimental_stats` | The statistics options associated with the dataset. See [`tf.data.experimental.StatsOptions`](https://www.tensorflow.org/versions/r2.1/api_docs/python/tf/data/experimental/StatsOptions) for more details. |
| `experimental_threading` | The threading options associated with the dataset. See [`tf.data.experimental.ThreadingOptions`](https://www.tensorflow.org/versions/r2.1/api_docs/python/tf/data/experimental/ThreadingOptions) for more details. |

<br />

## Methods

### `merge`

[View source](https://github.com/tensorflow/tensorflow/blob/v2.1.0/tensorflow/python/data/ops/dataset_ops.py#L2710-L2726)

    merge(
        options
    )

Merges itself with the given [`tf.data.Options`](https://www.tensorflow.org/versions/r2.1/api_docs/python/tf/data/Options).

The given [`tf.data.Options`](https://www.tensorflow.org/versions/r2.1/api_docs/python/tf/data/Options) can be merged as long as there does not exist an
attribute that is set to different values in `self` and `options`.

<br />

<br />

<br />

| Args ||
|---|---|
| `options` | a [`tf.data.Options`](https://www.tensorflow.org/versions/r2.1/api_docs/python/tf/data/Options) to merge with |

<br />

<br />

<br />

<br />

| Raises ||
|---|---|
| `ValueError` | if the given [`tf.data.Options`](https://www.tensorflow.org/versions/r2.1/api_docs/python/tf/data/Options) cannot be merged |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| New [`tf.data.Options()`](https://www.tensorflow.org/versions/r2.1/api_docs/python/tf/data/Options) object which is the result of merging self with the input [`tf.data.Options`](https://www.tensorflow.org/versions/r2.1/api_docs/python/tf/data/Options). ||

<br />

### `__eq__`

[View source](https://github.com/tensorflow/tensorflow/blob/v2.1.0/tensorflow/python/data/util/options.py#L37-L43)

    __eq__(
        other
    )

Return self==value.

### `__ne__`

[View source](https://github.com/tensorflow/tensorflow/blob/v2.1.0/tensorflow/python/data/util/options.py#L45-L49)

    __ne__(
        other
    )

Return self!=value.