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

## Module Contents

### Classes

| Name                                                         | Description                                                             |
| ------------------------------------------------------------ | ----------------------------------------------------------------------- |
| [`ServerMetadata`](#nemo_gym-server_metadata-ServerMetadata) | Metadata extracted from a resources-server or agent-server YAML config. |

### Functions

| Name                                                                         | Description                                       |
| ---------------------------------------------------------------------------- | ------------------------------------------------- |
| [`_visit_server`](#nemo_gym-server_metadata-_visit_server)                   | -                                                 |
| [`visit_agent_server`](#nemo_gym-server_metadata-visit_agent_server)         | Extract agent server metadata from YAML data.     |
| [`visit_resources_server`](#nemo_gym-server_metadata-visit_resources_server) | Extract resources server metadata from YAML data. |

### API

<Anchor id="nemo_gym-server_metadata-ServerMetadata">
  <CodeBlock showLineNumbers={false} wordWrap={true}>
    ```python
    class nemo_gym.server_metadata.ServerMetadata(
        domain: typing.Optional[str] = None,
        description: typing.Optional[str] = None,
        verified: bool = False,
        verified_url: typing.Optional[str] = None,
        value: typing.Optional[str] = None
    )
    ```
  </CodeBlock>
</Anchor>

<Indent>
  <Badge>
    Dataclass
  </Badge>

  Metadata extracted from a resources-server or agent-server YAML config.

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

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

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

  <ParamField path="verified" type="bool = False" />

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

  <Anchor id="nemo_gym-server_metadata-ServerMetadata-to_dict">
    <CodeBlock showLineNumbers={false} wordWrap={true}>
      ```python
      nemo_gym.server_metadata.ServerMetadata.to_dict() -> dict[str, str | bool | None]
      ```
    </CodeBlock>
  </Anchor>

  <Indent>
    Convert to dict for backward compatibility with hf\_utils.py
  </Indent>
</Indent>

<Anchor id="nemo_gym-server_metadata-_visit_server">
  <CodeBlock links={{"nemo_gym.server_metadata.ServerMetadata":"#nemo_gym-server_metadata-ServerMetadata"}} showLineNumbers={false} wordWrap={true}>
    ```python
    nemo_gym.server_metadata._visit_server(
        data: dict,
        server_type_key: str,
        level: int = 1
    ) -> nemo_gym.server_metadata.ServerMetadata
    ```
  </CodeBlock>
</Anchor>

<Indent />

<Anchor id="nemo_gym-server_metadata-visit_agent_server">
  <CodeBlock links={{"nemo_gym.server_metadata.ServerMetadata":"#nemo_gym-server_metadata-ServerMetadata"}} showLineNumbers={false} wordWrap={true}>
    ```python
    nemo_gym.server_metadata.visit_agent_server(
        data: dict,
        level: int = 1
    ) -> nemo_gym.server_metadata.ServerMetadata
    ```
  </CodeBlock>
</Anchor>

<Indent>
  Extract agent server metadata from YAML data.
</Indent>

<Anchor id="nemo_gym-server_metadata-visit_resources_server">
  <CodeBlock links={{"nemo_gym.server_metadata.ServerMetadata":"#nemo_gym-server_metadata-ServerMetadata"}} showLineNumbers={false} wordWrap={true}>
    ```python
    nemo_gym.server_metadata.visit_resources_server(
        data: dict,
        level: int = 1
    ) -> nemo_gym.server_metadata.ServerMetadata
    ```
  </CodeBlock>
</Anchor>

<Indent>
  Extract resources server metadata from YAML data.
</Indent>