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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docu]: add documentation for datasets #905

Merged
merged 6 commits into from
May 2, 2022

Conversation

felixdittrich92
Copy link
Contributor

This PR:

  • add section in documentation how to use datasets
  • add some dataset informations

Issue:
#855

Any feedback is welcome 馃

@codecov
Copy link

codecov bot commented Apr 29, 2022

Codecov Report

Merging #905 (94b732b) into main (3d645ce) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #905   +/-   ##
=======================================
  Coverage   94.73%   94.73%           
=======================================
  Files         134      134           
  Lines        5472     5472           
=======================================
  Hits         5184     5184           
  Misses        288      288           
Flag Coverage 螖
unittests 94.73% <酶> (酶)

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

Impacted Files Coverage 螖
doctr/datasets/generator/pytorch.py 100.00% <酶> (酶)
doctr/datasets/generator/tensorflow.py 100.00% <酶> (酶)
doctr/datasets/loader.py 100.00% <酶> (酶)
doctr/datasets/ocr.py 92.30% <酶> (酶)
doctr/transforms/modules/base.py 94.59% <0.00%> (酶)

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 3d645ce...94b732b. Read the comment docs.

@felixdittrich92 felixdittrich92 changed the title [WIP][docu]: add documentation for datasets [docu]: add documentation for datasets Apr 29, 2022
@felixdittrich92 felixdittrich92 marked this pull request as ready for review April 29, 2022 12:24
@felixdittrich92
Copy link
Contributor Author

felixdittrich92 commented Apr 29, 2022

@fharper please review :D

I have attached the docu for you 馃憤
docu.zip

@fharper fharper self-requested a review April 29, 2022 17:44
Copy link
Contributor

@fharper fharper left a comment

Choose a reason for hiding this comment

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

documentation looks good!

@charlesmindee can you review the small changes in the code please :)

@felixdittrich92 felixdittrich92 added ext: docs Related to docs folder topic: documentation Improvements or additions to documentation labels May 2, 2022
Copy link
Collaborator

@charlesmindee charlesmindee left a comment

Choose a reason for hiding this comment

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

Thanks!

@charlesmindee charlesmindee merged commit bbc16f0 into mindee:main May 2, 2022
@frgfm frgfm added the type: new feature New feature label May 2, 2022
@felixdittrich92 felixdittrich92 deleted the datasets-docu branch May 6, 2022 11:08
@felixdittrich92 felixdittrich92 added this to the 0.6.0 milestone Jun 28, 2022
@felixdittrich92 felixdittrich92 mentioned this pull request Jun 29, 2022
85 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ext: docs Related to docs folder topic: documentation Improvements or additions to documentation type: new feature New feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants