onnx_diagnostic.helpers.bench_run

exception onnx_diagnostic.helpers.bench_run.BenchmarkError

onnx_diagnostic.helpers.bench_run.get_machine(capability_as_str: bool = True) → Dict[str, str | int | float | Tuple[int, int]]

Returns the machine specifications.

onnx_diagnostic.helpers.bench_run.get_processor_name()

Returns the processor name.

onnx_diagnostic.helpers.bench_run.make_configs(kwargs: Namespace | Dict[str, Any], drop: Set[str] | None = None, replace: Dict[str, str] | None = None, last: List[str] | None = None, filter_function: Callable[[Dict[str, str | int | float]], bool] | None = None) → List[Dict[str, str | int | float]]

Creates all the configurations based on the command line arguments.

Parameters:

• kwargs – parameters the command line, every value having a comma means multiple values, it multiplies the number of configurations to try by the number of comma separated values

• drop – keys to drop in kwargs if specified

• replace – values to replace for a particular key

• last – to change the order of the loop created the configuration, if last == ["part"] and kwargs[part] == "0,1", then configuration where part==0 is always followed by a configuration having part==1

• filter_function – function taking a configuration and returning True if it is must be kept

Returns:

list of configurations

onnx_diagnostic.helpers.bench_run.make_dataframe_from_benchmark_data(data: List[Dict], detailed: bool = True, string_limit: int = 2000) → Any

Creates a dataframe from the received data.

Parameters:

• data – list of dictionaries for every run

• detailed – remove multi line and long values

• string_limit – truncate the strings

Returns:

dataframe

onnx_diagnostic.helpers.bench_run.multi_run(kwargs: Namespace) → bool

Checks if multiple values were sent for one argument.

onnx_diagnostic.helpers.bench_run.run_benchmark(script_name: str, configs: List[Dict[str, str | int | float]], verbose: int = 0, stop_if_exception: bool = True, dump: bool = False, temp_output_data: str | None = None, dump_std: str | None = None, start: int = 0, summary: Callable | None = None, timeout: int = 600, missing: Dict[str, str | Callable] | None = None) → List[Dict[str, str | int | float]]

Runs a script multiple times and extract information from the output following the pattern :<metric>,<value>;.

Parameters:

• script_name – python script to run

• configs – list of execution to do

• stop_if_exception – stop if one experiment failed, otherwise continue

• verbose – use tqdm to follow the progress

• dump – dump onnx file, sets variable ONNXRT_DUMP_PATH

• temp_output_data – to save the data after every run to avoid losing data

• dump_std – dumps stdout and stderr in this folder

• start – start at this iteration

• summary – function to call on the temporary data and the final data

• timeout – timeout for the subprocesses

• missing – populate with this missing value if not found

Returns:

values