boxqp_metadata

class BoxQPMetadata(problem: ProblemType)

Bases: ProblemMetadata

BoxQP Problem-specific Metadata class.

The problem-specific metadata class inherited from Problem Metadata parent class for the BoxQP problem. This takes Box QP problem result data and generates plotting data.

BoxQP Metadata class object constructor.

The constructor defines variables that are specific to the BoxQP problem and are used to generate plotting data.

Parameters:

problem (ProblemType) – A problem type.

generate_plot_data(metric_func: callable) → DataFrame

Calculate the time to solution vs problem size for a particular gap and quantile.

Parameters:

• metric_func (callable) – A callback function that is used when calculating

• machine_energy (the metrics either to determine the machine_time or the) –

:param : :param which are used when computing the TTS or ETS: :param respectively.:

Returns:

The time to solution for each problem size.

Return type:

(pd.Series)

generate_success_prob_plot_data() → DataFrame

Calculate the success probability vs problem size for a particular gap and quantile.

Returns:

The success probability for each problem size.

Return type:

pd.DataFrame

ingest_metadata(metadata_filepath: str) → None

A method to ingest raw metadata.

Take a file path to metadata and convert them into a pandas.DataFrame.

Parameters:

metadata_filepath (str) – A file path to metadata.