running spellcheck

NVIDIA · Jul 18, 2024 · ce70799 · ce70799
1 parent 3297df8
commit ce70799
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 17 deletions.
diff --git a/.github/workflows/config/spelling_allowlist.txt b/.github/workflows/config/spelling_allowlist.txt
@@ -51,7 +51,6 @@ LPX
 LSB
 Libraries
 LXmn
-Libraries
 MCA
 MLIR
 MPI
@@ -98,9 +97,7 @@ SDK
 SLED
 SLES
 SLURM
-SpinOperator
 SVD
-SpinOperator
 Superpositions
 TBI
 TCP
@@ -183,7 +180,6 @@ eigenvalue
 eigenvalues
 eigenvector
 eigenvectors
-elec
 enqueue
 enqueues
 enqueuing
@@ -243,12 +239,12 @@ occb
 openfermion
 optimizer
 optimizers
-param
-params
 parallelization
 parallelize
 parallelizing
+param
 parameterization
+params
 performant
 photonic
 precompute
@@ -302,9 +298,8 @@ summarize
 superpositions
 symplectic
 tablegen
-th
-thres
 templated
+thres
 toolchain
 toolchains
 toolset
@@ -320,8 +315,8 @@ upvote
 utils
 variadic
 variational
+veq
 verifier
 vertices
-veq
 wavefunction
 workflow
diff --git a/docs/sphinx/examples/python/tutorials/src/utils_ipie.py b/docs/sphinx/examples/python/tutorials/src/utils_ipie.py
@@ -23,11 +23,11 @@ def signature_permutation(orbital_list):
 
 def get_coeff_wf(final_state_vector, n_active_elec, spin=0, thres=1e-6):
  """
- :param final_state_vector: State vector from a VQE simulation
- :param n_active_elec: Number of total electrons in active space
- :param spin: spin
- :param thres: Threshold for coefficients to keep from VQE wavefunction
- :returns: Input for ipie trial: coefficients, list of occupied alpha, list of occupied bets
+ :param `final_state_vector`: State vector from a VQE simulation
+ :param `n_active_elec`: Number of total electrons in active space
+ :param `spin`: spin
+ :param `thres`: Threshold for coefficients to keep from VQE wavefunction
+ :returns: Input for `ipie` trial: coefficients, list of occupied alpha, list of occupied bets
  """
  n_qubits = int(np.log2(final_state_vector.size))
  n_elec = [(n_active_elec + spin) // 2, (n_active_elec - spin) // 2]

diff --git a/docs/sphinx/examples/python/tutorials/src/vqe_cudaq_qnp.py b/docs/sphinx/examples/python/tutorials/src/vqe_cudaq_qnp.py
@@ -28,7 +28,7 @@ def __init__(self, n_qubits, num_active_electrons, spin, options):
 
  # Define the initial state for the VQE as a list
  # [n_1, n_2, ....]
- # where n_j=(0,1,2) is the occupation of j-th the orbital
+ # where n_j=(0,1,2) is the occupation of j-`th` the orbital
 
  n_alpha_vec = [1] * num_active_electrons_alpha + [0] * (
  num_active_orbitals - num_active_electrons_alpha)
@@ -245,7 +245,7 @@ def from_string_to_cudaq_spin(pauli_string, qubit):
 
 
 def get_cudaq_hamiltonian(jw_hamiltonian):
- """ Converts an openfermion QubitOperator Hamiltonian into a cudaq.SpinOperator Hamiltonian
+ """ Converts an openfermion QubitOperator Hamiltonian into a `cudaq.SpinOperator` Hamiltonian
 
  """
 
@@ -268,7 +268,7 @@ def get_cudaq_hamiltonian(jw_hamiltonian):
 
 
 def get_cudaq_operator(jw_hamiltonian):
- """ Converts an openfermion QubitOperator Hamiltonian into a cudaq.SpinOperator Hamiltonian
+ """ Converts an openfermion QubitOperator Hamiltonian into a `cudaq.SpinOperator` Hamiltonian
 
  """