> 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.config_types

## Module Contents

### Classes

| Name                                                                                                                      | Description                                                                                             |
| ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
| [`AgentServerRef`](#nemo_gym-config_types-AgentServerRef)                                                                 | -                                                                                                       |
| [`AggregateMetrics`](#nemo_gym-config_types-AggregateMetrics)                                                             | Response from /aggregate\_metrics.                                                                      |
| [`AggregateMetricsRequest`](#nemo_gym-config_types-AggregateMetricsRequest)                                               | POST body for /aggregate\_metrics.                                                                      |
| [`BaseNeMoGymCLIConfig`](#nemo_gym-config_types-BaseNeMoGymCLIConfig)                                                     | -                                                                                                       |
| [`BaseRunServerConfig`](#nemo_gym-config_types-BaseRunServerConfig)                                                       | -                                                                                                       |
| [`BaseRunServerInstanceConfig`](#nemo_gym-config_types-BaseRunServerInstanceConfig)                                       | -                                                                                                       |
| [`BaseRunServerTypeConfig`](#nemo_gym-config_types-BaseRunServerTypeConfig)                                               | -                                                                                                       |
| [`BaseServerConfig`](#nemo_gym-config_types-BaseServerConfig)                                                             | -                                                                                                       |
| [`BaseServerInstanceConfig`](#nemo_gym-config_types-BaseServerInstanceConfig)                                             | -                                                                                                       |
| [`BaseServerTypeConfig`](#nemo_gym-config_types-BaseServerTypeConfig)                                                     | -                                                                                                       |
| [`BaseUploadJsonlDatasetHuggingFaceConfig`](#nemo_gym-config_types-BaseUploadJsonlDatasetHuggingFaceConfig)               | Upload a JSONL dataset to HuggingFace Hub with automatic naming based on domain and resources server.   |
| [`BenchmarkDatasetConfig`](#nemo_gym-config_types-BenchmarkDatasetConfig)                                                 | -                                                                                                       |
| [`DatasetConfig`](#nemo_gym-config_types-DatasetConfig)                                                                   | -                                                                                                       |
| [`DeleteJsonlDatasetGitlabConfig`](#nemo_gym-config_types-DeleteJsonlDatasetGitlabConfig)                                 | Delete a dataset from GitLab Model Registry (prompts for confirmation).                                 |
| [`Domain`](#nemo_gym-config_types-Domain)                                                                                 | -                                                                                                       |
| [`DownloadJsonlDatasetGitlabConfig`](#nemo_gym-config_types-DownloadJsonlDatasetGitlabConfig)                             | Download a JSONL dataset from GitLab Model Registry.                                                    |
| [`DownloadJsonlDatasetHuggingFaceConfig`](#nemo_gym-config_types-DownloadJsonlDatasetHuggingFaceConfig)                   | Download a JSONL dataset from HuggingFace Hub to local filesystem.                                      |
| [`JsonlDatasetGitlabIdentifer`](#nemo_gym-config_types-JsonlDatasetGitlabIdentifer)                                       | -                                                                                                       |
| [`JsonlDatasetHuggingFaceIdentifer`](#nemo_gym-config_types-JsonlDatasetHuggingFaceIdentifer)                             | -                                                                                                       |
| [`ModelServerRef`](#nemo_gym-config_types-ModelServerRef)                                                                 | -                                                                                                       |
| [`ResourcesServerInstanceConfig`](#nemo_gym-config_types-ResourcesServerInstanceConfig)                                   | -                                                                                                       |
| [`ResourcesServerRef`](#nemo_gym-config_types-ResourcesServerRef)                                                         | -                                                                                                       |
| [`ResourcesServerTypeConfig`](#nemo_gym-config_types-ResourcesServerTypeConfig)                                           | -                                                                                                       |
| [`ResponsesAPIAgentServerInstanceConfig`](#nemo_gym-config_types-ResponsesAPIAgentServerInstanceConfig)                   | -                                                                                                       |
| [`ResponsesAPIAgentServerTypeConfig`](#nemo_gym-config_types-ResponsesAPIAgentServerTypeConfig)                           | -                                                                                                       |
| [`ResponsesAPIModelServerInstanceConfig`](#nemo_gym-config_types-ResponsesAPIModelServerInstanceConfig)                   | -                                                                                                       |
| [`ResponsesAPIModelServerTypeConfig`](#nemo_gym-config_types-ResponsesAPIModelServerTypeConfig)                           | -                                                                                                       |
| [`UploadJsonlDatasetGitlabConfig`](#nemo_gym-config_types-UploadJsonlDatasetGitlabConfig)                                 | Upload a local jsonl dataset artifact to Gitlab.                                                        |
| [`UploadJsonlDatasetHuggingFaceConfig`](#nemo_gym-config_types-UploadJsonlDatasetHuggingFaceConfig)                       | Upload a JSONL dataset to HuggingFace Hub and automatically delete from GitLab after successful upload. |
| [`UploadJsonlDatasetHuggingFaceMaybeDeleteConfig`](#nemo_gym-config_types-UploadJsonlDatasetHuggingFaceMaybeDeleteConfig) | Upload a JSONL dataset to HuggingFace Hub with optional GitLab deletion after successful upload.        |
| [`WANDBConfig`](#nemo_gym-config_types-WANDBConfig)                                                                       | -                                                                                                       |

### Functions

| Name                                                                                          | Description                                                                       |
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| [`is_almost_server`](#nemo_gym-config_types-is_almost_server)                                 | Detects if a config looks like a server but might fail validation.                |
| [`is_server_ref`](#nemo_gym-config_types-is_server_ref)                                       | -                                                                                 |
| [`maybe_get_server_instance_config`](#nemo_gym-config_types-maybe_get_server_instance_config) | Returns ServerInstanceConfig if a valid server, otherwise None with error details |

### Data

[`AGENT_REF_KEY`](#nemo_gym-config_types-AGENT_REF_KEY)

[`DatasetType`](#nemo_gym-config_types-DatasetType)

[`ServerInstanceConfig`](#nemo_gym-config_types-ServerInstanceConfig)

[`ServerInstanceConfigTypeAdapter`](#nemo_gym-config_types-ServerInstanceConfigTypeAdapter)

[`ServerRef`](#nemo_gym-config_types-ServerRef)

[`ServerRefTypeAdapter`](#nemo_gym-config_types-ServerRefTypeAdapter)

[`ServerTypeConfig`](#nemo_gym-config_types-ServerTypeConfig)

### API

<Anchor id="nemo_gym-config_types-AgentServerRef">
  <CodeBlock showLineNumbers={false} wordWrap={true}>
    ```python
    class nemo_gym.config_types.AgentServerRef()
    ```
  </CodeBlock>
</Anchor>

<Indent>
  **Bases:** `BaseModel`

  <ParamField path="name" type="str" />

  <ParamField path="type" type="Literal['responses_api_agents']" />
</Indent>

<Anchor id="nemo_gym-config_types-AggregateMetrics">
  <CodeBlock showLineNumbers={false} wordWrap={true}>
    ```python
    class nemo_gym.config_types.AggregateMetrics()
    ```
  </CodeBlock>
</Anchor>

<Indent>
  **Bases:** `BaseModel`

  Response from /aggregate\_metrics.

  Flat string keys for direct logging to W\&B/MLflow.

  <ParamField path="agent_metrics" type="Dict[str, Any]" />

  <ParamField path="group_level_metrics" type="List[Dict[str, Any]]" />

  <ParamField path="key_metrics" type="Dict[str, Any]" />
</Indent>

<Anchor id="nemo_gym-config_types-AggregateMetricsRequest">
  <CodeBlock showLineNumbers={false} wordWrap={true}>
    ```python
    class nemo_gym.config_types.AggregateMetricsRequest()
    ```
  </CodeBlock>
</Anchor>

<Indent>
  **Bases:** `BaseModel`

  POST body for /aggregate\_metrics.

  Each item is a stripped verify response dict containing at minimum:

  * TASK\_INDEX\_KEY\_NAME: int
  * "reward": float

  <ParamField path="verify_responses" type="List[Dict[str, Any]]" />
</Indent>

<Anchor id="nemo_gym-config_types-BaseNeMoGymCLIConfig">
  <CodeBlock showLineNumbers={false} wordWrap={true}>
    ```python
    class nemo_gym.config_types.BaseNeMoGymCLIConfig()
    ```
  </CodeBlock>
</Anchor>

<Indent>
  **Bases:** `BaseModel`

  <Anchor id="nemo_gym-config_types-BaseNeMoGymCLIConfig-pre_process">
    <CodeBlock showLineNumbers={false} wordWrap={true}>
      ```python
      nemo_gym.config_types.BaseNeMoGymCLIConfig.pre_process(
          data
      )
      ```
    </CodeBlock>
  </Anchor>

  <Indent>
    <Badge>
      classmethod
    </Badge>
  </Indent>
</Indent>

<Anchor id="nemo_gym-config_types-BaseRunServerConfig">
  <CodeBlock showLineNumbers={false} wordWrap={true}>
    ```python
    class nemo_gym.config_types.BaseRunServerConfig()
    ```
  </CodeBlock>
</Anchor>

<Indent>
  **Bases:** [BaseServerConfig](#nemo_gym-config_types-BaseServerConfig)

  <ParamField path="domain" type="Optional[Domain] = None" />

  <ParamField path="entrypoint" type="str" />
</Indent>

<Anchor id="nemo_gym-config_types-BaseRunServerInstanceConfig">
  <CodeBlock showLineNumbers={false} wordWrap={true}>
    ```python
    class nemo_gym.config_types.BaseRunServerInstanceConfig()
    ```
  </CodeBlock>
</Anchor>

<Indent>
  **Bases:** [BaseRunServerConfig](#nemo_gym-config_types-BaseRunServerConfig)

  <ParamField path="name" type="str" />
</Indent>

<Anchor id="nemo_gym-config_types-BaseRunServerTypeConfig">
  <CodeBlock showLineNumbers={false} wordWrap={true}>
    ```python
    class nemo_gym.config_types.BaseRunServerTypeConfig()
    ```
  </CodeBlock>
</Anchor>

<Indent>
  **Bases:** [BaseRunServerConfig](#nemo_gym-config_types-BaseRunServerConfig)

  <ParamField path="datasets" type="Optional[List[Union[DatasetConfig, BenchmarkDatasetConfig]]] = None" />

  <ParamField path="host" type="Optional[str] = None" />

  <ParamField path="model_config" type="= ConfigDict(extra='allow')" />

  <ParamField path="port" type="Optional[int] = None" />
</Indent>

<Anchor id="nemo_gym-config_types-BaseServerConfig">
  <CodeBlock showLineNumbers={false} wordWrap={true}>
    ```python
    class nemo_gym.config_types.BaseServerConfig()
    ```
  </CodeBlock>
</Anchor>

<Indent>
  **Bases:** `BaseModel`

  <ParamField path="host" type="str" />

  <ParamField path="num_workers" type="Optional[int] = None" />

  <ParamField path="port" type="int" />
</Indent>

<Anchor id="nemo_gym-config_types-BaseServerInstanceConfig">
  <CodeBlock showLineNumbers={false} wordWrap={true}>
    ```python
    class nemo_gym.config_types.BaseServerInstanceConfig()
    ```
  </CodeBlock>
</Anchor>

<Indent>
  **Bases:** [BaseServerTypeConfig](#nemo_gym-config_types-BaseServerTypeConfig)

  <ParamField path="datasets" type="Optional[List[Union[DatasetConfig, BenchmarkDatasetConfig]]]" />

  <ParamField path="model_config" type="= ConfigDict(arbitrary_types_allowed=True)" />

  <ParamField path="name" type="str" />

  <ParamField path="server_type_config_dict" type="DictConfig = Field(exclude=True)" />

  <Anchor id="nemo_gym-config_types-BaseServerInstanceConfig-get_inner_run_server_config">
    <CodeBlock links={{"nemo_gym.config_types.BaseRunServerTypeConfig":"#nemo_gym-config_types-BaseRunServerTypeConfig"}} showLineNumbers={false} wordWrap={true}>
      ```python
      nemo_gym.config_types.BaseServerInstanceConfig.get_inner_run_server_config() -> nemo_gym.config_types.BaseRunServerTypeConfig
      ```
    </CodeBlock>
  </Anchor>

  <Indent />

  <Anchor id="nemo_gym-config_types-BaseServerInstanceConfig-get_inner_run_server_config_dict">
    <CodeBlock showLineNumbers={false} wordWrap={true}>
      ```python
      nemo_gym.config_types.BaseServerInstanceConfig.get_inner_run_server_config_dict() -> omegaconf.DictConfig
      ```
    </CodeBlock>
  </Anchor>

  <Indent />

  <Anchor id="nemo_gym-config_types-BaseServerInstanceConfig-get_server_ref">
    <CodeBlock links={{"nemo_gym.config_types.ServerRef":"#nemo_gym-config_types-ServerRef"}} showLineNumbers={false} wordWrap={true}>
      ```python
      nemo_gym.config_types.BaseServerInstanceConfig.get_server_ref() -> nemo_gym.config_types.ServerRef
      ```
    </CodeBlock>
  </Anchor>

  <Indent />

  <Anchor id="nemo_gym-config_types-BaseServerInstanceConfig-validate_domain_for_resources_server">
    <CodeBlock links={{"nemo_gym.config_types.BaseServerInstanceConfig":"#nemo_gym-config_types-BaseServerInstanceConfig"}} showLineNumbers={false} wordWrap={true}>
      ```python
      nemo_gym.config_types.BaseServerInstanceConfig.validate_domain_for_resources_server() -> nemo_gym.config_types.BaseServerInstanceConfig
      ```
    </CodeBlock>
  </Anchor>

  <Indent />
</Indent>

<Anchor id="nemo_gym-config_types-BaseServerTypeConfig">
  <CodeBlock showLineNumbers={false} wordWrap={true}>
    ```python
    class nemo_gym.config_types.BaseServerTypeConfig()
    ```
  </CodeBlock>
</Anchor>

<Indent>
  **Bases:** `BaseModel`

  <ParamField path="SERVER_TYPE" type="Union[Literal['responses_api_models'], Literal['resources_servers'], Literal['responses_api_agents']]" />
</Indent>

<Anchor id="nemo_gym-config_types-BaseUploadJsonlDatasetHuggingFaceConfig">
  <CodeBlock showLineNumbers={false} wordWrap={true}>
    ```python
    class nemo_gym.config_types.BaseUploadJsonlDatasetHuggingFaceConfig()
    ```
  </CodeBlock>
</Anchor>

<Indent>
  **Bases:** [BaseNeMoGymCLIConfig](#nemo_gym-config_types-BaseNeMoGymCLIConfig)

  Upload a JSONL dataset to HuggingFace Hub with automatic naming based on domain and resources server.

  Examples:

  <CodeBlock showLineNumbers={false}>
    ```python
    resource_config_path="resources_servers/example_multi_step/configs/example_multi_step.yaml"
    ng_upload_dataset_to_hf         +dataset_name=my_dataset         +input_jsonl_fpath=data/train.jsonl         +resource_config_path=${resource_config_path}
    ```
  </CodeBlock>

  <ParamField path="commit_description" type="Optional[str]" />

  <ParamField path="commit_message" type="Optional[str]" />

  <ParamField path="create_pr" type="bool" />

  <ParamField path="dataset_name" type="Optional[str]" />

  <ParamField path="hf_collection_name" type="str" />

  <ParamField path="hf_collection_slug" type="str" />

  <ParamField path="hf_dataset_prefix" type="str" />

  <ParamField path="hf_organization" type="str" />

  <ParamField path="hf_token" type="str" />

  <ParamField path="input_jsonl_fpath" type="str" />

  <ParamField path="resource_config_path" type="str" />

  <ParamField path="revision" type="Optional[str]" />

  <ParamField path="split" type="Literal['train', 'validation', 'test']" />
</Indent>

<Anchor id="nemo_gym-config_types-BenchmarkDatasetConfig">
  <CodeBlock showLineNumbers={false} wordWrap={true}>
    ```python
    class nemo_gym.config_types.BenchmarkDatasetConfig()
    ```
  </CodeBlock>
</Anchor>

<Indent>
  **Bases:** `BaseModel`

  <ParamField path="jsonl_fpath" type="Path" />

  <ParamField path="name" type="str" />

  <ParamField path="num_repeats" type="int = Field(default=1, ge=1)" />

  <ParamField path="prepare_script" type="Path" />

  <ParamField path="prompt_config" type="Optional[Path]" />

  <ParamField path="type" type="Literal['benchmark']" />
</Indent>

<Anchor id="nemo_gym-config_types-DatasetConfig">
  <CodeBlock showLineNumbers={false} wordWrap={true}>
    ```python
    class nemo_gym.config_types.DatasetConfig()
    ```
  </CodeBlock>
</Anchor>

<Indent>
  **Bases:** `BaseModel`

  <ParamField path="gitlab_identifier" type="Optional[JsonlDatasetGitlabIdentifer] = None" />

  <ParamField path="huggingface_identifier" type="Optional[JsonlDatasetHuggingFaceIdentifer] = None" />

  <ParamField path="jsonl_fpath" type="str" />

  <ParamField path="license" type="Optional[Union[Literal['Apache 2.0'], Literal['MIT'], Literal['Creative Commons Attribution 4.0 International'], Literal['Creative Commons Attribution-ShareAlike 4.0 International'], Literal['NVIDIA Internal Use Only, Do Not Distribute'], Literal['NVIDIA Evaluation Dataset License Agreement'], Literal['TBD'], Literal['GNU General Public License v3.0']]] = None" />

  <ParamField path="name" type="str" />

  <ParamField path="num_repeats" type="int = Field(default=1, ge=1)" />

  <ParamField path="type" type="DatasetType" />

  <Anchor id="nemo_gym-config_types-DatasetConfig-check_train_validation_sets">
    <CodeBlock links={{"nemo_gym.config_types.DatasetConfig":"#nemo_gym-config_types-DatasetConfig"}} showLineNumbers={false} wordWrap={true}>
      ```python
      nemo_gym.config_types.DatasetConfig.check_train_validation_sets() -> nemo_gym.config_types.DatasetConfig
      ```
    </CodeBlock>
  </Anchor>

  <Indent />
</Indent>

<Anchor id="nemo_gym-config_types-DeleteJsonlDatasetGitlabConfig">
  <CodeBlock showLineNumbers={false} wordWrap={true}>
    ```python
    class nemo_gym.config_types.DeleteJsonlDatasetGitlabConfig()
    ```
  </CodeBlock>
</Anchor>

<Indent>
  **Bases:** [BaseNeMoGymCLIConfig](#nemo_gym-config_types-BaseNeMoGymCLIConfig)

  Delete a dataset from GitLab Model Registry (prompts for confirmation).

  Examples:

  <CodeBlock showLineNumbers={false}>
    ```python
    ng_delete_dataset_from_gitlab +dataset_name=old_dataset
    ```
  </CodeBlock>

  <ParamField path="dataset_name" type="str" />
</Indent>

<Anchor id="nemo_gym-config_types-Domain">
  <CodeBlock showLineNumbers={false} wordWrap={true}>
    ```python
    class nemo_gym.config_types.Domain
    ```
  </CodeBlock>
</Anchor>

<Indent>
  **Bases:** `enum.Enum`

  <ParamField path="AGENT" type="= 'agent'" />

  <ParamField path="CODING" type="= 'coding'" />

  <ParamField path="E2E" type="= 'e2e'" />

  <ParamField path="GAMES" type="= 'games'" />

  <ParamField path="INSTRUCTION_FOLLOWING" type="= 'instruction_following'" />

  <ParamField path="KNOWLEDGE" type="= 'knowledge'" />

  <ParamField path="LONG_CONTEXT" type="= 'long_context'" />

  <ParamField path="MATH" type="= 'math'" />

  <ParamField path="OTHER" type="= 'other'" />

  <ParamField path="RLHF" type="= 'rlhf'" />

  <ParamField path="SAFETY" type="= 'safety'" />

  <ParamField path="TRANSLATION" type="= 'translation'" />
</Indent>

<Anchor id="nemo_gym-config_types-DownloadJsonlDatasetGitlabConfig">
  <CodeBlock showLineNumbers={false} wordWrap={true}>
    ```python
    class nemo_gym.config_types.DownloadJsonlDatasetGitlabConfig()
    ```
  </CodeBlock>
</Anchor>

<Indent>
  **Bases:** [JsonlDatasetGitlabIdentifer](#nemo_gym-config_types-JsonlDatasetGitlabIdentifer), [BaseNeMoGymCLIConfig](#nemo_gym-config_types-BaseNeMoGymCLIConfig)

  Download a JSONL dataset from GitLab Model Registry.

  Examples:

  <CodeBlock showLineNumbers={false}>
    ```python
    ng_download_dataset_from_gitlab         +dataset_name=example_multi_step         +version=0.0.1         +artifact_fpath=train.jsonl         +output_fpath=data/train.jsonl
    ```
  </CodeBlock>

  <ParamField path="artifact_fpath" type="str" />

  <ParamField path="dataset_name" type="str = Field(description='The dataset name.')" />

  <ParamField path="output_fpath" type="str" />

  <ParamField path="version" type="str" />
</Indent>

<Anchor id="nemo_gym-config_types-DownloadJsonlDatasetHuggingFaceConfig">
  <CodeBlock showLineNumbers={false} wordWrap={true}>
    ```python
    class nemo_gym.config_types.DownloadJsonlDatasetHuggingFaceConfig()
    ```
  </CodeBlock>
</Anchor>

<Indent>
  **Bases:** [JsonlDatasetHuggingFaceIdentifer](#nemo_gym-config_types-JsonlDatasetHuggingFaceIdentifer), [BaseNeMoGymCLIConfig](#nemo_gym-config_types-BaseNeMoGymCLIConfig)

  Download a JSONL dataset from HuggingFace Hub to local filesystem.

  Examples:

  <CodeBlock showLineNumbers={false}>
    ```python
    ng_download_dataset_from_hf         +repo_id=NVIDIA/NeMo-Gym-Math-example_multi_step-v1         +artifact_fpath=train.jsonl         +output_fpath=data/train.jsonl
    ```
  </CodeBlock>

  <ParamField path="hf_token" type="Optional[str]" />

  <ParamField path="output_dirpath" type="Optional[str]" />

  <ParamField path="output_fpath" type="Optional[str]" />

  <ParamField path="split" type="Optional[Literal['train', 'validation', 'test']]" />

  <Anchor id="nemo_gym-config_types-DownloadJsonlDatasetHuggingFaceConfig-check_output_path">
    <CodeBlock links={{"nemo_gym.config_types.DownloadJsonlDatasetHuggingFaceConfig":"#nemo_gym-config_types-DownloadJsonlDatasetHuggingFaceConfig"}} showLineNumbers={false} wordWrap={true}>
      ```python
      nemo_gym.config_types.DownloadJsonlDatasetHuggingFaceConfig.check_output_path() -> nemo_gym.config_types.DownloadJsonlDatasetHuggingFaceConfig
      ```
    </CodeBlock>
  </Anchor>

  <Indent />
</Indent>

<Anchor id="nemo_gym-config_types-JsonlDatasetGitlabIdentifer">
  <CodeBlock showLineNumbers={false} wordWrap={true}>
    ```python
    class nemo_gym.config_types.JsonlDatasetGitlabIdentifer()
    ```
  </CodeBlock>
</Anchor>

<Indent>
  **Bases:** `BaseModel`

  <ParamField path="artifact_fpath" type="str" />

  <ParamField path="dataset_name" type="str" />

  <ParamField path="version" type="str" />
</Indent>

<Anchor id="nemo_gym-config_types-JsonlDatasetHuggingFaceIdentifer">
  <CodeBlock showLineNumbers={false} wordWrap={true}>
    ```python
    class nemo_gym.config_types.JsonlDatasetHuggingFaceIdentifer()
    ```
  </CodeBlock>
</Anchor>

<Indent>
  **Bases:** `BaseModel`

  <ParamField path="artifact_fpath" type="Optional[str]" />

  <ParamField path="repo_id" type="str = Field(description='The repo id.')" />
</Indent>

<Anchor id="nemo_gym-config_types-ModelServerRef">
  <CodeBlock showLineNumbers={false} wordWrap={true}>
    ```python
    class nemo_gym.config_types.ModelServerRef()
    ```
  </CodeBlock>
</Anchor>

<Indent>
  **Bases:** `BaseModel`

  <ParamField path="name" type="str" />

  <ParamField path="type" type="Literal['responses_api_models']" />
</Indent>

<Anchor id="nemo_gym-config_types-ResourcesServerInstanceConfig">
  <CodeBlock showLineNumbers={false} wordWrap={true}>
    ```python
    class nemo_gym.config_types.ResourcesServerInstanceConfig()
    ```
  </CodeBlock>
</Anchor>

<Indent>
  **Bases:** [ResourcesServerTypeConfig](#nemo_gym-config_types-ResourcesServerTypeConfig), [BaseServerInstanceConfig](#nemo_gym-config_types-BaseServerInstanceConfig)
</Indent>

<Anchor id="nemo_gym-config_types-ResourcesServerRef">
  <CodeBlock showLineNumbers={false} wordWrap={true}>
    ```python
    class nemo_gym.config_types.ResourcesServerRef()
    ```
  </CodeBlock>
</Anchor>

<Indent>
  **Bases:** `BaseModel`

  <ParamField path="name" type="str" />

  <ParamField path="type" type="Literal['resources_servers']" />
</Indent>

<Anchor id="nemo_gym-config_types-ResourcesServerTypeConfig">
  <CodeBlock showLineNumbers={false} wordWrap={true}>
    ```python
    class nemo_gym.config_types.ResourcesServerTypeConfig()
    ```
  </CodeBlock>
</Anchor>

<Indent>
  **Bases:** [BaseServerTypeConfig](#nemo_gym-config_types-BaseServerTypeConfig)

  <ParamField path="SERVER_TYPE" type="Literal['resources_servers'] = 'resources_servers'" />

  <ParamField path="model_config" type="= ConfigDict(extra='allow')" />

  <ParamField path="resources_servers" type="Dict[str, BaseRunServerTypeConfig] = Field(min_length=1, max_length=1)" />
</Indent>

<Anchor id="nemo_gym-config_types-ResponsesAPIAgentServerInstanceConfig">
  <CodeBlock showLineNumbers={false} wordWrap={true}>
    ```python
    class nemo_gym.config_types.ResponsesAPIAgentServerInstanceConfig()
    ```
  </CodeBlock>
</Anchor>

<Indent>
  **Bases:** [ResponsesAPIAgentServerTypeConfig](#nemo_gym-config_types-ResponsesAPIAgentServerTypeConfig), [BaseServerInstanceConfig](#nemo_gym-config_types-BaseServerInstanceConfig)
</Indent>

<Anchor id="nemo_gym-config_types-ResponsesAPIAgentServerTypeConfig">
  <CodeBlock showLineNumbers={false} wordWrap={true}>
    ```python
    class nemo_gym.config_types.ResponsesAPIAgentServerTypeConfig()
    ```
  </CodeBlock>
</Anchor>

<Indent>
  **Bases:** [BaseServerTypeConfig](#nemo_gym-config_types-BaseServerTypeConfig)

  <ParamField path="SERVER_TYPE" type="Literal['responses_api_agents'] = 'responses_api_agents'" />

  <ParamField path="model_config" type="= ConfigDict(extra='allow')" />

  <ParamField path="responses_api_agents" type="Dict[str, BaseRunServerTypeConfig] = Field(min_length=1, max_length=1)" />
</Indent>

<Anchor id="nemo_gym-config_types-ResponsesAPIModelServerInstanceConfig">
  <CodeBlock showLineNumbers={false} wordWrap={true}>
    ```python
    class nemo_gym.config_types.ResponsesAPIModelServerInstanceConfig()
    ```
  </CodeBlock>
</Anchor>

<Indent>
  **Bases:** [ResponsesAPIModelServerTypeConfig](#nemo_gym-config_types-ResponsesAPIModelServerTypeConfig), [BaseServerInstanceConfig](#nemo_gym-config_types-BaseServerInstanceConfig)
</Indent>

<Anchor id="nemo_gym-config_types-ResponsesAPIModelServerTypeConfig">
  <CodeBlock showLineNumbers={false} wordWrap={true}>
    ```python
    class nemo_gym.config_types.ResponsesAPIModelServerTypeConfig()
    ```
  </CodeBlock>
</Anchor>

<Indent>
  **Bases:** [BaseServerTypeConfig](#nemo_gym-config_types-BaseServerTypeConfig)

  <ParamField path="SERVER_TYPE" type="Literal['responses_api_models'] = 'responses_api_models'" />

  <ParamField path="model_config" type="= ConfigDict(extra='allow')" />

  <ParamField path="responses_api_models" type="Dict[str, BaseRunServerTypeConfig] = Field(min_length=1, max_length=1)" />
</Indent>

<Anchor id="nemo_gym-config_types-UploadJsonlDatasetGitlabConfig">
  <CodeBlock showLineNumbers={false} wordWrap={true}>
    ```python
    class nemo_gym.config_types.UploadJsonlDatasetGitlabConfig()
    ```
  </CodeBlock>
</Anchor>

<Indent>
  **Bases:** [BaseNeMoGymCLIConfig](#nemo_gym-config_types-BaseNeMoGymCLIConfig)

  Upload a local jsonl dataset artifact to Gitlab.

  Examples:

  <CodeBlock showLineNumbers={false}>
    ```python
    ng_upload_dataset_to_gitlab         +dataset_name=example_multi_step         +version=0.0.1         +input_jsonl_fpath=data/train.jsonl
    ```
  </CodeBlock>

  <ParamField path="dataset_name" type="str = Field(description='The dataset name.')" />

  <ParamField path="input_jsonl_fpath" type="str" />

  <ParamField path="version" type="str" />
</Indent>

<Anchor id="nemo_gym-config_types-UploadJsonlDatasetHuggingFaceConfig">
  <CodeBlock showLineNumbers={false} wordWrap={true}>
    ```python
    class nemo_gym.config_types.UploadJsonlDatasetHuggingFaceConfig()
    ```
  </CodeBlock>
</Anchor>

<Indent>
  **Bases:** [BaseUploadJsonlDatasetHuggingFaceConfig](#nemo_gym-config_types-BaseUploadJsonlDatasetHuggingFaceConfig)

  Upload a JSONL dataset to HuggingFace Hub and automatically delete from GitLab after successful upload.

  This command always deletes the dataset from GitLab after uploading to HuggingFace.
  Use `ng_upload_dataset_to_hf` if you want optional deletion control.

  Examples:

  <CodeBlock showLineNumbers={false}>
    ```python
    resource_config_path="resources_servers/example_multi_step/configs/example_multi_step.yaml"
    ng_gitlab_to_hf_dataset         +dataset_name=my_dataset         +input_jsonl_fpath=data/train.jsonl         +resource_config_path=${resource_config_path}
    ```
  </CodeBlock>

  <ParamField path="forbidden_fields" type="Set[str] = {'delete_from_gitlab'}" />

  <Anchor id="nemo_gym-config_types-UploadJsonlDatasetHuggingFaceConfig-check_forbidden_fields">
    <CodeBlock showLineNumbers={false} wordWrap={true}>
      ```python
      nemo_gym.config_types.UploadJsonlDatasetHuggingFaceConfig.check_forbidden_fields(
          data
      )
      ```
    </CodeBlock>
  </Anchor>

  <Indent />
</Indent>

<Anchor id="nemo_gym-config_types-UploadJsonlDatasetHuggingFaceMaybeDeleteConfig">
  <CodeBlock showLineNumbers={false} wordWrap={true}>
    ```python
    class nemo_gym.config_types.UploadJsonlDatasetHuggingFaceMaybeDeleteConfig()
    ```
  </CodeBlock>
</Anchor>

<Indent>
  **Bases:** [BaseUploadJsonlDatasetHuggingFaceConfig](#nemo_gym-config_types-BaseUploadJsonlDatasetHuggingFaceConfig)

  Upload a JSONL dataset to HuggingFace Hub with optional GitLab deletion after successful upload.

  Examples:

  <CodeBlock showLineNumbers={false}>
    ```python
    resource_config_path="resources_servers/example_multi_step/configs/example_multi_step.yaml"
    ng_upload_dataset_to_hf         +dataset_name=my_dataset         +input_jsonl_fpath=data/train.jsonl         +resource_config_path=${resource_config_path}         +delete_from_gitlab=true
    ```
  </CodeBlock>

  <ParamField path="delete_from_gitlab" type="Optional[bool]" />
</Indent>

<Anchor id="nemo_gym-config_types-WANDBConfig">
  <CodeBlock showLineNumbers={false} wordWrap={true}>
    ```python
    class nemo_gym.config_types.WANDBConfig()
    ```
  </CodeBlock>
</Anchor>

<Indent>
  **Bases:** `BaseModel`

  <ParamField path="is_available" type="bool" />

  <ParamField path="wandb_api_key" type="Optional[str] = None" />

  <ParamField path="wandb_name" type="Optional[str] = None" />

  <ParamField path="wandb_project" type="Optional[str] = None" />
</Indent>

<Anchor id="nemo_gym-config_types-is_almost_server">
  <CodeBlock showLineNumbers={false} wordWrap={true}>
    ```python
    nemo_gym.config_types.is_almost_server(
        server_type_config_dict: typing.Any
    ) -> bool
    ```
  </CodeBlock>
</Anchor>

<Indent>
  Detects if a config looks like a server but might fail validation.
</Indent>

<Anchor id="nemo_gym-config_types-is_server_ref">
  <CodeBlock links={{"nemo_gym.config_types.ServerRef":"#nemo_gym-config_types-ServerRef"}} showLineNumbers={false} wordWrap={true}>
    ```python
    nemo_gym.config_types.is_server_ref(
        config_dict: omegaconf.DictConfig
    ) -> typing.Optional[nemo_gym.config_types.ServerRef]
    ```
  </CodeBlock>
</Anchor>

<Indent />

<Anchor id="nemo_gym-config_types-maybe_get_server_instance_config">
  <CodeBlock links={{"nemo_gym.config_types.ServerInstanceConfig":"#nemo_gym-config_types-ServerInstanceConfig"}} showLineNumbers={false} wordWrap={true}>
    ```python
    nemo_gym.config_types.maybe_get_server_instance_config(
        name: str,
        server_type_config_dict: typing.Any
    ) -> typing.Tuple[typing.Optional[nemo_gym.config_types.ServerInstanceConfig], typing.Optional[pydantic.ValidationError]]
    ```
  </CodeBlock>
</Anchor>

<Indent>
  Returns ServerInstanceConfig if a valid server, otherwise None with error details
</Indent>

<Anchor id="nemo_gym-config_types-AGENT_REF_KEY">
  <CodeBlock showLineNumbers={false} wordWrap={true}>
    ```python
    nemo_gym.config_types.AGENT_REF_KEY = 'agent_ref'
    ```
  </CodeBlock>
</Anchor>

<Anchor id="nemo_gym-config_types-DatasetType">
  <CodeBlock showLineNumbers={false} wordWrap={true}>
    ```python
    nemo_gym.config_types.DatasetType = Union[Literal['train'], Literal['validation'], Literal['example']]
    ```
  </CodeBlock>
</Anchor>

<Anchor id="nemo_gym-config_types-ServerInstanceConfig">
  <CodeBlock showLineNumbers={false} wordWrap={true}>
    ```python
    nemo_gym.config_types.ServerInstanceConfig = Union[ResponsesAPIModelServerInstanceConfig, ResourcesServerInstanceConfig, Resp...
    ```
  </CodeBlock>
</Anchor>

<Anchor id="nemo_gym-config_types-ServerInstanceConfigTypeAdapter">
  <CodeBlock showLineNumbers={false} wordWrap={true}>
    ```python
    nemo_gym.config_types.ServerInstanceConfigTypeAdapter = TypeAdapter(ServerInstanceConfig)
    ```
  </CodeBlock>
</Anchor>

<Anchor id="nemo_gym-config_types-ServerRef">
  <CodeBlock showLineNumbers={false} wordWrap={true}>
    ```python
    nemo_gym.config_types.ServerRef = Union[ModelServerRef, ResourcesServerRef, AgentServerRef]
    ```
  </CodeBlock>
</Anchor>

<Anchor id="nemo_gym-config_types-ServerRefTypeAdapter">
  <CodeBlock showLineNumbers={false} wordWrap={true}>
    ```python
    nemo_gym.config_types.ServerRefTypeAdapter = TypeAdapter(ServerRef)
    ```
  </CodeBlock>
</Anchor>

<Anchor id="nemo_gym-config_types-ServerTypeConfig">
  <CodeBlock showLineNumbers={false} wordWrap={true}>
    ```python
    nemo_gym.config_types.ServerTypeConfig = Union[ResponsesAPIModelServerTypeConfig, ResourcesServerTypeConfig, ResponsesAPI...
    ```
  </CodeBlock>
</Anchor>