Write Docs - Githubissues

psrenergy / ToQUBO.jl

🟦 JuMP ToQUBO Automatic Reformulation

https://psrenergy.github.io/ToQUBO.jl

Other

27 stars 2 forks source link

Write Docs #63

Open pedromxavier opened 1 year ago

pedromxavier commented 1 year ago

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

[x] Organize the booklet and the manual into separate files.
[x] Quadratization
- [x] Better explain what stable quadratizations are[^1]
- [x] Finish the primer on submodularity
[x] Variable Encoding
- [x] Make the explanation uniform across different methods
- [x] Describe the methodology for the computation of the number of bits given an error tolerance[^2]

Examples

[ ] "Mention how exciting is solving a problem with a quantum annealer maybe[^3]"
[x] Give more context for the prime factoring example[^4]

[^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_