mle-infrastructure / mle-toolbox

Lightweight Tool to Manage Distributed ML Experiments 🛠
https://mle-infrastructure.github.io/mle_toolbox/toolbox/
MIT License
3 stars 1 forks source link

Do proper documentation #18

Closed RobertTLange closed 2 years ago

RobertTLange commented 3 years ago

Currently the toolbox documentation is bad. There is no clear style. No real doc strings. It is not clear where to get started as a new user. Decreasing progression of abstraction. Have a hierarchy of complexity that is stepwise revealed to the user (or not! if they don't need it).

Some docs that I started to put together in August are even outdated/wrong. Take care of this. Things to consider/start with:

RobertTLange commented 3 years ago

Check out Mkdocs. Looks really beautiful and easy to setup:

RobertTLange commented 3 years ago

Basic documentation landing page is now served at https://roberttlange.github.io/mle-toolbox/. Still requires quite some love, once the general UI/API is fixed for good.

Add minimal evaluation notebooks to the examples.

RobertTLange commented 2 years ago

https://roberttlange.github.io/mle-infrastructure/