# Module: orbit.utils

<br />

|---|
| [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/tensorflow/models/blob/v2.20.0/orbit/utils/__init__.py) |

Defines exported symbols for the [`orbit.utils`](https://www.tensorflow.org/api_docs/python/orbit/utils) package.

## Classes

[`class EpochHelper`](https://www.tensorflow.org/api_docs/python/orbit/utils/EpochHelper): A helper class handle bookkeeping of epochs in custom training loops.

[`class LoopFnWithSummaries`](https://www.tensorflow.org/api_docs/python/orbit/utils/LoopFnWithSummaries): Implements a two-program approach for optimizing summaries on TPU.

[`class OptionalSummariesFunction`](https://www.tensorflow.org/api_docs/python/orbit/utils/OptionalSummariesFunction): Wrapper that provides versions of a function with and without summaries.

[`class SummaryManager`](https://www.tensorflow.org/api_docs/python/orbit/utils/SummaryManager): A utility class for managing summary writing.

[`class SummaryManagerInterface`](https://www.tensorflow.org/api_docs/python/orbit/utils/SummaryManagerInterface): A utility interface for managing summary writing.

## Functions

[`create_global_step(...)`](https://www.tensorflow.org/api_docs/python/orbit/utils/create_global_step): Creates a [`tf.Variable`](https://www.tensorflow.org/api_docs/python/tf/Variable) suitable for use as a global step counter.

[`create_loop_fn(...)`](https://www.tensorflow.org/api_docs/python/orbit/utils/create_loop_fn): Creates a loop function driven by a Python `while` loop.

[`create_tf_while_loop_fn(...)`](https://www.tensorflow.org/api_docs/python/orbit/utils/create_tf_while_loop_fn): Creates a loop function compatible with TF's AutoGraph loop conversion.

[`get_value(...)`](https://www.tensorflow.org/api_docs/python/orbit/utils/get_value): Returns input values, converting any TensorFlow values to NumPy values.

[`make_distributed_dataset(...)`](https://www.tensorflow.org/api_docs/python/orbit/utils/make_distributed_dataset): A utility function to help create a [`tf.distribute.DistributedDataset`](https://www.tensorflow.org/api_docs/python/tf/distribute/DistributedDataset).