search

N-Wouda / ALNS

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

Intro to ALNS page in docs #136

Closed N-Wouda closed 1 year ago

N-Wouda commented 1 year ago

Written in https://github.com/openjournals/joss-reviews/issues/5028:

[..] improving the help for non-OR users to bring their own problems into ALNS. This could make the library much more accessible to a wider audience. The code quickstart suggested by @skadio and the ALNS features page are good places to start, but I would have really appreciated an introduction to ALNS and some more general help (eg what problems it is good for, how to apply ALNS to your own problem, what is necessary to implement, how important different parts are).

Our response to this has been:

I will write another page in the documentation explicitly introducing ALNS, explaining what type of problems it can be used to solve, and briefly describe what a minimal implementation should contain (in terms of ideas). This complements the quick start template, which is really about "so how do I turn those ideas into code". I expect I will have this finished later today, and will report back then.

And this PR adds the promised page to the documentation.

codecov[bot] commented 1 year ago

Codecov Report

Merging #136 (778a48e) into master (236e307) will not change coverage. The diff coverage is n/a.

@@            Coverage Diff            @@
##            master      #136   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           28        28           
  Lines          668       668           
=========================================
  Hits           668       668

: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 think this is ready for a review!

N-Wouda commented 1 year ago

This new commit moves the "what's a good init destroy/repair operator pair" to the template, and then directly links to the template from the intro page. I've also cited Pisinger and Ropke's handbook chapter on (A)LNS.

N-Wouda commented 1 year ago

OK! I'll merge this into master now, and report back to the reviewer in the JOSS review.