Skip to content

Conversation

@fg-mindee
Copy link
Contributor

This PR introduces the following modifications:

  • adds a table for text detection models in the documentation (archi, input shape, num of params, recall, precision, fps)
  • adds a table for text recognition models (archi, input shape, num of params, accuracy, fps)
  • adds a reference to those tables in the README

Successfully merging this PR will close #94

@fg-mindee fg-mindee added topic: documentation Improvements or additions to documentation type: enhancement Improvement labels Mar 1, 2021
@fg-mindee fg-mindee added this to the 0.2.0 milestone Mar 1, 2021
@fg-mindee fg-mindee self-assigned this Mar 1, 2021
* - Architecture
- Input shape
- # params
- Recall
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think we also need to reference the test dataset on which we evaluate the models

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Indeed, I left the value blank but I assumed we would mention the test set used above the table since it will have to apply to all entries for easier comparison 👍

@codecov
Copy link

codecov bot commented Mar 1, 2021

Codecov Report

Merging #106 (a45723e) into main (2468769) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #106   +/-   ##
=======================================
  Coverage   97.88%   97.88%           
=======================================
  Files          28       28           
  Lines         897      897           
=======================================
  Hits          878      878           
  Misses         19       19           
Flag Coverage Δ
unittests 97.88% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out 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 2468769...ce4c06e. Read the comment docs.

@fg-mindee fg-mindee merged commit 2c1d747 into main Mar 1, 2021
@fg-mindee fg-mindee deleted the doc-table branch March 1, 2021 17:36
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 type: enhancement Improvement

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[models] Add a descriptive table for pretrained models

3 participants