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: Added README specific for the API with route examples #612

Merged
merged 2 commits into from
Nov 15, 2021

Conversation

fg-mindee
Copy link
Contributor

Following on some QA feedback, this PR adds a dedicated README for the API template. It provides curated examples of inputs and outputs on each route.

Any feedback is welcome!

@fg-mindee fg-mindee added topic: documentation Improvements or additions to documentation ext: api Related to api folder labels Nov 12, 2021
@fg-mindee fg-mindee added this to the 0.5.0 milestone Nov 12, 2021
@fg-mindee fg-mindee self-assigned this Nov 12, 2021
@codecov
Copy link

codecov bot commented Nov 12, 2021

Codecov Report

Merging #612 (a3cbd30) into main (a792a82) will increase coverage by 0.14%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #612      +/-   ##
==========================================
+ Coverage   96.03%   96.18%   +0.14%     
==========================================
  Files         110      111       +1     
  Lines        4265     4296      +31     
==========================================
+ Hits         4096     4132      +36     
+ Misses        169      164       -5     
Flag Coverage Δ
unittests 96.18% <ø> (+0.14%) ⬆️

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

Impacted Files Coverage Δ
doctr/datasets/datasets/base.py 95.45% <0.00%> (-0.11%) ⬇️
doctr/datasets/__init__.py 100.00% <0.00%> (ø)
doctr/datasets/iiit5k.py 96.77% <0.00%> (ø)
...dels/detection/differentiable_binarization/base.py 91.82% <0.00%> (+0.62%) ⬆️
doctr/utils/data.py 98.11% <0.00%> (+9.43%) ⬆️

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 a792a82...a3cbd30. Read the comment docs.

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 the PR !

@fg-mindee fg-mindee merged commit ac7f92e into main Nov 15, 2021
@fg-mindee fg-mindee deleted the api-readme branch November 15, 2021 14:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ext: api Related to api folder topic: documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants