-
-
Notifications
You must be signed in to change notification settings - Fork 615
Google Season of Docs 2021 Organization Proposal
This is our draft organization proposal based on official template
PyTorch-Ignite is an open-source project around machine/deep learning library to help with training and evaluating neural networks in PyTorch flexibly and transparently. Our contributors are data-science, machine/deep learning enthusiasts from all around the world, and our users are researchers, engineers, PhD students and people working in machine learning for various companies, universities and organizations. For details on our users, please see "Projects using Ignite". For a detailed project's history, active contributors, gouvernance, please see to this document. Since June 2020, PyTorch-Ignite becomes an NumFOCUS affiliated project which is a new step in our project’s development and promoting open practices in research and industry.
We provide "quick-start" and "concepts" guides, various tutorials as Google Colabs and examples as script files. Unfortunately, some of the tutorials, examples are less relevant and even out dated in terms of the API. In addition, large amount of information can not help user to understand basics and the power of the tool.
We would like to restructure and update this information giving essential and relevant information to new users in order to simplify the learning curve.
In this project we plan to :
-
Audit the existing documentation:
- GitHub's README.md,
- guidelines on the site: https://pytorch.org/ignite/
- tutorials and examples
-
Create a friction log of the current documentation for the use cases:
- quick-start with the library for a specific task
- how to build more complex trainings: cross-validation, hyperparameter tunning
- how to extend our out-of-the-box features
-
Use the friction log as a guide to rewrite the documentation and examples keeping only essential and relevant information
-
Incorporate feedback from documentation testers (volunteers in the project) and the wider PyTorch-Ignite community.
-
Better SEO for our documentation
-
Decrease in number of issues raised for topics covered in the documentation
-
Increase in number of documentation contributions
- Victor (@vfdev-5), can help with answering questions about the library and happy to review docs pull requests.
- Taras (@trsvchn), can help with answering questions about the library and happy to review docs pull requests.
- Sylvain (@sdesrozis), can occasionally help with docs pull requests reviews.
- Ahmed (@ahmedo42), can help with answering questions about the library and happy to review docs pull requests.
Technical writers interested in working on this project should, either
- a) send an email to vfdev.5@gmail.com (
contact@pytorch-ignite.ai) - b) or open a new Github Discussion with a reference GSoD2021.
Please include links to your technical writing work or portfolio/résumé/CV. Thank you!
| Budget item | Amount | Running/Total | Notes/justifications |
|---|---|---|---|
| Technical writer work | 7000.00 | 7000.00 | |
| Volunteer stipends | 500.00 | 8500.00 | 3 volunteer stipends x 500 each |
| Project t-shirts (5 t-shirts) | 100.00 | 8600.00 | T-Shirts for the top 5 contributors and helpers |
| Shipping cost of t-shirts | 50.00 | 8650.00 |
PyTorch-Ignite presented to you with love by PyTorch community