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 README and documentation #344

Merged
merged 5 commits into from
Jul 2, 2021
Merged

docs: Updated README and documentation #344

merged 5 commits into from
Jul 2, 2021

Conversation

fg-mindee
Copy link
Contributor

@fg-mindee fg-mindee commented Jul 2, 2021

This PR introduces the following modifications:

  • adds PyTorch reference in README & documentation
  • adapts the predictor description in the documentation
  • updated font of documentation

Closes #341

Any feedback is welcome!

@fg-mindee fg-mindee added the topic: documentation Improvements or additions to documentation label Jul 2, 2021
@fg-mindee fg-mindee added this to the 0.3.0 milestone Jul 2, 2021
@fg-mindee fg-mindee self-assigned this Jul 2, 2021
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!

@codecov
Copy link

codecov bot commented Jul 2, 2021

Codecov Report

Merging #344 (60c4cf5) into main (a5bbd53) will decrease coverage by 0.02%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #344      +/-   ##
==========================================
- Coverage   95.40%   95.37%   -0.03%     
==========================================
  Files          83       83              
  Lines        3393     3393              
==========================================
- Hits         3237     3236       -1     
- Misses        156      157       +1     
Flag Coverage Δ
unittests 95.37% <ø> (-0.03%) ⬇️

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

Impacted Files Coverage Δ
...dels/detection/differentiable_binarization/base.py 91.08% <0.00%> (-0.64%) ⬇️

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 a5bbd53...60c4cf5. Read the comment docs.

@fg-mindee fg-mindee merged commit f7f996e into main Jul 2, 2021
@fg-mindee fg-mindee deleted the doc-update branch July 2, 2021 14:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[docs] Incorrect predictor description in the documentation
2 participants