AI4COPSEC AI4COPSEC collekt
  • Home
  • Products
  • CLI
  • Credentials
  • Manifest
  • API reference

On this page

  • DatasetConfig
    • Methods
      • as_dict
      • from_dict
      • from_yaml
      • resolve

DatasetConfig

DatasetConfig(*datasets)

Datasets and provider parameters requested for one collection run.

Methods

Name Description
as_dict Return a YAML-serializable representation.
from_dict Build a dataset config from a mapping with a datasets list.
from_yaml Load a dataset-selection preset from YAML.
resolve Resolve selected datasets against the catalog.

as_dict

DatasetConfig.as_dict()

Return a YAML-serializable representation.

from_dict

DatasetConfig.from_dict(raw)

Build a dataset config from a mapping with a datasets list.

from_yaml

DatasetConfig.from_yaml(path)

Load a dataset-selection preset from YAML.

resolve

DatasetConfig.resolve(conf_dir=None)

Resolve selected datasets against the catalog.

Parameters

Name Type Description Default
conf_dir str | Path | None Optional configuration directory that extends the bundled catalog with additional or overriding dataset definitions. None

Returns

Name Type Description
Config Parsed configuration containing only the selected datasets.

Raises

Name Type Description
ValueError If a selected key is unknown, its provider does not match the catalog source kind, or a required variable/depth is missing.

Part of AI4COPSEC.

Built with Quarto.

GitHub