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

Update docs in using_doctr #993

Merged
merged 1 commit into from
Jul 26, 2022

Conversation

odulcy-mindee
Copy link
Collaborator

This PR aims to:

.. 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
Copy link
Collaborator Author

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]

Copy link
Collaborator

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? :)

Copy link
Collaborator Author

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 🤔

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, LGTM

@charlesmindee charlesmindee merged commit 23d1a1e into mindee:main Jul 26, 2022
Copy link
Collaborator

@frgfm frgfm 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 @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
Copy link
Collaborator

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? :)

docs/source/using_doctr/using_models.rst Show resolved Hide resolved
docs/source/using_doctr/using_models.rst Show resolved Hide resolved
docs/source/using_doctr/using_models.rst Show resolved Hide resolved
docs/source/using_doctr/using_models.rst Show resolved Hide resolved
docs/source/using_doctr/using_models.rst Show resolved Hide resolved
docs/source/using_doctr/using_models.rst Show resolved Hide resolved
@frgfm frgfm added type: enhancement Improvement ext: docs Related to docs folder labels Jul 26, 2022
@frgfm frgfm added this to the 0.6.0 milestone Jul 26, 2022
@odulcy-mindee
Copy link
Collaborator Author

odulcy-mindee commented Jul 26, 2022

@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:
image

You can see that there is a light blue background on each hyperlink on the screenshot. This is due to :py:meth:. This is not the case on the public docs:
image

Moreover, I added doctr.models.detection.linknet_resnet18_rotation and doctr.models.detection.differentiable_binarization.pytorch.db_resnet50_rotation in doctr.models in Package reference and there are still not present on public docs.

Also, I just noticed that Choose a ready to use dataset and Share your model with the community pages are not published. Is it expected ?

I'll check why it has not been correctly deployed.

@frgfm
Copy link
Collaborator

frgfm commented Jul 26, 2022

@odulcy-mindee my apologies, I selected the wrong version!
I realized this seeing your comment that the changes hadn't taken effect

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 :)
https://mindee.github.io/doctr/latest/using_doctr/using_models.html

All good then!

@odulcy-mindee
Copy link
Collaborator Author

@frgfm Oh cool ! Thanks for the tip haha ! 😅

@felixdittrich92 felixdittrich92 mentioned this pull request Sep 26, 2022
85 tasks
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.

3 participants