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

doc updates #530

Merged
merged 16 commits into from
Jan 20, 2021
Merged

doc updates #530

merged 16 commits into from
Jan 20, 2021

Conversation

ananyahjha93
Copy link
Contributor

@ananyahjha93 ananyahjha93 commented Jan 20, 2021

What does this PR do?

Fixes #499

Before submitting

  • Was this discussed/approved via a Github issue? (no need for typos and docs improvements)
  • 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?
  • Did you make sure to update the documentation with your changes?
  • Did you write any new necessary tests? [not needed for typos/docs]
  • Did you verify new and existing tests pass locally with your changes?
  • If you made a notable change (that affects users), did you update the CHANGELOG?

PR review

  • Is this pull request ready for review? (if not, please submit in draft mode)

Anyone in the community is free to review the PR once the tests have passed.
If we didn't discuss your PR in Github issues there's a high chance it will not be merged.

Did you have fun?

Make sure you had fun coding 🙃

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jan 20, 2021
@codecov
Copy link

codecov bot commented Jan 20, 2021

Codecov Report

Merging #530 (483328b) into master (268df20) will decrease coverage by 0.34%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #530      +/-   ##
==========================================
- Coverage   77.55%   77.21%   -0.35%     
==========================================
  Files         114      114              
  Lines        6670     6680      +10     
==========================================
- Hits         5173     5158      -15     
- Misses       1497     1522      +25     
Flag Coverage Δ
cpu 25.88% <ø> (+0.01%) ⬆️
pytest 25.88% <ø> (+0.01%) ⬆️
unittests 76.96% <ø> (-0.08%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
pl_bolts/callbacks/variational.py 82.75% <0.00%> (-13.16%) ⬇️
pl_bolts/callbacks/byol_updates.py 95.83% <0.00%> (-4.17%) ⬇️
pl_bolts/optimizers/lars_scheduling.py 74.46% <0.00%> (-2.90%) ⬇️
..._bolts/models/self_supervised/moco/moco2_module.py 70.62% <0.00%> (-1.00%) ⬇️
pl_bolts/datasets/ssl_amdim_datasets.py 75.34% <0.00%> (-0.98%) ⬇️
pl_bolts/datasets/imagenet_dataset.py 19.29% <0.00%> (-0.36%) ⬇️
pl_bolts/models/rl/common/gym_wrappers.py 85.15% <0.00%> (-0.34%) ⬇️
...lts/models/self_supervised/simclr/simclr_module.py 72.41% <0.00%> (-0.27%) ⬇️
pl_bolts/losses/self_supervised_learning.py 71.15% <0.00%> (-0.19%) ⬇️
...ts/models/autoencoders/basic_ae/basic_ae_module.py 88.00% <0.00%> (-0.16%) ⬇️
... and 4 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 268df20...483328b. Read the comment docs.

Copy link
Member

@Borda Borda left a comment

Choose a reason for hiding this comment

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

lets have it tested...

docs/source/models_howto.rst Outdated Show resolved Hide resolved
docs/source/models_howto.rst Outdated Show resolved Hide resolved
docs/source/models_howto.rst Outdated Show resolved Hide resolved
docs/source/models_howto.rst Outdated Show resolved Hide resolved
docs/source/models_howto.rst Outdated Show resolved Hide resolved
docs/source/self_supervised_models.rst Outdated Show resolved Hide resolved
@Borda Borda added the Priority High priority task label Jan 20, 2021
@Borda Borda added this to the v0.3 milestone Jan 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation Priority High priority task
Projects
None yet
Development

Successfully merging this pull request may close these issues.

can't import the VAE or CPCV2 model
2 participants