> This page is for version 0.5.1.
> For other versions, use one of these documentation indexes:
> - Main (default): https://docs.nvidia.com/nemo/gym/main/llms.txt
> - 0.7.0: https://docs.nvidia.com/nemo/gym/v0.7.0/llms.txt
> - 0.6.0: https://docs.nvidia.com/nemo/gym/v0.6.0/llms.txt
> - 0.5.1: https://docs.nvidia.com/nemo/gym/v0.5.1/llms.txt
> - 0.5.0: https://docs.nvidia.com/nemo/gym/v0.5.0/llms.txt
> - 0.4.0: https://docs.nvidia.com/nemo/gym/v0.4.0/llms.txt
> - 0.3.0: https://docs.nvidia.com/nemo/gym/v0.3.0/llms.txt
> - 0.2.1: https://docs.nvidia.com/nemo/gym/v0.2.1/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.nvidia.com/nemo/gym/llms.txt.

# nemo_gym.eval.comparison.planning.schema

Strict direct-input manifest and completed report contracts for repeat planning.

## Module Contents

### Classes

| Name                                                                                             | Description                                                                    |
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
| [`RepeatPlanningBaseline`](#nemo_gym-eval-comparison-planning-schema-RepeatPlanningBaseline)     | Whether baseline repeats are existing measurements or a planned investment.    |
| [`RepeatPlanningCLIConfig`](#nemo_gym-eval-comparison-planning-schema-RepeatPlanningCLIConfig)   | Plan fixed repeat counts from a YAML of normalized repeat standard deviations. |
| [`RepeatPlanningCell`](#nemo_gym-eval-comparison-planning-schema-RepeatPlanningCell)             | One normalized complete-repeat benchmark score for one model.                  |
| [`RepeatPlanningCellResult`](#nemo_gym-eval-comparison-planning-schema-RepeatPlanningCellResult) | -                                                                              |
| [`RepeatPlanningManifest`](#nemo_gym-eval-comparison-planning-schema-RepeatPlanningManifest)     | One fixed aggregate planned from direct normalized SD inputs.                  |
| [`RepeatPlanningResult`](#nemo_gym-eval-comparison-planning-schema-RepeatPlanningResult)         | Completed numerical results and resolved inputs for JSON and Markdown reports. |
| [`RepeatPlanningTotals`](#nemo_gym-eval-comparison-planning-schema-RepeatPlanningTotals)         | -                                                                              |
| [`_PlanningModel`](#nemo_gym-eval-comparison-planning-schema-_PlanningModel)                     | -                                                                              |

### Data

[`Name`](#nemo_gym-eval-comparison-planning-schema-Name)

[`StandardDeviation`](#nemo_gym-eval-comparison-planning-schema-StandardDeviation)

### API

```python
class nemo_gym.eval.comparison.planning.schema.RepeatPlanningBaseline()
```

**Bases:** [\_PlanningModel](#nemo_gym-eval-comparison-planning-schema-_PlanningModel)

Whether baseline repeats are existing measurements or a planned investment.

**`mode`** `Literal['optimize', 'existing'] = 'optimize'`

---

```python
class nemo_gym.eval.comparison.planning.schema.RepeatPlanningCLIConfig()
```

**Bases:** [BaseNeMoGymCLIConfig](/nemo/gym/nemo-gym/nemo_gym/config/config_types#nemo_gym-config-config_types-BaseNeMoGymCLIConfig)

Plan fixed repeat counts from a YAML of normalized repeat standard deviations.

**`output_dirpath`** `str | None`

---

**`repeat_plan_fpath`** `str`

---

**`report_format`** `ReportFormat`

---

```python
class nemo_gym.eval.comparison.planning.schema.RepeatPlanningCell()
```

**Bases:** [\_PlanningModel](#nemo_gym-eval-comparison-planning-schema-_PlanningModel)

One normalized complete-repeat benchmark score for one model.

For a multi-metric benchmark, normalize and equally average its metrics
within each repeat before estimating this score's SD across repeats.
An omitted candidate SD defaults to the baseline SD.

**`baseline_std_points`** `StandardDeviation`

---

**`benchmark`** `Name`

---

**`candidate_std_points`** `StandardDeviation | None = None`

---

**`existing_baseline_repeats`** `int | None = Field(default=None, strict=True, ge=2)`

---

**`model`** `Name`

---

**`repeat_cost`** `float`

---

**`repeat_step`** `int = Field(default=1, strict=True, ge=1)`

---

```python
class nemo_gym.eval.comparison.planning.schema.RepeatPlanningCellResult()
```

**Bases:** [\_PlanningModel](#nemo_gym-eval-comparison-planning-schema-_PlanningModel)

**`baseline_repeats`** `int`

---

**`baseline_std_points`** `float`

---

**`benchmark`** `str`

---

**`candidate_repeats_all_experiments`** `int`

---

**`candidate_repeats_per_experiment`** `int`

---

**`candidate_std_points`** `float`

---

**`existing_baseline_repeats`** `int`

---

**`model`** `str`

---

**`new_baseline_repeats`** `int`

---

**`new_repeat_cost`** `float`

---

**`repeat_cost`** `float`

---

**`repeat_step`** `int`

---

**`weight`** `float`

---

```python
class nemo_gym.eval.comparison.planning.schema.RepeatPlanningManifest()
```

**Bases:** [\_PlanningModel](#nemo_gym-eval-comparison-planning-schema-_PlanningModel)

One fixed aggregate planned from direct normalized SD inputs.

`benchmark` selects one model/benchmark cell, `model` selects cells of a
single model, and `suite` selects all declared cells. Every cell has equal
aggregate weight and supplies the SD of one complete-repeat benchmark score.

**`aggregation_level`** `Literal['benchmark', 'model', 'suite']`

---

**`alpha`** `float`

---

**`baseline`** `RepeatPlanningBaseline = Field(default_factory=RepeatPlanningBaseline)`

---

**`candidate_experiments`** `int = Field(default=1, strict=True, ge=1)`

---

**`cells`** `list[RepeatPlanningCell] = Field(min_length=1)`

---

**`expected_delta_points`** `float`

---

**`margin_points`** `float`

---

**`max_repeats`** `int = Field(default=20000, strict=True, ge=2)`

---

**`schema_version`** `Literal[1]`

---

**`seed`** `int = Field(default=20261109, strict=True, ge=0)`

---

**`target_power`** `float`

---

**`validation_trials`** `int = Field(default=10000, strict=True, ge=0)`

---

```python
nemo_gym.eval.comparison.planning.schema.RepeatPlanningManifest.validate_cells() -> nemo_gym.eval.comparison.planning.schema.RepeatPlanningManifest
```

```python
nemo_gym.eval.comparison.planning.schema.RepeatPlanningManifest.validate_version_type(
    value: object
) -> object
```

classmethod

```python
class nemo_gym.eval.comparison.planning.schema.RepeatPlanningResult()
```

**Bases:** [\_PlanningModel](#nemo_gym-eval-comparison-planning-schema-_PlanningModel)

Completed numerical results and resolved inputs for JSON and Markdown reports.

**`allocation`** `RepeatAllocation`

---

**`cells`** `list[RepeatPlanningCellResult]`

---

**`command`** `str`

---

**`generated_at`** `str`

---

**`nemo_gym_version`** `str`

---

**`plan_fpath`** `Path`

---

**`schema_version`** `Literal['1'] = '1'`

---

**`settings`** `RepeatPlanningManifest`

---

**`simulation`** `SimulationResult | None`

---

**`totals`** `RepeatPlanningTotals`

---

```python
class nemo_gym.eval.comparison.planning.schema.RepeatPlanningTotals()
```

**Bases:** [\_PlanningModel](#nemo_gym-eval-comparison-planning-schema-_PlanningModel)

**`candidate_passes_all_experiments`** `int`

---

**`candidate_passes_per_experiment`** `int`

---

**`existing_baseline_passes`** `int`

---

**`new_baseline_passes`** `int`

---

**`total_additional_passes`** `int`

---

**`total_cost`** `float`

---

```python
class nemo_gym.eval.comparison.planning.schema._PlanningModel()
```

**Bases:** `BaseModel`

**`model_config`** `= ConfigDict(extra='forbid')`

---

```python
nemo_gym.eval.comparison.planning.schema.Name = Annotated[str, StringConstraints(strip_whitespace=True, min_length=1, strict=Tru...
```

```python
nemo_gym.eval.comparison.planning.schema.StandardDeviation = Annotated[float, Field(strict=True, ge=0, allow_inf_nan=False)]
```