Giter VIP home page Giter VIP logo

Comments (6)

leonlan avatar leonlan commented on May 29, 2024 1

The API reference is mostly complete, but it isn't really clear what some (mostly underused) features are supposed to do. E.g. kwargs to iterate(), op_coupling in selection schemes, and the autofit methods. I think we should highlight this more somehow, perhaps by adding a "short tutorial" and an "advanced topics" page.

I think I can include some of the more advanced features in #106.

  • Pass-on the processing times matrix to **kwargs
  • Use autofit
  • Include local search post-repair (which essentially turns it into iterated local search)

from alns.

N-Wouda avatar N-Wouda commented on May 29, 2024

Add more math to docs: we have a lot of places where we historically did math as code (e.g., how stuff is updated in SA and RRT). We have docs that support actual math now, so let's use that instead.

from alns.

N-Wouda avatar N-Wouda commented on May 29, 2024

We should perhaps have a dedicated installation page, both with "install using pip" and "install from source".

Edit: this should also mention something about running the tests/example notebooks.

from alns.

N-Wouda avatar N-Wouda commented on May 29, 2024

The API reference is mostly complete, but it isn't really clear what some (mostly underused) features are supposed to do. E.g. kwargs to iterate(), op_coupling in selection schemes, and the autofit methods. I think we should highlight this more somehow, perhaps by adding a "short tutorial" and an "advanced topics" page.

from alns.

N-Wouda avatar N-Wouda commented on May 29, 2024

We're currently hosting our docs on RTD, but I eventually want to move that to a dedicated Github pages location. We then have to build everything in a new workflow, but that's pretty easy to set up.

from alns.

N-Wouda avatar N-Wouda commented on May 29, 2024

We should also allow running the notebooks on Google Colab or Binder, directly from the documentation. This will make it much easier for people to start using our code.

from alns.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.