Skip to content

Use r-strings for docstrings containing LaTeX markup #1074

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

Open
mhucka wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Use r-strings for docstrings containing LaTeX markup #1074

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion tensorflow_quantum/core/ops/math_ops/fidelity_op.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
@tf.function
@tf.custom_gradient
def fidelity(programs, symbol_names, symbol_values, other_programs):
"""Calculate the fidelity between circuits.
r"""Calculate the fidelity between circuits.

Compute (potentially many) fidelities between the given circuits and
the symbol free comparison circuits.
Expand Down
4 changes: 2 additions & 2 deletions tensorflow_quantum/core/ops/math_ops/inner_product_op.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

def _inner_product_grad(programs, symbol_names, symbol_values, other_programs,
prev_grad):
"""Calculate the adjoint gradients of the inner product between circuits.
r"""Calculate the adjoint gradients of the inner product between circuits.

Compute the gradients of the (potentially many) inner products between
the given circuits and the symbol free comparison circuits.
Expand Down Expand Up @@ -70,7 +70,7 @@ def _inner_product_grad(programs, symbol_names, symbol_values, other_programs,

@tf.custom_gradient
def inner_product(programs, symbol_names, symbol_values, other_programs):
"""Calculate the inner product between circuits.
r"""Calculate the inner product between circuits.

Compute (potentially many) inner products between the given circuits and
the symbol free comparison circuits.
Expand Down
6 changes: 3 additions & 3 deletions tensorflow_quantum/datasets/spin_system.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ def _download_spin_data(system_name, boundary_condition, nspins, data_dir):


def tfi_chain(qubits, boundary_condition="closed", data_dir=None):
"""1D Transverse field Ising-model quantum data set.
r"""1D Transverse field Ising-model quantum data set.

$$
H = - \sum_{i} \sigma_i^z \sigma_{i+1}^z - g\sigma_i^x
Expand Down Expand Up @@ -322,7 +322,7 @@ def tfi_chain(qubits, boundary_condition="closed", data_dir=None):


def xxz_chain(qubits, boundary_condition="closed", data_dir=None):
"""1D XXZ model quantum data set.
r"""1D XXZ model quantum data set.

$$
H = \sum_{i} \sigma_i^x \sigma_{i+1}^x + \sigma_i^y \sigma_{i+1}^y +
Expand Down Expand Up @@ -558,7 +558,7 @@ def xxz_chain(qubits, boundary_condition="closed", data_dir=None):


def tfi_rectangular(qubits, boundary_condition="torus", data_dir=None):
"""2D transverse field Ising-model quantum data set.
r"""2D transverse field Ising-model quantum data set.

$$
H = - \sum_{\langle i,j \rangle} \sigma_i^z \sigma_{j}^z - g\sigma_i^x
Expand Down
Loading