`hlsfactory.flow_balor`¶

Module Contents¶

Classes¶

`BalorGraphData`
`BalorGraphFlow`

Functions¶

`extract_dot_graph`
`flatten_dot_quoted_newlines`
`get_balor_install_dir`
`find_graph_compiler`
`validate_mode`
`_parse_dot_attributes`

Data¶

`HLSFACTORY_BALOR_PATH_ENV_VAR`
`HLSFACTORY_BALOR_DOCKER_IMAGE_ENV_VAR`
`DEFAULT_BALOR_DOCKER_IMAGE`
`GRAPH_COMPILER_RELATIVE_PATH`
`GRAPH_FILENAME`
`GRAPH_SUMMARY_FILENAME`
`VALID_MODES`
`_DOT_DEFAULT_DECLARATIONS`
`_DOT_NODE_PATTERN`
`_DOT_EDGE_PATTERN`
`_DOT_ATTR_PATTERN`
`__all__`

API¶

hlsfactory.flow_balor.HLSFACTORY_BALOR_PATH_ENV_VAR = 'HLSFACTORY_BALOR_PATH'¶

hlsfactory.flow_balor.HLSFACTORY_BALOR_DOCKER_IMAGE_ENV_VAR = 'HLSFACTORY_BALOR_DOCKER_IMAGE'¶

hlsfactory.flow_balor.DEFAULT_BALOR_DOCKER_IMAGE = 'emmetmurphy/balor:latest'¶

hlsfactory.flow_balor.GRAPH_COMPILER_RELATIVE_PATH = 'Path(...)'¶

hlsfactory.flow_balor.GRAPH_FILENAME = 'data_graph_balor.dot'¶

hlsfactory.flow_balor.GRAPH_SUMMARY_FILENAME = 'data_graph_balor.json'¶

hlsfactory.flow_balor.VALID_MODES = 'frozenset(...)'¶

hlsfactory.flow_balor._DOT_DEFAULT_DECLARATIONS = 'frozenset(...)'¶

hlsfactory.flow_balor._DOT_NODE_PATTERN = 'compile(...)'¶

hlsfactory.flow_balor._DOT_EDGE_PATTERN = 'compile(...)'¶

hlsfactory.flow_balor._DOT_ATTR_PATTERN = 'compile(...)'¶

hlsfactory.flow_balor.extract_dot_graph(output: str) → str¶

hlsfactory.flow_balor.flatten_dot_quoted_newlines(text: str) → str¶

hlsfactory.flow_balor.get_balor_install_dir(balor_install_dir: str | pathlib.Path | None = None) → pathlib.Path | None¶

hlsfactory.flow_balor.find_graph_compiler(balor_install_dir: pathlib.Path) → pathlib.Path¶

hlsfactory.flow_balor.validate_mode(mode: str) → str¶

hlsfactory.flow_balor._parse_dot_attributes(attrs: str | None) → dict[str, str]¶

class hlsfactory.flow_balor.BalorGraphData¶

format: str = None¶

top: str = None¶

mode: str = None¶

graph_file: str = None¶

num_nodes: int = None¶

num_edges: int = None¶

node_attribute_counts: dict[str, int] = None¶

edge_attribute_counts: dict[str, int] = None¶

classmethod parse_from_dot_file(fp: pathlib.Path, top: str, mode: str) → hlsfactory.flow_balor.BalorGraphData¶: Count nodes, edges, and attribute keys in a DOT graph.

class hlsfactory.flow_balor.BalorGraphFlow(balor_install_dir: str | pathlib.Path | None = None, docker_image: str | None = None, python_bin: str = 'python', log_output: bool = False)¶

Bases: hlsfactory.framework.ToolFlow

name = 'BalorGraphFlow'¶

build_command(source_path: pathlib.Path, top: str, mode: str, output_dir: pathlib.Path, generalize_types: bool, make_pdf: bool) → str¶: Build the graph-compiler command line for the selected backend.

execute(design: hlsfactory.framework.Design, timeout: float | None = None) → list[hlsfactory.framework.Design]¶

_log(design_dir: pathlib.Path, status: str, start_time: float, message: str | None) → None¶

hlsfactory.flow_balor.__all__ = ['DEFAULT_BALOR_DOCKER_IMAGE', 'HLSFACTORY_BALOR_DOCKER_IMAGE_ENV_VAR', 'HLSFACTORY_BALOR_PATH_ENV_V...¶