`hlsfactory.data_packaging`¶

Module Contents¶

Classes¶

`CompleteHLSData`
`DataAggregator`
`ArtifactsXilinx`
`DataAggregatorXilinx`

Functions¶

get_file_in_root

Data¶

`InMemoryArchive`
`ArtifactCollection`

API¶

hlsfactory.data_packaging.InMemoryArchive = None¶

class hlsfactory.data_packaging.CompleteHLSData[source]¶

design: dict | None = None¶

synthesis: dict | None = None¶

implementation: dict | None = None¶

execution: dict | None = None¶

artifacts: hlsfactory.data_packaging.InMemoryArchive | None = None¶

design_id: str = 'field(...)'¶

to_flat_dict() → dict[source]¶

to_json() → str[source]¶

to_json_file(file_path: pathlib.Path) → None[source]¶

to_csv() → str[source]¶

to_csv_file(file_path: pathlib.Path) → None[source]¶

class hlsfactory.data_packaging.DataAggregator[source]¶

Bases: abc.ABC

VENDER = None¶

abstract gather_hls_design_data(design: hlsfactory.framework.Design) → dict[source]¶

abstract gather_hls_synthesis_data(design: hlsfactory.framework.Design) → dict[source]¶

abstract gather_implementation_data(design: hlsfactory.framework.Design) → dict[source]¶

abstract gather_execution_data(design: hlsfactory.framework.Design) → dict[source]¶

abstract gather_hls_synthesis_artifacts(design: hlsfactory.framework.Design) → hlsfactory.data_packaging.InMemoryArchive[source]¶

gather_all_data(design: hlsfactory.framework.Design, **kwargs) → hlsfactory.data_packaging.CompleteHLSData[source]¶

gather_multiple_designs(designs: list[hlsfactory.framework.Design], n_jobs: int = 1) → list[hlsfactory.data_packaging.CompleteHLSData][source]¶

aggregated_data_to_csv(data: list[hlsfactory.data_packaging.CompleteHLSData]) → str[source]¶

aggregated_data_to_csv_file(data: list[hlsfactory.data_packaging.CompleteHLSData], file_path: pathlib.Path) → None[source]¶

aggregated_data_to_json(data: list[hlsfactory.data_packaging.CompleteHLSData]) → str[source]¶

aggregated_data_to_json_file(data: list[hlsfactory.data_packaging.CompleteHLSData], file_path: pathlib.Path) → None[source]¶

aggregated_data_to_archive(data: list[hlsfactory.data_packaging.CompleteHLSData], file_path: pathlib.Path) → None[source]¶

hlsfactory.data_packaging.ArtifactCollection = None¶

class hlsfactory.data_packaging.ArtifactsXilinx(*args, **kwds)[source]¶

Bases: enum.Enum

IR = 'ir'¶

ADB = 'adb'¶

REPORT = 'report'¶

HDL = 'hdl'¶

IP = 'ip'¶

hlsfactory.data_packaging.get_file_in_root(dir_fp: pathlib.Path, file_name: str) → dict[source]¶

class hlsfactory.data_packaging.DataAggregatorXilinx[source]¶

Bases: hlsfactory.data_packaging.DataAggregator

VENDER = 'Xilinx'¶

gather_hls_design_data(design: hlsfactory.framework.Design) → dict[source]¶

gather_hls_synthesis_data(design: hlsfactory.framework.Design) → dict[source]¶

gather_implementation_data(design: hlsfactory.framework.Design) → dict[source]¶

gather_execution_data(design: hlsfactory.framework.Design) → dict[source]¶

gather_hls_synthesis_artifacts_data(design: hlsfactory.framework.Design, artifacts_to_extract: set[hlsfactory.data_packaging.ArtifactsXilinx] = {ArtifactsXilinx.IR, ArtifactsXilinx.ADB, ArtifactsXilinx.REPORT, ArtifactsXilinx.HDL, ArtifactsXilinx.IP}, error_if_missing_data: bool = True) → hlsfactory.data_packaging.ArtifactCollection[source]¶

gather_hls_synthesis_artifacts(design: hlsfactory.framework.Design, artifacts_to_extract: set[hlsfactory.data_packaging.ArtifactsXilinx] = {ArtifactsXilinx.IR, ArtifactsXilinx.ADB, ArtifactsXilinx.REPORT, ArtifactsXilinx.HDL, ArtifactsXilinx.IP}, error_if_missing_data: bool = True) → hlsfactory.data_packaging.InMemoryArchive[source]¶