Skip to content

Fix Math Rendering in Fidelity Docstring and Enable MathJax for Sphinx Docs #903

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
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Fix Math Rendering in Fidelity Docstring and Enable MathJax for Sphinx Docs #903

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f9be8f7
Enable MathJax for Sphinx documentation to fix math rendering
Aniketsy Sep 14, 2025
0f068a1
Enable MathJax for Sphinx documentation to fix math rendering
Aniketsy Sep 27, 2025
6cf47f4
Enable MathJax for Sphinx documentation to fix math rendering
Aniketsy Sep 27, 2025
2455d67
Merge branch 'master' into fix-mathjax-docs
Aniketsy Sep 27, 2025
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
8 changes: 8 additions & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
"""Sphinx configuration for the TensorFlow Quantum docs.

Adjust extensions and Sphinx options here.
"""

extensions = [
'sphinx.ext.mathjax',
]
8 changes: 5 additions & 3 deletions 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 @@ -25,9 +25,11 @@ def fidelity(programs, symbol_names, symbol_values, other_programs):
Compute (potentially many) fidelities between the given circuits and
the symbol free comparison circuits.

Calculates out[i][j] = $ | \langle \psi_{\text{programs[i]}} \\
(\text{symbol\_values[i]}) | \psi_{\text{other\_programs[j]}} \rangle \\
|^2 $
Calculates out[i][j] as:
$$
|\langle \psi_{\text{programs[i]}}(\text{symbol\_values[i]}) \mid
\psi_{\text{other\_programs[j]}} \rangle|^2
$$


>>> symbols = sympy.symbols('alpha beta')
Expand Down
7 changes: 5 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 @@ -75,8 +75,11 @@ def inner_product(programs, symbol_names, symbol_values, other_programs):
Compute (potentially many) inner products between the given circuits and
the symbol free comparison circuits.

Calculates out[i][j] = $ \langle \psi_{\text{programs[i]}} \\
(\text{symbol\_values[i]}) | \psi_{\text{other\_programs[j]}} \rangle $
Calculates out[i][j] as:
$$
\langle \psi_{\text{programs[i]}}(\text{symbol\_values[i]}) \mid
\psi_{\text{other\_programs[j]}} \rangle
$$


>>> symbols = sympy.symbols('alpha beta')
Expand Down
Loading