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

Add requirements for each component type in src/models #63

Open
Alicegaz opened this issue Jul 7, 2022 · 1 comment
Open

Add requirements for each component type in src/models #63

Alicegaz opened this issue Jul 7, 2022 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@Alicegaz
Copy link

Alicegaz commented Jul 7, 2022

It is not obvious how to discriminate between nn blocks in different subdirectories of src/models. And it is better to add readme and base classes for each component (block, brick, module, etc) listing all the requirements (what it accepts, what it returns, what it is allowed and supposed to do with the inputs).

@VladVin
Copy link
Contributor

VladVin commented Jul 28, 2022

Indeed, we need a documentation for this

@VladVin VladVin self-assigned this Jul 28, 2022
@VladVin VladVin added the documentation Improvements or additions to documentation label Jul 28, 2022
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

2 participants