<br />

|---|
| [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/tensorflow/models/blob/v2.20.0/official/core/train_lib.py#L34-L304) |

Runs experiment with Orbit training loop.

    tfm.core.train_lib.OrbitExperimentRunner(
        distribution_strategy: tf.distribute.Strategy,
        task: https://www.tensorflow.org/api_docs/python/tfm/core/base_task/Task,
        mode: str,
        params: https://www.tensorflow.org/api_docs/python/tfm/core/base_trainer/ExperimentConfig,
        model_dir: str,
        run_post_eval: bool = False,
        save_summary: bool = True,
        train_actions: Optional[List[orbit.Action]] = None,
        eval_actions: Optional[List[orbit.Action]] = None,
        trainer: Optional[https://www.tensorflow.org/api_docs/python/tfm/core/base_trainer/Trainer] = None,
        controller_cls=orbit.Controller,
        summary_manager: Optional[orbit.utils.SummaryManager] = None,
        eval_summary_manager: Optional[orbit.utils.SummaryManager] = None,
        enable_async_checkpointing: bool = False
    )

The default experiment runner for model garden experiments. User can
customize the experiment pipeline by subclassing this class and replacing
components or functions.

For example, an experiment runner with customized checkpoint manager:

    class MyExpRunnerWithExporter(OrbitExperimentRunner):
      def _maybe_build_checkpoint_manager(sefl):
        # Replaces the default CheckpointManger with a customized one.
        return MyCheckpointManager(*args)

    # In user code, instead of the orginal
    # `OrbitExperimentRunner(..).run(mode)`, now user can do:
    MyExpRunnerWithExporter(**needed_kwargs).run(mode)

Similar override can be done to other components.

<br />

<br />

<br />

| ## Args ||
|---|---|
| `distribution_strategy` | A distribution strategy. |
| `task` | A Task instance. |
| `mode` | A 'str', specifying the mode. Can be 'train', 'eval', 'train_and_eval' or 'continuous_eval'. |
| `params` | ExperimentConfig instance. |
| `model_dir` | A 'str', a path to store model checkpoints and summaries. |
| `run_post_eval` | Whether to run post eval once after training, metrics logs are returned. |
| `save_summary` | Whether to save train and validation summary. |
| `train_actions` | Optional list of Orbit train actions. |
| `eval_actions` | Optional list of Orbit eval actions. |
| `trainer` | the base_trainer.Trainer instance. It should be created within the strategy.scope(). |
| `controller_cls` | The controller class to manage the train and eval process. Must be a orbit.Controller subclass. |
| `summary_manager` | Instance of the summary manager to override default summary manager. |
| `eval_summary_manager` | Instance of the eval summary manager to override default eval summary manager. |
| `enable_async_checkpointing` | Optional boolean indicating whether to enable async checkpoint saving. |

<br />

<br />

<br />

<br />

| ## Attributes ||
|---|---|
| `checkpoint_manager` | The CheckpointManager that stores the checkpoints in a train job. |
| `controller` | The Orbit controller object. |
| `model_dir` | Path to the model folder, which stores checkpoints, params, log, etc. |
| `params` | The whole experiment parameters object. |
| `trainer` | The underlying Orbit Trainer object. |

<br />

## Methods

### `run`

[View source](https://github.com/tensorflow/models/blob/v2.20.0/official/core/train_lib.py#L253-L304)

    run() -> Tuple[tf_keras.Model, Mapping[str, Any]]

Run experiments by mode.

<br />

<br />

<br />

| Returns ||
|---|---|
| A 2-tuple of (model, eval_logs). model: `tf_keras.Model` instance. eval_logs: returns eval metrics logs when run_post_eval is set to True, otherwise, returns {}. ||

<br />