Skip to content

Latest commit

 

History

History
19 lines (11 loc) · 1.15 KB

CONTRIBUTING.md

File metadata and controls

19 lines (11 loc) · 1.15 KB

Contributions are welcome!

  1. Please take a look at the LICENSE (it's Apache 2.0)

  2. Make sure you sign your commits. E.g. use git commit -s when commiting

  3. Make sure all unittests finish successfully before sending PR

  4. Send your Pull Request to master branch

Collection Guidelines

Collection is a logical grouping of related Neural Modules. It is a grouping of modules that share a domain area or semantics. At the basic level, collection is a python package installable via pip. When contributing module to a collection, please make sure it belongs to that category. If you would like to start a new one and contribute back to the platform, you are very welcome to do so. Collection package should be named “nemo_”. Collections can depend on other collections and have new types defined. Neural Types for input and output need to be clearly defined in documentation.

Please note that CI needs to pass for all the modules and collections.

Citation

We are working on preparing a paper. We request you to please include a mention of the toolkit and a link to the repository if you use this work in a published or open-source project.