Skip to content

Commit 0938666

Browse files
authored
added basic guide (#63)
* added basic guide * corrected typos
1 parent cc88e64 commit 0938666

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Contributing Guide
2+
3+
This project is a community effort, and everyone is welcome to contribute !
4+
5+
If you are interested in contributing to PyTorch-Ignite's examples, there are many ways to help out. Your contributions may fall into the following categories:
6+
7+
1. It helps us very much if you could report issues you’re facing with:
8+
9+
- Executing the Juypter notebooks, scripts or rendering assets.
10+
- Understanding the language written in any of the notebooks that can be simplified.
11+
12+
2. You would like to add more examples. These fall into two categories:
13+
1. Tutorials: Something general which has emphasis on explanation and has self-contained end-to-end code which showcases an Ignite concept or concepts. These are meant for learning purposes when exploring the library. See cifar10 tutorial on distributed training: https://pytorch-ignite.ai/tutorials/cifar10-distributed/ for an example.
14+
2. How-to guides: These are very specific and more code-based. They are used to answer a specific question like how to use FastaiLR finder with Ignite or how to do cross validation. Comparing it with the `cifar10` tutorial above, if we were to make a how to guide it could go like: how to train a model using multiple gpus with ignite.
15+
16+
Please refer to [README.md](https://github.com/pytorch-ignite/examples#readme) on how to generate Jupyter notebooks with built-in frontmatter.
17+

0 commit comments

Comments
 (0)