search

N-Wouda / ALNS

Adaptive large neighbourhood search (and more!) in Python.
https://alns.readthedocs.io/en/latest/
MIT License
421 stars 122 forks source link

Improve documentation #124

Closed N-Wouda closed 1 year ago

N-Wouda commented 1 year ago

Closes #123. See there for an overview of tasks.

codecov[bot] commented 1 year ago

Codecov Report

Merging #124 (b0b4d09) into master (31d4bee) will not change coverage. The diff coverage is n/a.

@@            Coverage Diff            @@
##            master      #124   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           28        28           
  Lines          668       668           
=========================================
  Hits           668       668
Impacted Files Coverage Δ
alns/accept/RecordToRecordTravel.py 100.00% <ø> (ø)
alns/accept/SimulatedAnnealing.py 100.00% <ø> (ø)
alns/select/RouletteWheel.py 100.00% <ø> (ø)
alns/select/SegmentedRouletteWheel.py 100.00% <ø> (ø)

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more

N-Wouda commented 1 year ago

@leonlan I'm done! The docs are much more complete now, and that should hopefully help users get started even easier.

The examples are back in the top-level examples/ directory, which makes much more sense IMHO.

N-Wouda commented 1 year ago

@leonlan thanks! The new commit should fix these issues.

N-Wouda commented 1 year ago

@leonlan see the caching kicking in on that last run? 40s across the board! Pretty happy about that :)

leonlan commented 1 year ago

@leonlan see the caching kicking in on that last run? 40s across the board! Pretty happy about that :)

Yea looks solid! 😃