> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.nvidia.com/nemo/datadesigner/llms.txt.
> For full documentation content, see https://docs.nvidia.com/nemo/datadesigner/llms-full.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.nvidia.com/nemo/datadesigner/_mcp/server.

# data\_designer.config.seed\_source

## Module Contents

### Classes

| Name                                                                              | Description                                                                 |
| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
| [`SeedSource`](#data_designerconfigseed_sourceseedsource)                         | Base class for seed dataset configurations.                                 |
| [`LocalFileSeedSource`](#data_designerconfigseed_sourcelocalfileseedsource)       | Base class for seed dataset configurations.                                 |
| [`HuggingFaceSeedSource`](#data_designerconfigseed_sourcehuggingfaceseedsource)   | Base class for seed dataset configurations.                                 |
| [`FileSystemSeedSource`](#data_designerconfigseed_sourcefilesystemseedsource)     | Base class for seed sources backed by a directory of files.                 |
| [`DirectorySeedSource`](#data_designerconfigseed_sourcedirectoryseedsource)       | Base class for seed sources backed by a directory of files.                 |
| [`FileContentsSeedSource`](#data_designerconfigseed_sourcefilecontentsseedsource) | Base class for seed sources backed by a directory of files.                 |
| [`AgentRolloutFormat`](#data_designerconfigseed_sourceagentrolloutformat)         | str(object='') -> str str(bytes\_or\_buffer\[, encoding\[, errors]]) -> str |
| [`AgentRolloutSeedSource`](#data_designerconfigseed_sourceagentrolloutseedsource) | Base class for seed sources backed by a directory of files.                 |

### Functions

| Name                                                                                                                            | Description |
| ------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| [`_resolve_filesystem_runtime_path`](#data_designerconfigseed_source_resolve_filesystem_runtime_path)                           | None        |
| [`_resolve_local_file_runtime_path`](#data_designerconfigseed_source_resolve_local_file_runtime_path)                           | None        |
| [`get_claude_code_default_path`](#data_designerconfigseed_sourceget_claude_code_default_path)                                   | None        |
| [`get_codex_default_path`](#data_designerconfigseed_sourceget_codex_default_path)                                               | None        |
| [`get_hermes_agent_default_path`](#data_designerconfigseed_sourceget_hermes_agent_default_path)                                 | None        |
| [`get_pi_coding_agent_default_path`](#data_designerconfigseed_sourceget_pi_coding_agent_default_path)                           | None        |
| [`_validate_filesystem_seed_source_path`](#data_designerconfigseed_source_validate_filesystem_seed_source_path)                 | None        |
| [`_validate_filesystem_seed_source_file_pattern`](#data_designerconfigseed_source_validate_filesystem_seed_source_file_pattern) | None        |
| [`get_agent_rollout_format_defaults`](#data_designerconfigseed_sourceget_agent_rollout_format_defaults)                         | None        |

### API

```python
class data_designer.config.seed_source.SeedSource(
    /,
    **data: typing.Any
)
```

**Bases**: `pydantic.BaseModel`, `abc.ABC`

Base class for seed dataset configurations.

All subclasses must define a `seed_type` field with a Literal value.
This serves as a discriminated union discriminator.

**Parameters:**

Discriminator field that identifies the specific seed source type.
Subclasses must override this field with a `Literal` value.

**Attributes:**

Discriminator field that identifies the specific seed source type.
Subclasses must override this field with a `Literal` value.

**Initialization:**

Create a new model by parsing and validating input data from keyword arguments.

Raises \[`ValidationError`]\[pydantic\_core.ValidationError] if the input data cannot be
validated to form a valid model.

`self` is explicitly positional-only to allow `self` as a field name.

```python
seed_type: str
```

```python
class data_designer.config.seed_source.LocalFileSeedSource(
    /,
    **data: typing.Any
)
```

**Bases**: `data_designer.config.seed_source.SeedSource`

```python
seed_type: typing.Literal[local] = local
```

```python
_runtime_path: str | None = PrivateAttr(...)
```

```python
path: str = Field(...)
```

```python
validate_path(v: str) -> str
```

```python
model_post_init(__context: typing.Any) -> None
```

```python
runtime_path: str
```

```python
from_dataframe(
    df: pandas.DataFrame,
    path: str
) -> typing_extensions.Self
```

```python
class data_designer.config.seed_source.HuggingFaceSeedSource(
    /,
    **data: typing.Any
)
```

**Bases**: `data_designer.config.seed_source.SeedSource`

```python
seed_type: typing.Literal[hf] = hf
```

```python
path: str = Field(...)
```

```python
token: str | None
```

```python
endpoint: str = https://huggingface.co
```

```python
class data_designer.config.seed_source.FileSystemSeedSource(
    /,
    **data: typing.Any
)
```

**Bases**: `data_designer.config.seed_source.SeedSource`, `abc.ABC`

Base class for seed sources backed by a directory of files.

Use this base when a seed reader needs to enumerate files under a directory
on disk and turn each (or groups of them) into seed rows. Concrete plugin
configs declare a `Literal` `seed_type` and pair with a
`FileSystemSeedReader` implementation.

**Parameters:**

Directory containing seed artifacts. Relative paths are resolved
from the current working directory when the config is loaded, not
from the config file location.

Case-sensitive filename pattern used to match files under
the provided directory. Patterns match basenames only, not relative
paths. Defaults to `'*'`.

Whether to search nested subdirectories under the provided
directory for matching files. Defaults to `True`.

**Attributes:**

Directory containing seed artifacts. Relative paths are resolved
from the current working directory when the config is loaded, not
from the config file location.

Case-sensitive filename pattern used to match files under
the provided directory. Patterns match basenames only, not relative
paths. Defaults to `'*'`.

Whether to search nested subdirectories under the provided
directory for matching files. Defaults to `True`.

**Initialization:**

Create a new model by parsing and validating input data from keyword arguments.

Raises \[`ValidationError`]\[pydantic\_core.ValidationError] if the input data cannot be
validated to form a valid model.

`self` is explicitly positional-only to allow `self` as a field name.

```python
_runtime_path: str | None = PrivateAttr(...)
```

```python
path: str = Field(...)
```

```python
file_pattern: str = Field(...)
```

```python
recursive: bool = Field(...)
```

```python
validate_path(value: str | None) -> str | None
```

```python
model_post_init(__context: typing.Any) -> None
```

```python
runtime_path: str
```

```python
validate_file_pattern(value: str | None) -> str | None
```

```python
class data_designer.config.seed_source.DirectorySeedSource(
    /,
    **data: typing.Any
)
```

**Bases**: `data_designer.config.seed_source.FileSystemSeedSource`

```python
seed_type: typing.Literal[directory] = directory
```

```python
class data_designer.config.seed_source.FileContentsSeedSource(
    /,
    **data: typing.Any
)
```

**Bases**: `data_designer.config.seed_source.FileSystemSeedSource`

```python
seed_type: typing.Literal[file_contents] = file_contents
```

```python
encoding: str = Field(...)
```

```python
validate_encoding(value: str) -> str
```

```python
data_designer.config.seed_source._resolve_filesystem_runtime_path(path: str) -> str
```

```python
data_designer.config.seed_source._resolve_local_file_runtime_path(path: str) -> str
```

```python
data_designer.config.seed_source.get_claude_code_default_path() -> str
```

```python
data_designer.config.seed_source.get_codex_default_path() -> str
```

```python
data_designer.config.seed_source.get_hermes_agent_default_path() -> str
```

```python
data_designer.config.seed_source.get_pi_coding_agent_default_path() -> str
```

```python
data_designer.config.seed_source._validate_filesystem_seed_source_path(value: str | None) -> str | None
```

```python
data_designer.config.seed_source._validate_filesystem_seed_source_file_pattern(value: str | None) -> str | None
```

```python
class data_designer.config.seed_source.AgentRolloutFormat
```

**Bases**: `data_designer.config.utils.type_helpers.StrEnum`

```python
ATIF = atif
```

```python
CLAUDE_CODE = claude_code
```

```python
CODEX = codex
```

```python
HERMES_AGENT = hermes_agent
```

```python
PI_CODING_AGENT = pi_coding_agent
```

```python
data_designer.config.seed_source.get_agent_rollout_format_defaults(fmt: data_designer.config.seed_source.AgentRolloutFormat) -> tuple[str | None, str]
```

```python
class data_designer.config.seed_source.AgentRolloutSeedSource(
    /,
    **data: typing.Any
)
```

**Bases**: `data_designer.config.seed_source.FileSystemSeedSource`

```python
seed_type: typing.Literal[agent_rollout] = agent_rollout
```

```python
format: data_designer.config.seed_source.AgentRolloutFormat = Field(...)
```

```python
path: str | None = Field(...)
```

```python
file_pattern: str | None = Field(...)
```

```python
validate_runtime_path_source() -> typing_extensions.Self
```

```python
runtime_path: str
```

```python
resolved_file_pattern: str
```