ToQUBO.jl
ToQUBO.jl copied to clipboard
Write Docs
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