Skip to content
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

Move some debug examples to the source directory #8776

Closed
wants to merge 28 commits into from

Conversation

carmocca
Copy link
Contributor

@carmocca carmocca commented Aug 6, 2021

What does this PR do?

Moves RandomDataset, MNIST, BoringModel, and BoringDataModule to pytorch_lightning/utilities/debugging_examples.py

Unblocks:

See the links for context and reasoning.

The use of these implementations is internal. No backwards compatibility guarantees.

Does your PR introduce any breaking changes? If yes, please list them.

None

Before submitting

  • Was this discussed/approved via a GitHub issue? (not for typos and docs)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure your PR does only one thing, instead of bundling different changes together?
  • [n/a] Did you make sure to update the documentation with your changes? (if necessary)
  • Did you write any new necessary tests? (not for typos and docs)
  • Did you verify new and existing tests pass locally with your changes?
  • Did you list all the breaking changes introduced by this pull request?
  • [n/a] Did you update the CHANGELOG? (not for typos, docs, test updates, or internal minor changes/refactorings)

PR review

  • Is this pull request ready for review? (if not, please submit in draft mode)
  • Check that all items from Before submitting are resolved
  • Make sure the title is self-explanatory and the description concisely explains the PR
  • Add labels and milestones (and optionally projects) to the PR so it can be classified

@carmocca carmocca added the ci Continuous Integration label Aug 6, 2021
@carmocca carmocca added this to the v1.5 milestone Aug 6, 2021
@carmocca carmocca self-assigned this Aug 6, 2021
pytorch_lightning/utilities/debug_examples.py Outdated Show resolved Hide resolved
tests/__init__.py Show resolved Hide resolved
pytorch_lightning/utilities/debug_examples.py Outdated Show resolved Hide resolved
@carmocca carmocca changed the title Ci/move debug examples to source Move some debug examples to the source directory Aug 6, 2021
@carmocca carmocca mentioned this pull request Aug 6, 2021
12 tasks
@codecov
Copy link

codecov bot commented Aug 6, 2021

Codecov Report

Merging #8776 (5b51377) into master (6f3cb1a) will decrease coverage by 0%.
The diff coverage is 89%.

@@           Coverage Diff           @@
##           master   #8776    +/-   ##
=======================================
- Coverage      92%     92%    -0%     
=======================================
  Files         178     179     +1     
  Lines       14692   14861   +169     
=======================================
+ Hits        13524   13675   +151     
- Misses       1168    1186    +18     

@mergify mergify bot added the has conflicts label Aug 9, 2021
@mergify mergify bot removed the has conflicts label Aug 9, 2021
Copy link
Contributor

@tchaton tchaton left a comment

Choose a reason for hiding this comment

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

LGTM !

@tchaton tchaton added the ready PRs ready to be merged label Aug 9, 2021
@mergify mergify bot removed the has conflicts label Aug 23, 2021
@carmocca carmocca enabled auto-merge (squash) August 23, 2021 14:09
@carmocca carmocca disabled auto-merge August 23, 2021 14:41
@mergify mergify bot removed the has conflicts label Aug 23, 2021
@carmocca carmocca marked this pull request as draft August 23, 2021 15:34
@Borda
Copy link
Member

Borda commented Aug 24, 2021

@carmocca is this still draft?

@carmocca carmocca marked this pull request as ready for review August 24, 2021 11:38
@mergify mergify bot removed the has conflicts label Aug 24, 2021
@carmocca
Copy link
Contributor Author

@carmocca is this still draft?

No

@carmocca carmocca closed this Sep 21, 2021
@carmocca carmocca deleted the ci/move-debug-examples-to-source branch September 21, 2021 22:12
@carmocca
Copy link
Contributor Author

carmocca commented Sep 21, 2021

Closing because removing the pl_examples directory would be a better solution. These examples currently act as an extension of tests and have very low quality as teaching examples for new users.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci Continuous Integration has conflicts ready PRs ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants