Commit 30e6e03f authored by Ruoxin Sang's avatar Ruoxin Sang Committed by A. Unique TensorFlower
Browse files

Add more documentation to recommend users to set `drop_remainder=False` when...

Add more documentation to recommend users to set `drop_remainder=False` when exhausting the eval dataset in Orbit.

PiperOrigin-RevId: 409539451
parent 9cd84cc1
...@@ -265,7 +265,10 @@ class StandardEvaluator(runner.AbstractEvaluator, metaclass=abc.ABCMeta): ...@@ -265,7 +265,10 @@ class StandardEvaluator(runner.AbstractEvaluator, metaclass=abc.ABCMeta):
Args: Args:
eval_dataset: A `tf.nest`-compatible structure of `tf.data.Dataset` or eval_dataset: A `tf.nest`-compatible structure of `tf.data.Dataset` or
`DistributedDataset`. `DistributedDataset`. On TPUs, if users want to exaust the dataset
without specifying number of eval steps, it is recommended to set
`drop_remainder=False` when batching the dataset, so the infrastructure
can handle the last partial batch properly.
options: An `orbit.StandardEvaluatorOptions` instance. options: An `orbit.StandardEvaluatorOptions` instance.
""" """
options = options or StandardEvaluatorOptions() options = options or StandardEvaluatorOptions()
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment