Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix required memory checks for QasmSimulator with custom method #763

Merged
merged 6 commits into from
Jun 1, 2020
Merged

Fix required memory checks for QasmSimulator with custom method #763

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
52be414
Validate required memory before simulation
chriseclectic May 29, 2020
76b3c93
Fix required memory for density matrix state
chriseclectic May 29, 2020
6ba62b1
add reno
chriseclectic May 29, 2020
f3a6331
Merge branch 'master' into fix-validate-memory
chriseclectic May 29, 2020
7e2189c
Merge branch 'master' into fix-validate-memory
chriseclectic May 30, 2020
e8ed725
Merge branch 'master' into fix-validate-memory
chriseclectic Jun 1, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions releasenotes/notes/fix-required-memory-check-0a138e0478d8ff32.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
fixes:
- |
Fixes issue where memory requirements of simulation were not being checked
on the QasmSimulator when using a non-automatic simulation method.
Comment on lines +1 to +5
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought this was automatically generated when creating the release?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought you still needed these since they have them in Terra, but maybe @mtreinish knows?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes this is still needed. The changelog is automated now, but release documentation still needs to be written. The previous changelog was serving double duty as release documentation (frankly quite poorly). See the contributing docs on this: https://github.com/Qiskit/qiskit-aer/blob/master/CONTRIBUTING.md#release-notes (the changelog section above it mentions the changelog autogeneration)

5 changes: 2 additions & 3 deletions src/controllers/controller.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -443,9 +443,8 @@ bool Controller::validate_memory_requirements(const state_t &state,
if(throw_except) {
std::string name = "";
JSON::get_value(name, "name", circ.header);
throw std::runtime_error("AER::Base::Controller: State " + state.name() +
" has insufficient memory to run the circuit " +
name);
throw std::runtime_error("Insufficient memory to run circuit \"" + name +
"\" using the " + state.name() + " simulator.");
}
return false;
}
Expand Down
57 changes: 38 additions & 19 deletions src/controllers/qasm_controller.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -507,9 +507,11 @@ QasmController::Method QasmController::simulation_method(
if (simulation_precision_ == Precision::single_precision) {
Statevector::State<QV::QubitVector<float>> state;
validate_state(state, circ, noise_model, true);
validate_memory_requirements(state, circ, true);
} else {
Statevector::State<QV::QubitVector<>> state;
validate_state(state, circ, noise_model, true);
validate_memory_requirements(state, circ, true);
}
}
return Method::statevector;
Expand All @@ -524,9 +526,11 @@ QasmController::Method QasmController::simulation_method(
if (simulation_precision_ == Precision::single_precision) {
Statevector::State<QV::QubitVectorThrust<float>> state;
validate_state(state, circ, noise_model, true);
validate_memory_requirements(state, circ, true);
} else {
Statevector::State<QV::QubitVectorThrust<>> state;
validate_state(state, circ, noise_model, true);
validate_memory_requirements(state, circ, true);
}
}
return Method::statevector_thrust_gpu;
Expand All @@ -542,9 +546,11 @@ QasmController::Method QasmController::simulation_method(
if (simulation_precision_ == Precision::single_precision) {
Statevector::State<QV::QubitVectorThrust<float>> state;
validate_state(state, circ, noise_model, true);
validate_memory_requirements(state, circ, true);
} else {
Statevector::State<QV::QubitVectorThrust<>> state;
validate_state(state, circ, noise_model, true);
validate_memory_requirements(state, circ, true);
}
}
return Method::statevector_thrust_cpu;
Expand All @@ -553,11 +559,13 @@ QasmController::Method QasmController::simulation_method(
case Method::density_matrix: {
if (validate) {
if (simulation_precision_ == Precision::single_precision) {
validate_state(DensityMatrix::State<QV::DensityMatrix<float>>(), circ,
noise_model, true);
DensityMatrix::State<QV::DensityMatrix<float>> state;
validate_state(state, circ, noise_model, true);
validate_memory_requirements(state, circ, true);
} else {
validate_state(DensityMatrix::State<QV::DensityMatrix<double>>(),
circ, noise_model, true);
DensityMatrix::State<QV::DensityMatrix<double>> state;
validate_state(state, circ, noise_model, true);
validate_memory_requirements(state, circ, true);
}
}
return Method::density_matrix;
Expand All @@ -570,12 +578,13 @@ QasmController::Method QasmController::simulation_method(
#else
if (validate) {
if (simulation_precision_ == Precision::single_precision) {
validate_state(DensityMatrix::State<QV::DensityMatrixThrust<float>>(),
circ, noise_model, true);
DensityMatrix::State<QV::DensityMatrixThrust<float>> state;
validate_state(state, circ, noise_model, true);
validate_memory_requirements(state, circ, true);
} else {
validate_state(
DensityMatrix::State<QV::DensityMatrixThrust<double>>(), circ,
noise_model, true);
DensityMatrix::State<QV::DensityMatrixThrust<double>> state;
validate_state(state, circ, noise_model, true);
validate_memory_requirements(state, circ, true);
}
}
return Method::density_matrix_thrust_gpu;
Expand All @@ -589,30 +598,40 @@ QasmController::Method QasmController::simulation_method(
#else
if (validate) {
if (simulation_precision_ == Precision::single_precision) {
validate_state(DensityMatrix::State<QV::DensityMatrixThrust<float>>(),
circ, noise_model, true);
DensityMatrix::State<QV::DensityMatrixThrust<float>> state;
validate_state(state, circ, noise_model, true);
validate_memory_requirements(state, circ, true);
} else {
validate_state(
DensityMatrix::State<QV::DensityMatrixThrust<double>>(), circ,
noise_model, true);
DensityMatrix::State<QV::DensityMatrixThrust<double>> state;
validate_state(state, circ, noise_model, true);
validate_memory_requirements(state, circ, true);
}
}
return Method::density_matrix_thrust_cpu;
#endif
}
case Method::stabilizer: {
if (validate)
if (validate) {
Stabilizer::State state;
validate_state(Stabilizer::State(), circ, noise_model, true);
validate_memory_requirements(state, circ, true);
}
return Method::stabilizer;
}
case Method::extended_stabilizer: {
if (validate)
validate_state(ExtendedStabilizer::State(), circ, noise_model, true);
if (validate) {
ExtendedStabilizer::State state;
validate_state(state, circ, noise_model, true);
validate_memory_requirements(ExtendedStabilizer::State(), circ, true);
}
return Method::extended_stabilizer;
}
case Method::matrix_product_state: {
if (validate)
validate_state(MatrixProductState::State(), circ, noise_model, true);
if (validate) {
MatrixProductState::State state;
validate_state(state, circ, noise_model, true);
validate_memory_requirements(state, circ, true);
}
return Method::matrix_product_state;
}
case Method::automatic: {
Expand Down
6 changes: 1 addition & 5 deletions src/simulators/density_matrix/densitymatrix_state.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -352,12 +352,8 @@ template <class densmat_t>
size_t State<densmat_t>::required_memory_mb(uint_t num_qubits,
const std::vector<Operations::Op> &ops)
const {
// An n-qubit state vector as 2^n complex doubles
// where each complex double is 16 bytes
(void)ops; // avoid unused variable compiler warning
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not part of your changes, but seeing this line, it makes clear that we need an override of this method.

size_t shift_mb = std::max<int_t>(0, num_qubits + 4 - 20);
size_t mem_mb = 1ULL << shift_mb;
return mem_mb;
return BaseState::qreg_.required_memory_mb(2 * num_qubits);
}

template <class densmat_t>
Expand Down
2 changes: 0 additions & 2 deletions src/simulators/statevector/statevector_state.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -392,8 +392,6 @@ template <class statevec_t>
size_t State<statevec_t>::required_memory_mb(uint_t num_qubits,
const std::vector<Operations::Op> &ops)
const {
// An n-qubit state vector as 2^n complex doubles
// where each complex double is 16 bytes
(void)ops; // avoid unused variable compiler warning
return BaseState::qreg_.required_memory_mb(num_qubits);
}
Expand Down