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.

Sign up for GitHub

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

Jump to bottom

docs: Adds illustration in the docstrings of doctr.datasets #857

Merged
merged 16 commits into from
Mar 18, 2022
Merged

docs: Adds illustration in the docstrings of doctr.datasets #857

merged 16 commits into from
Mar 18, 2022

Conversation

felixdittrich92
Copy link
Contributor

@codecov
Copy link

codecov bot commented Mar 16, 2022

Codecov Report

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

@@            Coverage Diff             @@
##             main     #857      +/-   ##
==========================================
- 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/datasets/cord.py 97.43% <ø> (ø)
doctr/datasets/detection.py 95.65% <ø> (ø)
doctr/datasets/doc_artefacts.py 93.93% <ø> (ø)
doctr/datasets/funsd.py 96.96% <ø> (ø)
doctr/datasets/generator/pytorch.py 100.00% <ø> (ø)
doctr/datasets/generator/tensorflow.py 100.00% <ø> (ø)
doctr/datasets/ic03.py 97.36% <ø> (ø)
doctr/datasets/ic13.py 96.15% <ø> (ø)
doctr/datasets/iiit5k.py 96.77% <ø> (ø)
doctr/datasets/imgur5k.py 92.50% <ø> (ø)
... and 8 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...de8aeda. Read the comment docs.

@felixdittrich92 felixdittrich92 changed the title Doc dataset Doc dataset #2 Mar 16, 2022
@fg-mindee fg-mindee self-requested a review March 16, 2022 14:50
@fg-mindee fg-mindee self-assigned this Mar 16, 2022
@fg-mindee fg-mindee added topic: documentation Improvements or additions to documentation type: enhancement Improvement module: datasets Related to doctr.datasets labels Mar 16, 2022
@fg-mindee fg-mindee added this to the 0.6.0 milestone Mar 16, 2022
fg-mindee
fg-mindee approved these changes Mar 16, 2022
View reviewed changes
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! It builds & renders well on the previous theme 👍

@fg-mindee fg-mindee changed the title Doc dataset #2 docs: Adds illustration in the docstrings of doctr.datasets Mar 16, 2022
@fg-mindee fg-mindee merged commit f586d8e into mindee:main Mar 18, 2022
@felixdittrich92 felixdittrich92 mentioned this pull request Mar 18, 2022
Closed
@felixdittrich92 felixdittrich92 deleted the doc-dataset branch March 18, 2022 15:28
@frgfm frgfm mentioned this pull request Jun 28, 2022
Closed
85 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fg-mindee fg-mindee fg-mindee approved these changes

Assignees

@fg-mindee fg-mindee

Labels
module: datasets Related to doctr.datasets topic: documentation Improvements or additions to documentation type: enhancement Improvement
Projects
None yet
Milestone
0.6.0
Development

Successfully merging this pull request may close these issues.
2 participants
@felixdittrich92 @fg-mindee