> This page is for version 0.7.0.
> 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_commands

`gym job`: look at, stop and read the logs of the runs `gym eval submit` queued.

`list` reads this machine's job index and nothing else. `status` asks the scheduler for what is happening,
`info` describes one submission and where its parts are, `cancel` stops a benchmark or a whole submission,
and `logs` prints one of a benchmark's logs. What they print is rendered by `job_render.py`.

## Module Contents

### Functions

| Name                                                                    | Description                                                                                         |
| ----------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| [`_only`](#nemo_gym-orchestration-job_commands-_only)                   | `submission` narrowed to its live jobs, with a state and counts that describe only those.           |
| [`cancel_command`](#nemo_gym-orchestration-job_commands-cancel_command) | Stop one benchmark, or with `everything` every live benchmark after the id is typed; the exit code. |
| [`info_command`](#nemo_gym-orchestration-job_commands-info_command)     | -                                                                                                   |
| [`list_command`](#nemo_gym-orchestration-job_commands-list_command)     | -                                                                                                   |
| [`logs_command`](#nemo_gym-orchestration-job_commands-logs_command)     | -                                                                                                   |
| [`status_command`](#nemo_gym-orchestration-job_commands-status_command) | -                                                                                                   |

### API

```python
nemo_gym.orchestration.job_commands._only(
    submission: nemo_gym.orchestration.jobs.SubmissionStatus,
    live: list[nemo_gym.orchestration.jobs.JobStatus]
) -> nemo_gym.orchestration.jobs.SubmissionStatus
```

`submission` narrowed to its live jobs, with a state and counts that describe only those.

```python
nemo_gym.orchestration.job_commands.cancel_command(
    gym_job_id: str,
    benchmark: str | None,
    everything: bool,
    confirm: str | None,
    as_json: bool
) -> int
```

Stop one benchmark, or with `everything` every live benchmark after the id is typed; the exit code.

```python
nemo_gym.orchestration.job_commands.info_command(
    gym_job_id: str,
    benchmark: str | None,
    show_config: bool,
    as_json: bool
) -> None
```

```python
nemo_gym.orchestration.job_commands.list_command(
    limit: int | None,
    as_json: bool
) -> None
```

```python
nemo_gym.orchestration.job_commands.logs_command(
    gym_job_id: str,
    benchmark: str,
    source: str,
    instance: str | None,
    tail: int | None
) -> None
```

```python
nemo_gym.orchestration.job_commands.status_command(
    ids: list[str],
    benchmarks: list[str] | None,
    limit: int | None,
    as_json: bool
) -> None
```