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

docs: Updated docstrings of io, transforms & utils #859

Merged
merged 17 commits into from
Mar 18, 2022

Conversation

felixdittrich92
Copy link
Contributor

@codecov
Copy link

codecov bot commented Mar 16, 2022

Codecov Report

Merging #859 (488294a) into main (096eb48) will decrease coverage by 0.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main     #859      +/-   ##
==========================================
- Coverage   94.84%   94.82%   -0.02%     
==========================================
  Files         133      133              
  Lines        5200     5200              
==========================================
- Hits         4932     4931       -1     
- Misses        268      269       +1     
Flag Coverage Δ
unittests 94.82% <ø> (-0.02%) ⬇️

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

Impacted Files Coverage Δ
doctr/io/html.py 100.00% <ø> (ø)
doctr/io/image/base.py 100.00% <ø> (ø)
doctr/io/pdf.py 93.33% <ø> (ø)
doctr/io/reader.py 100.00% <ø> (ø)
doctr/transforms/modules/base.py 94.59% <ø> (ø)
doctr/transforms/modules/pytorch.py 72.22% <ø> (ø)
doctr/transforms/modules/tensorflow.py 82.41% <ø> (ø)
doctr/utils/data.py 88.67% <ø> (ø)
doctr/utils/geometry.py 100.00% <ø> (ø)
doctr/utils/metrics.py 97.36% <ø> (ø)
... 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 096eb48...488294a. Read the comment docs.

Copy link
Contributor

@fg-mindee fg-mindee left a comment

Choose a reason for hiding this comment

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

Thanks! Several comments in the review :)

doctr/transforms/modules/base.py Outdated Show resolved Hide resolved
doctr/transforms/modules/base.py Outdated Show resolved Hide resolved
doctr/transforms/modules/base.py Outdated Show resolved Hide resolved
doctr/transforms/modules/base.py Outdated Show resolved Hide resolved
doctr/transforms/modules/base.py Outdated Show resolved Hide resolved
doctr/transforms/modules/pytorch.py Outdated Show resolved Hide resolved
doctr/transforms/modules/pytorch.py Outdated Show resolved Hide resolved
doctr/transforms/modules/tensorflow.py Outdated Show resolved Hide resolved
@fg-mindee fg-mindee self-assigned this Mar 17, 2022
@fg-mindee fg-mindee added topic: documentation Improvements or additions to documentation type: enhancement Improvement ext: docs Related to docs folder labels Mar 17, 2022
@fg-mindee fg-mindee added this to the 0.6.0 milestone Mar 17, 2022
Copy link
Contributor

@fg-mindee fg-mindee left a comment

Choose a reason for hiding this comment

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

Thanks!

@fg-mindee fg-mindee added module: io Related to doctr.io module: utils Related to doctr.utils module: transforms Related to doctr.transforms and removed ext: docs Related to docs folder labels Mar 17, 2022
@fg-mindee fg-mindee changed the title Docs io and transforms #4 docs: Updated docstrings of io, transforms & utils Mar 17, 2022
@fg-mindee fg-mindee merged commit 6552d1f into mindee:main Mar 18, 2022
@felixdittrich92 felixdittrich92 deleted the docs-rest branch March 18, 2022 15:28
@frgfm frgfm mentioned this pull request Jun 28, 2022
85 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
module: io Related to doctr.io module: transforms Related to doctr.transforms module: utils Related to doctr.utils topic: documentation Improvements or additions to documentation type: enhancement Improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants