psrenergy / ToQUBO.jl

🟦 JuMP ToQUBO Automatic Reformulation
https://psrenergy.github.io/ToQUBO.jl
Other
27 stars 2 forks source link

Write Docs for `v0.1.5` #64

Closed pedromxavier closed 1 year ago

pedromxavier commented 1 year ago

This PR aims to close #63.

codecov-commenter commented 1 year ago

Codecov Report

Patch coverage: 100.00% and no project coverage change.

Comparison is base (3e37e5c) 70.56% compared to head (65b0441) 70.56%.

:mega: This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #64 +/- ## ======================================= Coverage 70.56% 70.56% ======================================= Files 24 24 Lines 1247 1247 ======================================= Hits 880 880 Misses 367 367 ``` | [Impacted Files](https://codecov.io/gh/psrenergy/ToQUBO.jl/pull/64?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=psrenergy) | Coverage Δ | | |---|---|---| | [src/attributes/compiler.jl](https://codecov.io/gh/psrenergy/ToQUBO.jl/pull/64?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=psrenergy#diff-c3JjL2F0dHJpYnV0ZXMvY29tcGlsZXIuamw=) | `59.83% <ø> (ø)` | | | [src/compiler/constraints.jl](https://codecov.io/gh/psrenergy/ToQUBO.jl/pull/64?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=psrenergy#diff-c3JjL2NvbXBpbGVyL2NvbnN0cmFpbnRzLmps) | `85.55% <ø> (ø)` | | | [src/lib/pbo/quadratization.jl](https://codecov.io/gh/psrenergy/ToQUBO.jl/pull/64?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=psrenergy#diff-c3JjL2xpYi9wYm8vcXVhZHJhdGl6YXRpb24uamw=) | `64.00% <ø> (ø)` | | | [src/compiler/architectures.jl](https://codecov.io/gh/psrenergy/ToQUBO.jl/pull/64?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=psrenergy#diff-c3JjL2NvbXBpbGVyL2FyY2hpdGVjdHVyZXMuamw=) | `50.00% <100.00%> (ø)` | | | [src/model/virtual.jl](https://codecov.io/gh/psrenergy/ToQUBO.jl/pull/64?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=psrenergy#diff-c3JjL21vZGVsL3ZpcnR1YWwuamw=) | `87.36% <100.00%> (ø)` | | Help us with your feedback. Take ten seconds to tell us [how you rate us](https://about.codecov.io/nps?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=psrenergy). Have a feature suggestion? [Share it here.](https://app.codecov.io/gh/feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=psrenergy)

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

pedromxavier commented 1 year ago

There are a couple of typos, but more importantly, I do not know if we should use an image of the D-Wave chip (especially if we do not have copyrights on it). I would rather remove it.

We took the image from wikimedia commons. I think we should have, if not this one, at least a figure to motivate and catch people's attention with shiny alien-like hardware.

pedroripper commented 1 year ago

There are a couple of typos, but more importantly, I do not know if we should use an image of the D-Wave chip (especially if we do not have copyrights on it). I would rather remove it.

@bernalde we found this image on Wikimedia, so it should be copyright free. But I feel that it is not contributing to the documentation too much. I can remove if you all agree

pedroripper commented 1 year ago

I had to comment these lines because the different dispatches for ToQUBO.toqubo_constraint weren't showing up on the docs. Does anyone know how to solve this?

https://github.com/psrenergy/ToQUBO.jl/blob/e56193c93d10ad18d8b191dc157f577d9d8de63f/src/compiler/interface.jl#L57-L61

bernalde commented 1 year ago

Is this ready to merge?

pedroripper commented 1 year ago

I'll just review if we have checked everything from #63