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

Documentation #26

Open
alex124585 opened this issue Nov 10, 2023 · 1 comment
Open

Documentation #26

alex124585 opened this issue Nov 10, 2023 · 1 comment
Assignees

Comments

@alex124585
Copy link
Contributor

  1. Create proper documentation
    a. Start by converting the text in https://arxiv.org/abs/2309.04841 into docs
    E.g. similar to https://openqaoa.entropicalabs.com/ (uses MKDocs) or https://xgboost.readthedocs.io/en/stable/
    b. Study code and ask specific questions to code developers to add documentation for pieces not documented in the arXiv paper
@alex124585 alex124585 self-assigned this Nov 10, 2023
@rsln-s
Copy link
Contributor

rsln-s commented Jan 29, 2024

(Moving text over from #25)
At a high level, the workflow we are hoping to enable with QOKit is as follows:

  1. Use get_qaoa_maxcut_objective to find good parameter beta gamma (used fixed? Optimize?) for your input graph
  2. Use these parameter to generate a QAOA circuit to run on hardware (qokit/qaoa_circuit_maxcut.py)

The same flow should work for other problems (portfolio optimization, LABS, ...)

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

No branches or pull requests

2 participants