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: add rotation in docs #846

Merged
merged 2 commits into from
Mar 9, 2022
Merged

docs: add rotation in docs #846

merged 2 commits into from
Mar 9, 2022

Conversation

charlesmindee
Copy link
Collaborator

This PR specifiy args to pass to predictors to work with rotated documents in the docs, and provides some snippets.

Any feedback is welcome!

Closes #807

@charlesmindee charlesmindee added the ext: docs Related to docs folder label Mar 9, 2022
@charlesmindee charlesmindee added this to the 0.5.1 milestone Mar 9, 2022
@charlesmindee charlesmindee self-assigned this Mar 9, 2022
@codecov
Copy link

codecov bot commented Mar 9, 2022

Codecov Report

Merging #846 (fdaa811) into main (9b31588) will decrease coverage by 0.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #846      +/-   ##
==========================================
- Coverage   95.94%   95.92%   -0.02%     
==========================================
  Files         133      133              
  Lines        5103     5103              
==========================================
- Hits         4896     4895       -1     
- Misses        207      208       +1     
Flag Coverage Δ
unittests 95.92% <ø> (-0.02%) ⬇️

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

Impacted Files Coverage Δ
doctr/transforms/functional/base.py 95.65% <0.00%> (-1.45%) ⬇️

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 9b31588...fdaa811. 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 for the PR!
A few typos to fix and we're good to go!

docs/source/using_models.rst Outdated Show resolved Hide resolved
docs/source/using_models.rst Outdated Show resolved Hide resolved
docs/source/using_models.rst Outdated Show resolved Hide resolved
docs/source/using_models.rst Outdated Show resolved Hide resolved
docs/source/using_models.rst Outdated Show resolved Hide resolved
docs/source/using_models.rst Outdated Show resolved Hide resolved
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 changed the title feat: add rotation in docs docs: add rotation in docs Mar 9, 2022
@fg-mindee fg-mindee added the type: enhancement Improvement label Mar 9, 2022
@charlesmindee charlesmindee merged commit 37bf626 into main Mar 9, 2022
@charlesmindee charlesmindee deleted the doc_skewed branch March 9, 2022 11:24
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 type: enhancement Improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[docs] Document usage of predictors on skewed documents
2 participants