quara.simulation.standard_qtomography_simulation module

class EstimatorTestSetting(true_object: quara.simulation.standard_qtomography_simulation.NoiseSetting, tester_objects: List[quara.simulation.standard_qtomography_simulation.NoiseSetting], seed_data: int, seed_qoperation: int, n_rep: int, num_data: List[int], n_sample: int, schedules: Union[str, List[List[int]]], case_names: List[str], estimators: List[ForwardRef(‘Estimator’)], eps_proj_physical_list: List[float], eps_truncate_imaginary_part_list: List[float], algo_list: List[tuple], loss_list: List[tuple], parametrizations: List[bool], c_sys: ‘CompositeSystem’, generation_setting_is_physicality_required: bool = True)

Bases: object

Parameters

• true_object (quara.simulation.standard_qtomography_simulation.NoiseSetting) –

• tester_objects (List[quara.simulation.standard_qtomography_simulation.NoiseSetting]) –

• seed_data (int) –

• seed_qoperation (int) –

• n_rep (int) –

• num_data (List[int]) –

• n_sample (int) –

• schedules (Union[str, List[List[int]]]) –

• case_names (List[str]) –

• estimators (List[Estimator]) –

• eps_proj_physical_list (List[float]) –

• eps_truncate_imaginary_part_list (List[float]) –

• algo_list (List[tuple]) –

• loss_list (List[tuple]) –

• parametrizations (List[bool]) –

• c_sys (CompositeSystem) –

• generation_setting_is_physicality_required (bool) –

Return type

None

algo_list: List[tuple]

c_sys: CompositeSystem

case_names: List[str]

eps_proj_physical_list: List[float]

eps_truncate_imaginary_part_list: List[float]

estimators: List[Estimator]

generation_setting_is_physicality_required: bool = True

loss_list: List[tuple]

n_rep: int

n_sample: int

num_data: List[int]

parametrizations: List[bool]

schedules: Union[str, List[List[int]]]

seed_data: int

seed_qoperation: int

show_description()

show the description of schema of EstimatorTestSetting.

Return type

None

tester_objects: List[quara.simulation.standard_qtomography_simulation.NoiseSetting]

to_generation_settings()

Return type

quara.simulation.generation_setting.QOperationGenerationSettings

to_pickle(path)

Parameters

path (Union[str, pathlib.Path]) –

Return type

None

to_simulation_setting(true_object, tester_objects, case_index)

Parameters

• true_object (quara.objects.qoperation.QOperation) –

• tester_objects (List[quara.objects.qoperation.QOperation]) –

• case_index (int) –

Return type

quara.simulation.standard_qtomography_simulation.StandardQTomographySimulationSetting

true_object: quara.simulation.standard_qtomography_simulation.NoiseSetting

class NoiseSetting(qoperation_base: Union[quara.objects.qoperation.QOperation, str], method: str, para: dict, ids: List[int] = None)

Bases: object

Parameters

• qoperation_base (Union[quara.objects.qoperation.QOperation, str]) –

• method (str) –

• para (dict) –

• ids (List[int]) –

Return type

None

ids: List[int] = None

method: str

para: dict

qoperation_base: Union[quara.objects.qoperation.QOperation, str]

to_generation_setting(c_sys, is_physicality_required=True)

Parameters

• c_sys (CompositeSystem) –

• is_physicality_required (bool) –

Return type

QOperationGenerationSetting

class SimulationResult(estimation_results, empi_dists_sequences, qtomography, simulation_setting=None, result_index=None, check_result=None)

Bases: object

Parameters

Parameters

• estimation_results (List[EstimationResult]) – the index of list is the index of “n_rep”.

• empi_dists_sequences (List[List[List[Tuple[int, np.ndarray]]]]) – the order of indexes is as follows: “n_rep”, “num_data”, and “schecule_index”.

• qtomography (StandardQTomography) – StandardQTomography object.

• simulation_setting (StandardQTomographySimulationSetting) – StandardQTomographySimulationSetting object.

• result_index (dict) – dictionary of the check result. it contains the following keys: “name”, “total_result”, and “results”.

• check_result (dict) – dictionary of the check result. it contains the following keys: “test_setting_index”, “sample_index”, and “case_index”.

Return type

None

check_result: dict = None

empi_dists_sequences: List[List[List[Tuple[int, numpy.ndarray]]]]

estimation_results: List[quara.protocol.qtomography.estimator.EstimationResult]

get_empi_dists(n_rep, num_data_index=None, num_data_value=None)

get empi dists with specific parameter. Either num_data_index or num_data_value must be specified.

Parameters

• n_rep (int) – value of n_rep.

• num_data_index (int, optional) – index of num_data, by default None

• num_data_value (int, optional) – value of num_data, by default None

Returns

empi dists. the index of list is “schecule_index”. the tuple consists of (num_data, empi dist).

Return type

List[Tuple[int, np.ndarray]]

Raises

• ValueError – Either num_data_index or num_data_value must be specified. But both are None.

• ValueError – Either num_data_index or num_data_value must be specified. But both are specified.

• ValueError – num_data_value is not found in SimulationResult.

get_variable_estimate(n_rep, num_data_index=None, num_data_value=None)

get variable estimate with specific parameter. Either num_data_index or num_data_value must be specified.

Parameters

• n_rep (int) – value of n_rep.

• num_data_index (int, optional) – index of num_data, by default None

• num_data_value (int, optional) – value of num_data, by default None

Returns

variable estimate.

Return type

np.ndarray

Raises

• ValueError – Either num_data_index or num_data_value must be specified. But both are None.

• ValueError – Either num_data_index or num_data_value must be specified. But both are specified.

• ValueError – num_data_value is not found in SimulationResult.

qtomography: quara.protocol.qtomography.standard.standard_qtomography.StandardQTomography

result_index: dict = None

show_description()

show the description of schema of SimulationResult.

Return type

None

simulation_setting: quara.simulation.standard_qtomography_simulation.StandardQTomographySimulationSetting = None

to_dict()

Return type

dict

to_pickle(path)

Parameters

path (Union[str, pathlib.Path]) –

Return type

None

class StandardQTomographySimulationSetting(name, true_object, tester_objects, estimator, seed_data, n_rep, num_data, schedules, eps_proj_physical, eps_truncate_imaginary_part, loss=None, loss_option=None, algo=None, algo_option=None)

Bases: object

Parameters

• name (str) –

• true_object (QOperation) –

• tester_objects (List[QOperation]) –

• estimator (Estimator) –

• seed_data (int) –

• n_rep (int) –

• num_data (List[int]) –

• schedules (Union[str, List[List[int]]]) –

• eps_proj_physical (float) –

• eps_truncate_imaginary_part (float) –

Return type

None

copy()

execute_estimation(qtomography, simulation_setting, empi_dists_sequences, n_jobs=1, is_computation_time_required=True, is_detailed_results_required=False)

Parameters

• qtomography (quara.protocol.qtomography.standard.standard_qtomography.StandardQTomography) –

• simulation_setting (quara.simulation.standard_qtomography_simulation.StandardQTomographySimulationSetting) –

• empi_dists_sequences (List[List[Tuple[int, numpy.ndarray]]]) –

• n_jobs (int) –

• is_computation_time_required (bool) –

• is_detailed_results_required (bool) –

Return type

quara.simulation.standard_qtomography_simulation.SimulationResult

execute_estimation_with_saved_empi_dists_sequences(qtomography, simulation_setting, dir_path_empi_dists_sequences, n_jobs=1, is_computation_time_required=True, is_detailed_results_required=False)

Parameters

• qtomography (quara.protocol.qtomography.standard.standard_qtomography.StandardQTomography) –

• simulation_setting (quara.simulation.standard_qtomography_simulation.StandardQTomographySimulationSetting) –

• dir_path_empi_dists_sequences (Union[str, pathlib.Path]) –

• n_jobs (int) –

• is_computation_time_required (bool) –

• is_detailed_results_required (bool) –

Return type

quara.simulation.standard_qtomography_simulation.SimulationResult

execute_simulation(qtomography, simulation_setting, seed_or_generator=None, is_computation_time_required=True, is_detailed_results_required=False)

Parameters

• qtomography (quara.protocol.qtomography.standard.standard_qtomography.StandardQTomography) –

• simulation_setting (quara.simulation.standard_qtomography_simulation.StandardQTomographySimulationSetting) –

• seed_or_generator (Optional[Union[int, numpy.random._generator.Generator]]) –

• is_computation_time_required (bool) –

• is_detailed_results_required (bool) –

Return type

quara.simulation.standard_qtomography_simulation.SimulationResult

generate_empi_dists_and_calc_estimate(qtomography, true_object, num_data, estimator, loss=None, loss_option=None, algo=None, algo_option=None, iteration=None, seed_or_generator=None, is_computation_time_required=True, is_detailed_results_required=False)

Parameters

• qtomography (quara.protocol.qtomography.standard.standard_qtomography.StandardQTomography) –

• true_object (quara.objects.qoperation.QOperation) –

• num_data (List[int]) –

• estimator (quara.protocol.qtomography.standard.standard_qtomography_estimator.StandardQTomographyEstimator) –

• loss (Optional[quara.loss_function.probability_based_loss_function.ProbabilityBasedLossFunction]) –

• loss_option (Optional[quara.loss_function.probability_based_loss_function.ProbabilityBasedLossFunctionOption]) –

• algo (Optional[quara.minimization_algorithm.minimization_algorithm.MinimizationAlgorithm]) –

• algo_option (Optional[quara.minimization_algorithm.minimization_algorithm.MinimizationAlgorithmOption]) –

• iteration (Union[None, int]) –

• seed_or_generator (Optional[Union[int, numpy.random._generator.Generator]]) –

• is_computation_time_required (bool) –

• is_detailed_results_required (bool) –

Return type

Union[Tuple[quara.protocol.qtomography.standard.standard_qtomography_estimator.StandardQTomographyEstimationResult, list], quara.simulation.standard_qtomography_simulation.SimulationResult]

generate_qtomography(sim_setting, para, init_with_seed=True)

Parameters

• sim_setting (quara.simulation.standard_qtomography_simulation.StandardQTomographySimulationSetting) –

• para (bool) –

• init_with_seed (bool) –

Return type

quara.protocol.qtomography.standard.standard_qtomography.StandardQTomography

load_simulation_results(root_dir, test_setting_index, sample_index, case_index=None)

Parameters

• root_dir (str) –

• test_setting_index (int) –

• sample_index (int) –

• case_index (Optional[int]) –

Return type

list

load_test_setting(root_dir, test_setting_index)

Parameters

• root_dir (str) –

• test_setting_index (int) –

Return type

list

re_estimate(test_setting, simulation_result, n_rep_index)

Parameters

• test_setting (quara.simulation.standard_qtomography_simulation.EstimatorTestSetting) –

• simulation_result (quara.simulation.standard_qtomography_simulation.SimulationResult) –

• n_rep_index (int) –

Return type

quara.protocol.qtomography.standard.standard_qtomography_estimator.StandardQTomographyEstimationResult

re_estimate_sequence(test_setting, result)

Parameters

• test_setting (quara.simulation.standard_qtomography_simulation.EstimatorTestSetting) –

• result (quara.simulation.standard_qtomography_simulation.SimulationResult) –

Return type

List[quara.protocol.qtomography.standard.standard_qtomography_estimator.StandardQTomographyEstimationResult]

re_estimate_sequence_from_index(root_dir, test_setting_index, sample_index, case_index)

Parameters

• root_dir (str) –

• test_setting_index (int) –

• sample_index (int) –

• case_index (int) –

Return type

List[quara.protocol.qtomography.standard.standard_qtomography_estimator.StandardQTomographyEstimationResult]

re_estimate_sequence_from_path(test_setting_path, result_path)

Parameters

• test_setting_path (Union[str, pathlib.Path]) –

• result_path (Union[str, pathlib.Path]) –

Return type

List[quara.protocol.qtomography.standard.standard_qtomography_estimator.StandardQTomographyEstimationResult]