pytorch / pytorch/rl

[Feature Request] Write tutorials as .py files

Open
#628 0 comments 1 reaction 1 assignee View on GitHub

@vmoens is already working on this.

Since Oct 31, 2022.

enhancement
Dominant language
Python
Stars
3.6k
Forks
484
Avg merge
1d 1h
Merged PRs (30d)
207

Description

Motivation

Tutorials would benefit from being written in .py files, as they are in pytorch/tutorials.

The advantages are:

  • fewer linting issues than .ipynb
  • Fewer lines of code
  • less issues with run/non-run cells
  • better integration in doc

Solution

Torch uses notebook styled examples for this.

## Features

The new tutorials should match exactly the old ones in their content. They should appear in the doc in a dedicated section and they should have the colab / download / github banners like https://pytorch.org/tutorials/ have.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.