Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation of hyper parameters #167

Open
pmeier opened this issue Aug 25, 2020 · 1 comment
Open

Documentation of hyper parameters #167

pmeier opened this issue Aug 25, 2020 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@pmeier
Copy link
Member

pmeier commented Aug 25, 2020

Right now we only have an overview of hyper parameters where the reference implementation of the authors differ from paper. I wonder if we should put a table of every hyper parameter together with their values on top of the API reference. This way we could give a far better overview

If we go for this it might be viable to implement a HyperParameters class for each paper where we can pull all default values for all the functions and classes.

Cc @jbueltemeier

@jbueltemeier
Copy link
Collaborator

That's a good idea. It would also be good to document other paper relevant attitudes in this list? For example, the optimizer used, the dataset on which the training is/was performed, etc

@pmeier pmeier added documentation Improvements or additions to documentation enhancement New feature or request labels Aug 25, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants