[Docs] Add docstrings to public pipeline and model base classes#17895
Open
robot010 wants to merge 1 commit intoPaddlePaddle:mainfrom
Open
[Docs] Add docstrings to public pipeline and model base classes#17895robot010 wants to merge 1 commit intoPaddlePaddle:mainfrom
robot010 wants to merge 1 commit intoPaddlePaddle:mainfrom
Conversation
Add Google-style docstrings to PaddleOCR, PPStructureV3, PaddleOCRVL, PaddleXPipelineWrapper, and PaddleXPredictorWrapper. Covers constructor parameters, usage examples, and predict_iter/predict return documentation. Co-Authored-By: Botao Deng <dengbotaoo@gmail.com>
|
|
|
Thanks for your contribution! |
Member
|
Thank you for the contribution! I noticed that some parameter descriptions in the docstrings seem to contain inaccuracies or mismatches with the actual implementation. Could you please take another look and verify them? Also, the |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add Google-style docstrings to PaddleOCR, PPStructureV3, PaddleOCRVL, PaddleXPipelineWrapper, and PaddleXPredictorWrapper. Covers constructor parameters, usage examples, and predict_iter/predict return documentation.