avalanche icon indicating copy to clipboard operation
avalanche copied to clipboard

Examples in the documentation

Open AntonioCarta opened this issue 3 years ago • 2 comments

We should add some examples in the classes documentation, at least for the high level classes and all the features more frequently used by the end user. I think pytorch documentation is really good at this (example) and most pytorch users expect the same quality.

See #885 for an example.

AntonioCarta avatar Jan 20 '22 13:01 AntonioCarta

Is the idea that an Avalanche documentation page such as this about the SimpleCNN class would include an example similar to this

If I have got the idea, then I'm interested in contributing! If there is anything I should keep in mind to get started, please let me know.

niniack avatar May 08 '22 09:05 niniack

Yes, that's what we want to achieve. I think you can start immediately, you don't need much background on avalanche to do it. You can make a PR once you have a couple of examples if you want some comments.

AntonioCarta avatar May 09 '22 07:05 AntonioCarta