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 tables and functions + Best Practice #25

Open
KonstantinWilleke opened this issue Dec 11, 2019 · 2 comments
Open

Documentation of tables and functions + Best Practice #25

KonstantinWilleke opened this issue Dec 11, 2019 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@KonstantinWilleke
Copy link
Collaborator

KonstantinWilleke commented Dec 11, 2019

The user does, as of now, not have a good idea what the expectations of nnfabrik are. The specifications are not listed explicitly. So the functions, specifically in builder.py, have to extensively documented. As well as the tables in main.py.
The logic of inputs and returns of models/datasets/trainers should be documented extensively.

Supply the user with best practices. This should be part of the documentation.
Part of the best practice:

  • All models should accept inputs and data_key, as well as **kwargs. So that every model works with every dataset. but the model has to warn the user if kwargs are ignored (otherwise its prone to error).
@mohammadbashiri mohammadbashiri added the documentation Improvements or additions to documentation label Dec 12, 2019
@KonstantinWilleke KonstantinWilleke changed the title Documentation of tables and functions Documentation of tables and functions + Best Practice Jan 20, 2020
@ArneNx
Copy link
Collaborator

ArneNx commented Jul 8, 2020

Improve main.py docstrings

@ArneNx
Copy link
Collaborator

ArneNx commented Nov 12, 2020

What is the status of this @KonstantinWilleke, @mohammadbashiri ?
Are we at a point where we're satisfied with our documentation?

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
Projects
None yet
Development

No branches or pull requests

3 participants