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

[improvement] Check and rework docs and docstrings #1502

Open
kuraga opened this issue Mar 5, 2024 · 2 comments
Open

[improvement] Check and rework docs and docstrings #1502

kuraga opened this issue Mar 5, 2024 · 2 comments
Labels
good first issue Good for newcomers help wanted Extra attention is needed topic: documentation Improvements or additions to documentation type: enhancement Improvement
Milestone

Comments

@kuraga
Copy link

kuraga commented Mar 5, 2024

It's also open see for guidiance: https://mindee.github.io/doctr/v0.8.1/using_doctr/custom_models_training.html

Only the mindee internal data which was used to train the models can't be shared because they contain sensible data :)

@felixdittrich92 , just quick notes
(don't know whether they are relevant, feel free to close):

  1. The link above doesn't contain classification, obj_detection.
  2. The classification's Data format part is a little bit strange: there are no any labels data.
  3. The obj_detection doesn't have README.md.

Also,

  1. https://mindee.github.io/doctr/v0.8.1/modules/models.html contains a Keras model statements.
  2. The Args there - are crumpled.
  3. The version switcher is a little bit buggy there.

Thanks!

@felixdittrich92
Copy link
Contributor

felixdittrich92 commented Mar 12, 2024

Hey @kuraga 👋

Sry for the late response,

  • (1 + 3). the current obj_detection doens't performs well i think we will remove/replace it in the coming releases

  • (2). classification is more for our internal use because it builds the backbones for our detection / recognition models and the orientation models i am not sure if it makes much sense to add it to the main documentation (would lead maybe to confusion !?)

  • (4 + 5). yeah you are right 👍 We are always happy about any kind of PR (including documentation fixes 😃)

@felixdittrich92 felixdittrich92 added topic: documentation Improvements or additions to documentation type: enhancement Improvement labels Mar 12, 2024
@felixdittrich92
Copy link
Contributor

yeah you are right 👍 We are always happy about any kind of PR (including documentation fixes 😃)

Assume it's about pp. 4., 5. 😄

Yep guidelines can be found here: https://mindee.github.io/doctr/contributing/contributing.html ^^

@felixdittrich92 felixdittrich92 changed the title Some documentation notes [improvement] Check and rework docs and docstrings May 22, 2024
@felixdittrich92 felixdittrich92 added help wanted Extra attention is needed good first issue Good for newcomers labels May 22, 2024
@felixdittrich92 felixdittrich92 added this to the 2.0.0 milestone Jun 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed topic: documentation Improvements or additions to documentation type: enhancement Improvement
Projects
None yet
Development

No branches or pull requests

2 participants