-
Notifications
You must be signed in to change notification settings - Fork 18
Update documentation for Python interface #77
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
Conversation
LalehB
left a comment
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.
Thank you @draganaurosgrbic !
I have a few suggestions:
-
The bullet list of methods for tesseract in the “Explanation of each method” section still lists the old decode(detections: list[int]) API; consider updating it to include decode_from_detection_events, decode, and decode_batch for consistency
-
Align parameter names in the decode_to_errors overload with the implementation (det_order/det_beam rather than detector_order/detector_beam) to avoid confusion when referencing the code
-
The example code that follows the new section still demonstrates decoding via decode(detections); consider showing an example using the new decode_from_detection_events or decode (syndrome array) APIs for completeness
@LalehB Thank you. I addressed the second and third suggestions. I am not sure I understand your first suggestion. My bullet list already includes new methods ( |
you are right! Thank you. |
LalehB
left a comment
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.
LGTM!
thank you Dragana!
No description provided.