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

Fix/turtorials typo and bugs #108

Merged
merged 12 commits into from
Dec 12, 2024
Merged

Fix/turtorials typo and bugs #108

merged 12 commits into from
Dec 12, 2024

Conversation

ahao27
Copy link
Contributor

@ahao27 ahao27 commented Dec 6, 2024

Description:

This pull request introduces a series of corrections of typo and clarifications to the documentation. These changes aim to enhance readability and accuracy across the documentation.

Changes:

  1. Supported Quantum Circuit SDKs
  • Added a note suggesting the inclusion of qutip as an additional quantum circuit SDK for broader coverage.
  1. Building Quantum Circuits
  • Updated section heading.
  1. Hamiltonian Representation
  • Clarified that Hamiltonians should be expressed algebraically by updating phrasing in the section.
    Capitalized "algebraically" for consistency.
  1. Spelling Mistake
  • Corrected typo: "exiternal" to "external."
  1. In Quantum Alternating Operator Ansatz (QAOA) for Maxcut problem tutorial
  • Added missing references: [1] and [2].
  • Revised code comment for accuracy:
    Updated # Get exp(-i beta H_C) circuit without mixer circuit to # Get exp(-i gamma H_P) circuit without mixer circuit.
  1. In QAOA for Graph Partitioning tutorial
  • Fix the convergence issues with the minimize function in qiskit and quri-parts.
  1. Quantum Approximation for the Vertex Cover
  • Corrected comments in the code block within the section "Creating Problem Model using JijModeling" to focus on the vertex cover problem, removing references about coloring.
  • Updated title: Changed "Vertex Cover Coloring" to "Vertex Cover Problem".

@Jacomichi Jacomichi self-requested a review December 11, 2024 02:34
Copy link
Collaborator

@Jacomichi Jacomichi left a comment

Choose a reason for hiding this comment

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

Can you also add $i$ to the operators on this page?
$e^{-\beta H_M} \to e^{-i\beta H_M}$

@@ -12,7 +12,7 @@ Welcome to the Qamomile tutorial! This guide will help you get started with Qamo

- **Qiskit**
- **Quri-parts**

- **Qutip**


## Tutorials
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can you also update the title to "Write Hamiltonian Algebraically"?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed

"source": []
"source": [
"# References\n",
"[1] Farhi, Edward, Jeffrey Goldstone, and Sam Gutmann. \"A quantum approximate optimization algorithm.\" arXiv preprint arXiv:1411.4028 (2014).\n",
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can you also add the link to the paper?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added

@ahao27
Copy link
Contributor Author

ahao27 commented Dec 12, 2024

Change

  1. convergence of quick start
  2. add 'pip install "qamomile[qutip]"' to the optional dependencies quickstart.html
  3. Change command from 'pip install qamomile[qiskit]' to 'pip install "qamomile[qiskit]"'.
  4. Can you remove -[Advanced Topic] in index.html

@Jacomichi Jacomichi self-requested a review December 12, 2024 07:46
Copy link
Collaborator

@Jacomichi Jacomichi left a comment

Choose a reason for hiding this comment

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

I guess you might just have forgottten to commit the change.

Comment on lines 31 to 33
"- For Qiskit integration: `pip install qamomile[qiskit]`\n",
"- For Quri Parts integration: `pip install qamomile[quri-parts]`"
"- For Quri Parts integration: `pip install qamomile[quri-parts]`\n",
"- For Qutip integration: `pip install qamomile[qutip]`"
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can you update this part to pip install "qamomile[qiskit]"?

@Jacomichi Jacomichi self-requested a review December 12, 2024 08:16
Copy link
Collaborator

@Jacomichi Jacomichi left a comment

Choose a reason for hiding this comment

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

I missed the convergence in the quickstart; however, @ahao27 fixed it.

@Jacomichi Jacomichi merged commit c628b00 into main Dec 12, 2024
6 checks passed
@Jacomichi Jacomichi deleted the Fix/Turtorials_typo_and_bugs branch December 12, 2024 08:25
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.

2 participants