Repository: pytorch
Issue: ~PyTorch Docathon H1 2024!~
Labels: triaged,docathon-h1-2024

Hooray! It's this time of the year again and we are excited for you to participate in the PyTorch docathon. We have the following repositories participating:

- [pytorch/pytorch](https://github.com/pytorch/pytorch) 
- [pytorch/tutorials](https://github.com/pytorch/tutorials) 
- [pytorch/xla](https://github.com/pytorch/xla)
- [pytorch-labs/torchfix](https://github.com/pytorch-labs/torchfix)

The docathon starts on June 4 10 AM PST. Please do not work on tasks until then. We will continue accepting new submissions until 5 PM PST on June 16th.
# Registration
If you have not yet, please register for the docathon [here](https://community.linuxfoundation.org/events/details/lfhq-pytorch-foundation-presents-pytorch-docathon-june-4-20th-2024/?__hstc=132719121.074cf0f91adace3800e276889124a78e.1708732899717.1716414497649.1716482881400.202&__hssc=132719121.1.1716482881400&__hsfp=3065315178) to receive all the related communication.
# Date and location
**WHEN:** The docathon starts on June 4 at 10 AM PST. Please do not work on tasks until then. We will continue accepting new submissions until 5 PM PST on June 16th.
**WHERE:** Virtual
**WHAT:** Issues with the **docathon-h1-2024 label** - will be posted on June 4th.

# Can everyone participate?

We encourage everyone to consider participating in the docathon but there are a few things we expect from the participants:

- You must have a GitHub account and know how to use Git and GitHub, how to submit or rebase your PR on the latest main branch, how to fork or clone the repo, how to view errors in the CI and troubleshoot. We reserve the right to reject incorrectly submitted PRs.
- You must be familiar with Python, the basics of Machine Learning, and have at least a basic knowledge of PyTorch. Familiarity with Sphinx, sphinx-gallery, and reStructuredText is a plus.

# What contributions are we looking for?

All issues for this docathon are tagged with the docathon-h1-2024 label. Please note that contributions that address other issues won't be counted. We are primarily looking for the following contributions: 

- Docstring fixes
- Documentation bug fixes
- Tutorial fixes and testing

Before you start contributing make sure to read [Linux Foundation Code of Conduct](https://events.linuxfoundation.org/about/code-of-conduct/).

**NOTE:** Due to the large number of RSVPs, the tasks are provided on a first come first serve basis — please don't hoard the tasks!
# Difficulty Levels
The issues have three levels of difficulty: **easy**, **medium**, and **advanced**. If this is your first time contributing to PyTorch, we recommend that you start with an issue with a lower difficulty level.

# How to contribute to pytorch/pytorch?

1. Read the [PyTorch contributor wiki ](https://github.com/pytorch/pytorch/wiki)for general guidelines on how the submission process works and overall style and voice. 
2. Read [Docstring Guidelines](https://github.com/pytorch/pytorch/wiki/Docstring-Guidelines) for the information about docstring conventions and format.
3. Pick an issue that is labeled as [docathon-h1-2024](https://github.com/pytorch/pytorch/issues?q=is%3Aopen+label%3Adocathon-h1-2024+sort%3Aupdated-desc) and assign it to yourself by leaving the **/assigntome** comment. If the issue is already assigned, please find another issue to work on. We ask that you assign one issue at a time - we want to give everyone a fair chance to participate. When you are done with one issue and send a PR, you can assign another one to yourself and start working on it. Contributors violating this rule will be banned from the event.
4. Fork or clone the PyTorch repository to your computer. 
5. Create a branch and work on the fix, then submit your PR.

# Submitting Your PR
Submit your PR–tagged with the issue you've picked–against the main branch. Tag the issue you are fixing. For example:

<img width="1265" alt="openpr" src="https://github.com/pytorch/pytorch/assets/5317992/9a6092f0-6ce0-4162-aede-5a0967f23cd3">

If you have not yet, sign the Contributor License Agreement (CLA) - prompted as a check in the PR. We can't accept any PRs without a signed CLA.

Watch for any CI errors and fix as needed - all checks must pass successfully. 
The reviewers might provide feedback that we expect you to address.
When all feedback is addressed and your PR is approved - one of the reviewers will merge your PR. 

# Can I partner with someone to work on an issue?

Although most of the issues should be possible to address on your own, you may decide to partner with someone. You can find someone to work with on our Slack channel by posting a free-form request to collaborate. One individual from the group can submit a PR referring others as co-authors by specifying their GitHub usernames in the commit message like this:

```
Co-authored-by: NAME <NAME@EXAMPLE.COM>
Co-authored-by: ANOTHER-NAME <ANOTHER-NAME@EXAMPLE.COM>
```

Depending on the complexity of the issue, we reserve the right to decline contributions from multiple co-authors for trivial issues like fixing formatting, broken links, or very small code changes. For all issues, please, limit the number of co-authors to two. 

# Top contributors recognition

For all contributions addressing the **docathon-h1-2024** issues merged to the main branch in the participating repos during the period from June 4 to June 16, 5PM PST, you will get a special PyTorch Docathon GitHub badge. The issues will be released on the first day of the docathon. The top contributors will receive additional recognition and will be featured in a PyTorch social media announcement. In addition to the main repo and tutorials, this year, we will explicitly recognize a top contributor in each participating library repository.

# Questions?

You can post your questions here or in the [Discord server](https://discord.com/invite/NVYWkYQ6p5).