search

HumanCompatibleAI / imitation

Clean PyTorch implementations of imitation and reward learning algorithms
https://imitation.readthedocs.io/
MIT License
1.32k stars 247 forks source link

Expand algorithm documentation #514

Closed AdamGleave closed 2 years ago

AdamGleave commented 2 years ago

The algorithm documentation is currently just converted directly from docstrings and is a method-by-method description, e.g. for behavioral cloning. It would be more user friendly to include some high-level description of the algorithm and example usage, either as a separate entry in the guide (Sphinx RST) or perhaps as module-level docstrings.

AdamGleave commented 2 years ago

This is fixed now in various PRs.