automl / amltk

A build-it-yourself AutoML Framework
https://automl.github.io/amltk/
BSD 3-Clause "New" or "Revised" License
62 stars 4 forks source link

doc: Cleaner API docs, cleanup pipeline reference, faster rendering options, less noise in doc build output, changelog #234

Closed eddiebergman closed 8 months ago

eddiebergman commented 8 months ago

Note: Please feel free to ignore reviewing the actual content of the changes. I re-ordered the classes in components.py and so the diff looks a lot bigger then it is.

This PR focuses on:

  1. Make the API documentation cleaner
    • No longer a right side TOC, gives more space to the content
    • TOC has labels to describe if it's a method, attr etc... Screenshot_2024-01-25_11-02-43
    • Attributes and functions are now seperated as cards with some small CSS. This gives them much more visible seperation.
      Screenshot_2024-01-25_10-28-43
  2. The pipeline reference was not useful and merely dumped module docs. This was changed to be a more handcrafted reference. With that:
    • Removed the module doc of the components, it wasn't useful.
    • Removed mentions of the syntactic sugar. This was too much info and not something to advertise immediatly.
    • Made the __init__ actually display the parameters it takes, which previously was not there.
  3. Rendering took a while as it would rerun all code blocks, even for a minor string change.
    • just docs now only renders the documentation and does not run code
      • A helpful message to use just docs-code to run and render code is placed in the Screenshot_2024-01-25_10-47-50code output
  4. Loggers from SMAC and OpenML were polluting the documentation building output a lot when code was run. There are now hooks that disable this based on environment variables.
    • By default, the just docs commands will disable these log outputs
  5. Added a change log tab
    Screenshot_2024-01-25_10-49-46

eddiebergman commented 8 months ago

Merged but feel free to let me know if something here needs to be changed!