Skip to content

Commit ee6e703

Browse files
authored
Merge pull request #657 from tensorflow/mps_docs
Update MPS docs
2 parents 7ff5f20 + bddcad0 commit ee6e703

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

tensorflow_quantum/core/ops/math_ops/simulate_mps.py

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,11 @@ def mps_1d_expectation(programs,
2828
bond_dim=4):
2929
"""Calculate the expectation value of circuits wrt some operator(s)
3030
31+
Simulate the final state of `programs` given `symbol_values` are placed
32+
inside of the symbols with the name in `symbol_names` in each circuit.
33+
From there we will then compute the expectation values of `pauli_sums`
34+
on the final states. Note that this op requires 1D non periodic circuits.
35+
3136
Args:
3237
programs: `tf.Tensor` of strings with shape [batch_size] containing
3338
the string representations of the circuits to be executed.
@@ -67,7 +72,8 @@ def mps_1d_sample(programs,
6772
6873
Simulate the final state of `programs` given `symbol_values` are placed
6974
inside of the symbols with the name in `symbol_names` in each circuit.
70-
From there we will then sample from the final state.
75+
From there we will then sample from the final state. Note that this op
76+
requires 1D non periodic circuits.
7177
7278
Args:
7379
programs: `tf.Tensor` of strings with shape [batch_size] containing
@@ -109,7 +115,8 @@ def mps_1d_sampled_expectation(programs,
109115
Simulate the final state of `programs` given `symbol_values` are placed
110116
inside of the symbols with the name in `symbol_names` in each circuit.
111117
Them, sample the resulting state `num_samples` times and use these samples
112-
to compute expectation values of the given `pauli_sums`.
118+
to compute expectation values of the given `pauli_sums`. Note that this op
119+
requires 1D non periodic circuits.
113120
114121
Args:
115122
programs: `tf.Tensor` of strings with shape [batch_size] containing

0 commit comments

Comments
 (0)