hlsfactory.design_config

Module Contents

Classes

FlowName
FlowConfig	Configuration for a single tool flow defined in hlsfactory.toml.
DesignConfig	In-memory representation of hlsfactory.toml.

Functions

_ensure_non_empty_str
_ensure_str_sequence
_ensure_str_mapping
_normalise_flow_name
read_design_config	Parse an hlsfactory.toml file into a DesignConfig.
write_design_config	Serialize a DesignConfig to TOML.
_quote_toml_string

Data

DESIGN_CONFIG_FILENAME
__all__

API

exception hlsfactory.design_config.DesignConfigError

Bases: ValueError

Raised when a design configuration is invalid.

Initialization

Initialize self. See help(type(self)) for accurate signature.

exception hlsfactory.design_config.FlowConfigError

Bases: ValueError

Raised when a flow configuration is invalid.

Initialization

Initialize self. See help(type(self)) for accurate signature.

hlsfactory.design_config.DESIGN_CONFIG_FILENAME = 'hlsfactory.toml'

class hlsfactory.design_config.FlowName

Bases: enum.StrEnum

ALTERA_HLS_SYNTH = 'AlteraHLSSynthFlow'

ALTERA_HLS_CSIM = 'AlteraHLSCsimFlow'

ALTERA_HLS_COSIM = 'AlteraHLSCosimFlow'

ALTERA_QUARTUS_IMPL = 'AlteraQuartusImplFlow'

OPT_DSL_V2 = 'OptDSLv2'

CATAPULT_HLS_SYNTH = 'CatapultHLSSynthFlow'

STRATUS_HLS_SYNTH = 'StratusHLSSynthFlow'

XLS_HLS_SYNTH = 'XLSHLSSynthFlow'

VITIS_HLS_SYNTH = 'VitisHLSSynthFlow'

VITIS_HLS_CSIM = 'VitisHLSCsimFlow'

VITIS_HLS_IMPL = 'VitisHLSImplFlow'

VITIS_HLS_COSIM = 'VitisHLSCosimFlow'

VITIS_HLS_COSIM_SETUP = 'VitisHLSCosimSetupFlow'

VITIS_HLS_IMPL_REPORT = 'VitisHLSImplReportFlow'

VITIS_HLS_MODERN_SYNTH = 'VitisHLSModernSynthFlow'

VITIS_HLS_MODERN_CSIM = 'VitisHLSModernCsimFlow'

HARP_GRAPH = 'HARPGraphFlow'

BALOR_GRAPH = 'BalorGraphFlow'

LIGHTNING_SIM = 'LightningSimFlow'

hlsfactory.design_config._ensure_non_empty_str(value: Any, *, field_name: str, error_cls: type[Exception] = DesignConfigError) → str

hlsfactory.design_config._ensure_str_sequence(values: collections.abc.Iterable[Any], *, field_name: str, error_cls: type[Exception] = DesignConfigError) → list[str]

hlsfactory.design_config._ensure_str_mapping(values: collections.abc.Mapping[Any, Any], *, field_name: str, error_cls: type[Exception] = DesignConfigError) → dict[str, str]

hlsfactory.design_config._normalise_flow_name(flow_name: str | hlsfactory.design_config.FlowName) → str

class hlsfactory.design_config.FlowConfig

Configuration for a single tool flow defined in hlsfactory.toml.

flow_name: str = None

flow_settings: dict[str, str] = 'field(...)'

_REQUIRED_SETTINGS: ClassVar[dict[str, frozenset[str]]] = None

__post_init__() → None

property required_settings: frozenset[str]

property is_known_flow: bool

has_setting(key: str) → bool

get_setting(key: str, default: str | None = None) → str | None

require_setting(key: str) → str

_validate_required_settings() → None

classmethod from_mapping(data: collections.abc.Mapping[str, Any]) → hlsfactory.design_config.FlowConfig

class hlsfactory.design_config.DesignConfig

In-memory representation of hlsfactory.toml.

design_name: str = None

dataset_name: str = None

tags: list[str] = 'field(...)'

env_vars: dict[str, str] = 'field(...)'

flow_configs: list[hlsfactory.design_config.FlowConfig] = 'field(...)'

__post_init__() → None

supports_flow(flow_name: str | hlsfactory.design_config.FlowName) → bool

get_flow_config(flow_name: str | hlsfactory.design_config.FlowName) → hlsfactory.design_config.FlowConfig | None

require_flow_config(flow_name: str | hlsfactory.design_config.FlowName) → hlsfactory.design_config.FlowConfig

get_flow_setting(flow_name: str | hlsfactory.design_config.FlowName, setting_name: str, *, default: str | None = None) → str | None

require_flow_setting(flow_name: str | hlsfactory.design_config.FlowName, setting_name: str) → str

property flow_names: tuple[str, ...]

classmethod from_mapping(data: collections.abc.Mapping[str, Any]) → hlsfactory.design_config.DesignConfig

hlsfactory.design_config.read_design_config(file_path: pathlib.Path) → hlsfactory.design_config.DesignConfig

Parse an hlsfactory.toml file into a DesignConfig.

hlsfactory.design_config.write_design_config(file_path: pathlib.Path, config: hlsfactory.design_config.DesignConfig) → None

Serialize a DesignConfig to TOML.

hlsfactory.design_config._quote_toml_string(value: str) → str

hlsfactory.design_config.__all__ = ['DESIGN_CONFIG_FILENAME', 'DesignConfig', 'DesignConfigError', 'FlowConfig', 'FlowConfigError', 'Fl...