[tf.data] Update parallel_batch optimization description.

PiperOrigin-RevId: 321803262
Change-Id: I6815bf16f1f576ae0c75bda3dc962cd468ba58c9
This commit is contained in:
Jiri Simsa 2020-07-17 10:20:14 -07:00 committed by TensorFlower Gardener
parent ee08af1842
commit a15c3bcd9a

View File

@ -177,8 +177,13 @@ class OptimizationOptions(options.OptionsBase):
parallel_batch = options.create_option(
name="parallel_batch",
ty=bool,
docstring="Whether to parallelize copying of batch elements. If None, "
"defaults to False.")
docstring="Whether to parallelize copying of batch elements. This "
"optimization is highly experimental and can cause performance "
"degradation (e.g. when the parallelization overhead exceeds the "
"benefits of performing the data copies in parallel). You should only "
"enable this optimization if a) your input pipeline is bottlenecked on "
"batching and b) you have validated that this optimization improves "
"performance. If None, defaults to False.")
reorder_data_discarding_ops = options.create_option(
name="reorder_data_discarding_ops",