-
Notifications
You must be signed in to change notification settings - Fork 420
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
Update docs in using_doctr
#993
Update docs in using_doctr
#993
Conversation
.. autofunction:: doctr.models.detection.linknet_resnet34 | ||
|
||
.. autofunction:: doctr.models.detection.linknet_resnet50 | ||
|
||
.. autofunction:: doctr.models.detection.db_resnet50 | ||
|
||
.. autofunction:: doctr.models.detection.differentiable_binarization.pytorch.db_resnet50_rotation |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I needed to set here full path otherwise sphinx can't find this function due to this code:
if is_tf_available(): | |
from .tensorflow import * | |
elif is_torch_available(): | |
from .pytorch import * # type: ignore[misc] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps we should remove this for now then?
So far, we've been using tabs to have usage examples in PyTorch & TensorFlow, but we haven't yet planned to have seperate builds for pytorch and tensorflow (namely because we try to document high level features that have the same input & output signatures)
What do you think? :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@frgfm If possible, the db_resnet50_rotation
should be deployed on Tensorflow as well to stick with our high level features vision, but I don't know if it requires a lot a work. :-/
Maybe we can move this line in a dedicated section in which some models are only available in one framework (I'm not aware if it's the case for other models). Then we can reintegrate it when the model is available on both framework 🤔
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, LGTM
There was a problem hiding this 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 @odulcy-mindee 🙏
Quick note @charlesmindee @odulcy-mindee : about documentation modifications, we need to build it locally and try the changes. In this case, the PR breaks a lot of hyperlinks :/
.. autofunction:: doctr.models.detection.linknet_resnet34 | ||
|
||
.. autofunction:: doctr.models.detection.linknet_resnet50 | ||
|
||
.. autofunction:: doctr.models.detection.db_resnet50 | ||
|
||
.. autofunction:: doctr.models.detection.differentiable_binarization.pytorch.db_resnet50_rotation |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps we should remove this for now then?
So far, we've been using tabs to have usage examples in PyTorch & TensorFlow, but we haven't yet planned to have seperate builds for pytorch and tensorflow (namely because we try to document high level features that have the same input & output signatures)
What do you think? :)
@frgfm @charlesmindee I think something went wrong on GitHub page deployment. It seems that it has not been updated because links are still broken. I tested it locally before and here is the output: You can see that there is a light blue background on each hyperlink on the screenshot. This is due to Moreover, I added Also, I just noticed that I'll check why it has not been correctly deployed. |
@odulcy-mindee my apologies, I selected the wrong version! By default, the documentation leads you to the last stable release. So to get the latest build, you need to select "latest", and now this works :) All good then! |
@frgfm Oh cool ! Thanks for the tip haha ! 😅 |
This PR aims to:
db_resnet50_rotation
andlinknet_resnet18_rotation
in https://mindee.github.io/doctr/modules/models.html