> 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.orchestration.job_render

What `gym job` prints: text for a person to read.

Every function takes data and returns a string, and imports nothing that talks to a scheduler, so what a
command prints can be checked without a cluster. The commands that call them are in `job.py`.

## Module Contents

### Functions

| Name                                                                            | Description |
| ------------------------------------------------------------------------------- | ----------- |
| [`_cancel_outcome`](#nemo_gym-orchestration-job_render-_cancel_outcome)         | -           |
| [`_table`](#nemo_gym-orchestration-job_render-_table)                           | -           |
| [`_time`](#nemo_gym-orchestration-job_render-_time)                             | -           |
| [`could_not_stop`](#nemo_gym-orchestration-job_render-could_not_stop)           | -           |
| [`render_cancel`](#nemo_gym-orchestration-job_render-render_cancel)             | -           |
| [`render_info`](#nemo_gym-orchestration-job_render-render_info)                 | -           |
| [`render_list`](#nemo_gym-orchestration-job_render-render_list)                 | -           |
| [`render_status`](#nemo_gym-orchestration-job_render-render_status)             | -           |
| [`render_status_block`](#nemo_gym-orchestration-job_render-render_status_block) | -           |

### API

```python
nemo_gym.orchestration.job_render._cancel_outcome(
    result: nemo_gym.orchestration.jobs.JobStatus
) -> str
```

```python
nemo_gym.orchestration.job_render._table(
    header: tuple[str, ...],
    rows: list[tuple[str, ...]]
) -> str
```

```python
nemo_gym.orchestration.job_render._time(
    submitted_at: str
) -> str
```

```python
nemo_gym.orchestration.job_render.could_not_stop(
    result: nemo_gym.orchestration.jobs.JobStatus
) -> bool
```

```python
nemo_gym.orchestration.job_render.render_cancel(
    results: list[nemo_gym.orchestration.jobs.JobStatus]
) -> str
```

```python
nemo_gym.orchestration.job_render.render_info(
    described: nemo_gym.orchestration.jobs.JobInfo,
    show_config: bool
) -> str
```

```python
nemo_gym.orchestration.job_render.render_list(
    records: list[nemo_gym.orchestration.jobs.SubmissionRecord]
) -> str
```

```python
nemo_gym.orchestration.job_render.render_status(
    results: list[nemo_gym.orchestration.jobs.SubmissionStatus],
    note: str | None = None
) -> str
```

```python
nemo_gym.orchestration.job_render.render_status_block(
    result: nemo_gym.orchestration.jobs.SubmissionStatus
) -> str
```