> 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.
> For full documentation content, see https://docs.nvidia.com/nemo/gym/llms-full.txt.

# nemo_gym

## Submodules

* **[`nemo_gym.base_resources_server`](/nemo-gym/nemo_gym/base_resources_server)**
* **[`nemo_gym.base_responses_api_agent`](/nemo-gym/nemo_gym/base_responses_api_agent)**
* **[`nemo_gym.base_responses_api_model`](/nemo-gym/nemo_gym/base_responses_api_model)**
* **[`nemo_gym.benchmarks`](/nemo-gym/nemo_gym/benchmarks)**
* **[`nemo_gym.cli`](/nemo-gym/nemo_gym/cli)**
* **[`nemo_gym.cli_setup_command`](/nemo-gym/nemo_gym/cli_setup_command)**
* **[`nemo_gym.config_types`](/nemo-gym/nemo_gym/config_types)**
* **[`nemo_gym.dataset_orchestrator`](/nemo-gym/nemo_gym/dataset_orchestrator)**
* **[`nemo_gym.gitlab_utils`](/nemo-gym/nemo_gym/gitlab_utils)**
* **[`nemo_gym.global_config`](/nemo-gym/nemo_gym/global_config)**
* **[`nemo_gym.hf_utils`](/nemo-gym/nemo_gym/hf_utils)**
* **[`nemo_gym.openai_utils`](/nemo-gym/nemo_gym/openai_utils)**
* **[`nemo_gym.package_info`](/nemo-gym/nemo_gym/package_info)**
* **[`nemo_gym.profiling`](/nemo-gym/nemo_gym/profiling)**
* **[`nemo_gym.prompt`](/nemo-gym/nemo_gym/prompt)**
* **[`nemo_gym.reward_profile`](/nemo-gym/nemo_gym/reward_profile)**
* **[`nemo_gym.rollout_collection`](/nemo-gym/nemo_gym/rollout_collection)**
* **[`nemo_gym.server_metadata`](/nemo-gym/nemo_gym/server_metadata)**
* **[`nemo_gym.server_status`](/nemo-gym/nemo_gym/server_status)**
* **[`nemo_gym.server_utils`](/nemo-gym/nemo_gym/server_utils)**
* **[`nemo_gym.train_data_utils`](/nemo-gym/nemo_gym/train_data_utils)**

## Package Contents

### Functions

| Name                                                     | Description |
| -------------------------------------------------------- | ----------- |
| [`print_always_flushes`](#nemo_gym-print_always_flushes) | -           |

### Data

[`CACHE_DIR`](#nemo_gym-CACHE_DIR)

[`OLD_PRINT`](#nemo_gym-OLD_PRINT)

[`PARENT_DIR`](#nemo_gym-PARENT_DIR)

[`RESULTS_DIR`](#nemo_gym-RESULTS_DIR)

[`ROOT_DIR`](#nemo_gym-ROOT_DIR)

[`WORKING_DIR`](#nemo_gym-WORKING_DIR)

[`_is_editable_install`](#nemo_gym-_is_editable_install)

### API

<Anchor id="nemo_gym-print_always_flushes">
  <CodeBlock showLineNumbers={false} wordWrap={true}>
    ```python
    nemo_gym.print_always_flushes(
        args = (),
        kwargs = {}
    ) -> None
    ```
  </CodeBlock>
</Anchor>

<Indent />

<Anchor id="nemo_gym-CACHE_DIR">
  <CodeBlock showLineNumbers={false} wordWrap={true}>
    ```python
    nemo_gym.CACHE_DIR = WORKING_DIR / 'cache'
    ```
  </CodeBlock>
</Anchor>

<Anchor id="nemo_gym-OLD_PRINT">
  <CodeBlock showLineNumbers={false} wordWrap={true}>
    ```python
    nemo_gym.OLD_PRINT = print
    ```
  </CodeBlock>
</Anchor>

<Anchor id="nemo_gym-PARENT_DIR">
  <CodeBlock showLineNumbers={false} wordWrap={true}>
    ```python
    nemo_gym.PARENT_DIR = ROOT_DIR.parent
    ```
  </CodeBlock>
</Anchor>

<Anchor id="nemo_gym-RESULTS_DIR">
  <CodeBlock showLineNumbers={false} wordWrap={true}>
    ```python
    nemo_gym.RESULTS_DIR = WORKING_DIR / 'results'
    ```
  </CodeBlock>
</Anchor>

<Anchor id="nemo_gym-ROOT_DIR">
  <CodeBlock showLineNumbers={false} wordWrap={true}>
    ```python
    nemo_gym.ROOT_DIR = Path(__file__).absolute().parent
    ```
  </CodeBlock>
</Anchor>

<Anchor id="nemo_gym-WORKING_DIR">
  <CodeBlock showLineNumbers={false} wordWrap={true}>
    ```python
    nemo_gym.WORKING_DIR = PARENT_DIR if _is_editable_install else Path.cwd()
    ```
  </CodeBlock>
</Anchor>

<Anchor id="nemo_gym-_is_editable_install">
  <CodeBlock showLineNumbers={false} wordWrap={true}>
    ```python
    nemo_gym._is_editable_install = (PARENT_DIR / 'pyproject.toml').exists()
    ```
  </CodeBlock>
</Anchor>