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.

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

Jump to bottom

Write Docs #63

Open
8 of 12 tasks
pedromxavier opened this issue Feb 14, 2023 · 0 comments · Fixed by #64
Open
8 of 12 tasks

Write Docs #63

pedromxavier opened this issue Feb 14, 2023 · 0 comments · Fixed by #64
Assignees
@pedroripper @pedromxavier
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@pedromxavier
Copy link
Member

pedromxavier commented Feb 14, 2023 •
edited
Loading

There are a few comments in #59 about documentation. I'm listing them and other topics here as tasks for another PR yet to be opened.

Manual

  • Tell how to run a model
  • How to gather results
  • How to adjust compiler settings

Booklet

  • Organize the booklet and the manual into separate files.
  • Quadratization
    • Better explain what stable quadratizations are1
    • Finish the primer on submodularity
  • Variable Encoding
    • Make the explanation uniform across different methods
    • Describe the methodology for the computation of the number of bits given an error tolerance2

Examples

  • "Mention how exciting is solving a problem with a quantum annealer maybe3"
  • Give more context for the prime factoring example4

Footnotes

  1. @bernalde in https://github.com/psrenergy/ToQUBO.jl/pull/59#discussion_r1096178231 ↩

  2. @bernalde in https://github.com/psrenergy/ToQUBO.jl/pull/59#discussion_r1103288064 ↩

  3. @bernalde in https://github.com/psrenergy/ToQUBO.jl/pull/59#discussion_r1095202165 ↩

  4. @joaquimg, @bernalde in https://github.com/psrenergy/ToQUBO.jl/pull/59#discussion_r1095355993 ↩
@pedromxavier pedromxavier added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Feb 14, 2023
This was referenced Feb 14, 2023
Merged
Merged
@pedromxavier pedromxavier changed the title Write Docs for v0.1.5 Write Docs Apr 18, 2023
@pedromxavier pedromxavier reopened this Apr 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@pedroripper pedroripper

@pedromxavier pedromxavier

Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Write Docs for v0.1.5 JuliaQUBO/ToQUBO.jl
2 participants
@pedroripper @pedromxavier