bqth29 / simulated-bifurcation-algorithm

Python CPU/GPU implementation of the Simulated Bifurcation (SB) algorithm to solve quadratic optimization problems (QUBO, Ising, TSP, optimal asset allocations for a portfolio, etc.).

MIT License

103 stars 25 forks source link

update docstrings (energy-based convergence) #40

Closed BusyBeaver-42 closed 10 months ago

BusyBeaver-42 commented 10 months ago

💬 Pull Request Description

Update docstrings for energy-based convergence.

✔️ Check list

Before you open the pull request, make sure the following requirements are met.

[x] The code matches the styling rules
[x] The new code is covered by relevant tests
[x] Documentation was added

🚀 New features

None

🐞 Bug fixes

None

📣 Supplementary information

None

codecov[bot] commented 10 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Files	Coverage Δ
src/simulated_bifurcation/ising_core.py	`100.00% <ø> (ø)`
src/simulated_bifurcation/simulated_bifurcation.py	`100.00% <ø> (ø)`

:loudspeaker: Thoughts on this report? Let us know!.