Repository navigation
[improvement] Check and rework docs and docstrings #1502
Description
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):
- The link above doesn't contain
classification,obj_detection. - The
classification'sData formatpart is a little bit strange: there are no any labels data. - The
obj_detectiondoesn't haveREADME.md.
Also,
- https://mindee.github.io/doctr/v0.8.1/modules/models.html contains
a Keras modelstatements. - The
Argsthere - are crumpled. - The version switcher is a little bit buggy there.
Thanks!
Activity
felixdittrich92 commentedon Mar 12, 2024
Hey @kuraga 👋
Sry for the late response,
(1 + 3). the current
obj_detectiondoens't performs well i think we will remove/replace it in the coming releases(2).
classificationis 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 commentedon Mar 12, 2024
Yep guidelines can be found here: https://mindee.github.io/doctr/contributing/contributing.html ^^
[-]Some documentation notes[/-][+][improvement] Check and rework docs and docstrings[/+]