How to document¶
Introduction¶
This folder aims to provide documentation to help you use Eztorch. It contains several examples of scripts as well as various advice to use the library.
Documentation¶
In examples/
, you will find concrete examples of how to use Eztorch.
In structure.md
, we explain how Eztorch is structured so you can find easily the functions or classes you are looking for and where to contribute.
Comment your code¶
Please, if you contribute to Eztorch, be sure to comment your code to ensure that others can read it.
Docstring¶
All functions and classes in Pytorch should be documented using the Google napoleon style.
For functions here is an example:
Sphinx¶
This documentation is made using Sphinx and should be updated using it.