[RFC] Use papermill for running tutorials #1706
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
facebook-github-bot
added
the
CLA Signed
|
@esantorella has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator. |
Summary: ## Motivation We are using nbconvert to run tutorials. nbconvert is not really made for this use case, but papermill is, so we have some handwritten code than can be handled by papermill. With papermill, we can go a bit further and use SMOKE_TEST as a [parameter](https://papermill.readthedocs.io/en/latest/usage-parameterize.html) rather than an environment variable. That would make it easy for people to work with the tutorials as notebooks. Pull Request resolved: pytorch#1706 Test Plan: Ran tutorials locally and made sure smoke-test flag was getting used appropriately. ## Related pull requests Enabling papermill will make pytorch#1703, which automates running a notebook, a bit easier. Reviewed By: saitcakmak Differential Revision: D43631568 Pulled By: esantorella fbshipit-source-id: 66fbcca511beb9f46cc281c0ba74a27e4c86e46d
|
This pull request was exported from Phabricator. Differential Revision: D43631568 |
Codecov Report
@@ Coverage Diff @@
## main #1706 +/- ##
========================================
Coverage ? 100.00%
========================================
Files ? 170
Lines ? 14632
Branches ? 0
========================================
Hits ? 14632
Misses ? 0
Partials ? 0 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
|
@esantorella merged this pull request in eaa6fb2. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
We are using nbconvert to run tutorials. nbconvert is not really made for this use case, but papermill is, so we have some handwritten code than can be handled by papermill. With papermill, we can go a bit further and use SMOKE_TEST as a parameter rather than an environment variable. That would make it easy for people to work with the tutorials as notebooks.
Test Plan
Ran tutorials locally and made sure smoke-test flag was getting used appropriately.
Related pull requests
Enabling papermill will make #1703, which automates running a notebook, a bit easier.