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

[documentation/Fix] add documentation for huggingface feature and fix ocr_predictor model loading #896

Merged
merged 38 commits into from
Apr 28, 2022

Conversation

felixdittrich92
Copy link
Contributor

@felixdittrich92 felixdittrich92 commented Apr 23, 2022

This PR:

  • adds documentation how to use the huggingface integration (load / push)

  • add tables for community models

  • fix for passing a model itself directly to the predictor

Issue:
#426 (can be closed after merge)

  • TODO: rework text in documentation

Review:
Code: @charlesmindee
Documentation: @fharper

Any feedback is welcome :)

@codecov
Copy link

codecov bot commented Apr 23, 2022

Codecov Report

Merging #896 (07f4132) into main (43e5da3) will increase coverage by 0.00%.
The diff coverage is 95.23%.

@@           Coverage Diff           @@
##             main     #896   +/-   ##
=======================================
  Coverage   94.69%   94.70%           
=======================================
  Files         133      133           
  Lines        5377     5387   +10     
=======================================
+ Hits         5092     5102   +10     
  Misses        285      285           
Flag Coverage Δ
unittests 94.70% <95.23%> (+<0.01%) ⬆️

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

Impacted Files Coverage Δ
doctr/models/zoo.py 100.00% <ø> (ø)
doctr/models/detection/zoo.py 96.87% <90.00%> (+0.57%) ⬆️
doctr/models/detection/linknet/pytorch.py 99.00% <100.00%> (+0.01%) ⬆️
doctr/models/recognition/zoo.py 100.00% <100.00%> (ø)
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 43e5da3...07f4132. Read the comment docs.

@felixdittrich92 felixdittrich92 changed the title [WIP][documentation] add documentation for huggingface feature [WIP][documentation/Fix] add documentation for huggingface feature and fix ocr_predictor model loading Apr 24, 2022
@felixdittrich92 felixdittrich92 marked this pull request as ready for review April 25, 2022 06:09
@fharper fharper changed the title [WIP][documentation/Fix] add documentation for huggingface feature and fix ocr_predictor model loading [documentation/Fix] add documentation for huggingface feature and fix ocr_predictor model loading Apr 25, 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 for that, waiting for @fharper to review the doc part!

@charlesmindee
Copy link
Collaborator

is the "TODO: rework text in documentation" OK ?

@fharper
Copy link
Contributor

fharper commented Apr 27, 2022

As mentioned to @felixdittrich92, I'll review today or worse case tomorrow :)

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.

Content LGTM (I wasn't able to generate the doc caused I still have issues on my M1 even following the steps from someone else)

@fharper fharper added the ext: docs Related to docs folder label Apr 28, 2022
@fharper
Copy link
Contributor

fharper commented Apr 28, 2022

@charlesmindee: can you validate and update the labels please.

@fharper fharper merged commit 3d645ce into mindee:main Apr 28, 2022
@felixdittrich92 felixdittrich92 deleted the hf-docu branch April 29, 2022 06:46
@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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants