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

Update docstring for GIoU metric #474

Merged
merged 4 commits into from
Jan 3, 2021
Merged

Update docstring for GIoU metric #474

merged 4 commits into from
Jan 3, 2021

Conversation

briankosw
Copy link
Contributor

What does this PR do?

Updates the docstring for GIoU metric #469 (comment). @akihironitta

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 🙃

@codecov
Copy link

codecov bot commented Dec 24, 2020

Codecov Report

Merging #474 (8089344) into master (a72766c) will increase coverage by 0.22%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #474      +/-   ##
==========================================
+ Coverage   80.52%   80.75%   +0.22%     
==========================================
  Files         103      103              
  Lines        5710     5710              
==========================================
+ Hits         4598     4611      +13     
+ Misses       1112     1099      -13     
Flag Coverage Δ
cpu 25.36% <ø> (ø)
pytest 25.36% <ø> (ø)
unittests 80.31% <ø> (+0.22%) ⬆️

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

Impacted Files Coverage Δ
pl_bolts/losses/object_detection.py 100.00% <ø> (ø)
pl_bolts/metrics/object_detection.py 100.00% <ø> (ø)
pl_bolts/datasets/cifar10_dataset.py 78.26% <0.00%> (+6.52%) ⬆️
pl_bolts/datasets/base_dataset.py 97.72% <0.00%> (+15.90%) ⬆️

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 a72766c...8089344. Read the comment docs.

@akihironitta akihironitta self-assigned this Dec 24, 2020
@akihironitta akihironitta added the documentation Improvements or additions to documentation label Dec 24, 2020
Copy link
Contributor

@akihironitta akihironitta left a comment

Choose a reason for hiding this comment

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

@briankosw Thank you! Can we have the same update for pytorch-lightning-bolts/pl_bolts/losses/object_detection.py?

pl_bolts/metrics/object_detection.py Outdated Show resolved Hide resolved
briankosw and others added 2 commits December 24, 2020 13:59
Co-authored-by: Akihiro Nitta <nitta@akihironitta.com>
pl_bolts/losses/object_detection.py Outdated Show resolved Hide resolved
pl_bolts/metrics/object_detection.py Outdated Show resolved Hide resolved
@akihironitta akihironitta self-requested a review December 24, 2020 08:06
Copy link
Contributor

@akihironitta akihironitta left a comment

Choose a reason for hiding this comment

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

@briankosw Looks great to me. Thank you for your contribution as always!

@Borda Borda merged commit 817979b into Lightning-Universe:master Jan 3, 2021
@Borda Borda added this to the v0.3 milestone Jan 18, 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 ready
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants