Skip to content

Add a Python tutorial template #2264

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Mar 29, 2023
Merged

Add a Python tutorial template #2264

merged 7 commits into from
Mar 29, 2023

Conversation

svekars
Copy link
Contributor

@svekars svekars commented Mar 21, 2023

Add a tutorial template for interactive tutorials stored in Python files.

@netlify
Copy link

netlify bot commented Mar 21, 2023

Deploy Preview for pytorch-tutorials-preview ready!

Name Link
🔨 Latest commit 9c10300
🔍 Latest deploy log https://app.netlify.com/sites/pytorch-tutorials-preview/deploys/64246d04ad1de5000810b31e
😎 Deploy Preview https://deploy-preview-2264--pytorch-tutorials-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@svekars svekars requested a review from carljparker March 24, 2023 16:45
</div>

To test your tutorial locally, make a copy of this repo and add only your
tutorial removing everything. Then run ``make html``. Verify that all outputs were generated correctly
Copy link
Contributor

@carljparker carljparker Mar 24, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggest that we add "else": "removing everything" -> "removing everything else"

#
# Example code (the output below is generated automatically):
#
import torch
Copy link
Contributor

@carljparker carljparker Mar 24, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[Non-blocking comment]: Will we know which libraries they import just by inspecting their code? I think that is probably the most efficient way. If we ask them to list their imports in a second location--such as above--then we have the possibility that list will get out of sync with what they actually end up importing.

In other words, I think we are all good here as is . . . :-)


To test your tutorial locally, make a copy of this repo and add only your
tutorial removing everything. Then run ``make html``. Verify that all outputs were generated correctly
in the created HTML.
Copy link
Contributor

@carljparker carljparker Mar 24, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[Non-blocking comment]: Do we want to start requiring that people run pylint or flake8 or black? Let's discuss--but not a reason to wait on merging.

Copy link
Contributor

@carljparker carljparker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggest one minor text edit, otherwise LGTM.

Svetlana Karslioglu added 3 commits March 24, 2023 14:30
Address feedback and add another option to build locally
@svekars svekars requested a review from carljparker March 28, 2023 16:44
Copy link
Contributor

@carljparker carljparker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm so happy.

@svekars svekars merged commit f136228 into main Mar 29, 2023
@svekars svekars deleted the add-tutorial-template branch March 29, 2023 19:41
svekars pushed a commit that referenced this pull request Mar 31, 2023
* Add a Python tutorial template
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants