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.

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

Add crucial information to the SparseHamiltonian doc string #2572

Merged
merged 6 commits into from
Jun 6, 2022

Conversation

Qottmann
Copy link
Contributor

Context:

Added reference to qml.utils.sparse_hamiltonian to qml.SparseHamiltonian class and a use-case example.

Description of the Change:

Just changed the doc-string

Benefits:

Now it should be clear to the user how to construct sparse Hamiltonians using PennyLane.

Possible Drawbacks:

Related GitHub Issues:

@github-actions
Copy link
Contributor

Hello. You may have forgotten to update the changelog!
Please edit doc/releases/changelog-dev.md with:

  • A one-to-two sentence description of the change. You may include a small working example for new features.
  • A link back to this PR.
  • Your name (or GitHub username) in the contributors section.

@Qottmann Qottmann requested review from josh146 and ixfoduap May 13, 2022 14:54
@codecov
Copy link

codecov bot commented May 13, 2022

Codecov Report

Merging #2572 (25677b8) into master (c1db150) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #2572   +/-   ##
=======================================
  Coverage   99.58%   99.58%           
=======================================
  Files         249      249           
  Lines       20135    20135           
=======================================
  Hits        20052    20052           
  Misses         83       83           
Impacted Files Coverage Δ
pennylane/ops/qubit/observables.py 100.00% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c1db150...25677b8. Read the comment docs.

Copy link
Member

@josh146 josh146 left a comment

Choose a reason for hiding this comment

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

Thanks @Qottmann! Looks 💯, really nice example

pennylane/ops/qubit/observables.py Outdated Show resolved Hide resolved
pennylane/ops/qubit/observables.py Outdated Show resolved Hide resolved
pennylane/ops/qubit/observables.py Outdated Show resolved Hide resolved
pennylane/ops/qubit/observables.py Outdated Show resolved Hide resolved
pennylane/ops/qubit/observables.py Outdated Show resolved Hide resolved
Qottmann and others added 3 commits May 13, 2022 14:41
Co-authored-by: Josh Izaac <josh146@gmail.com>
Co-authored-by: Josh Izaac <josh146@gmail.com>
@antalszava
Copy link
Contributor

Hi @Qottmann, just double-checking: would this be good to be merged? 🙂

@Qottmann Qottmann merged commit 1ea40e7 into master Jun 6, 2022
@Qottmann Qottmann deleted the fix-sparse-doc branch June 6, 2022 18:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants