Docs: Add comment for IdentityResizer in image_resizer.proto #13578
+8
−0
Conversation
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
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Summary
This PR adds documentation for the IdentityResizer message in the image_resizer.proto file under the Object Detection API.
Motivation and Context
The IdentityResizer option was previously undocumented, making it unclear what its function was in the image resizing configuration. This update clarifies that it performs no resizing and is appropriate for use cases where the input images are already preprocessed or when using models that support dynamic input sizes.
Dependencies
No new dependencies are introduced.
Type of change
Documentation update
Tests
Since this is a documentation-only change in a .proto file, no runtime tests were needed. The updated comments were manually reviewed in VS Code to ensure correct syntax and formatting.
Test Configuration:
Editor: Visual Studio Code
OS: Windows 10
Environment: Git Bash terminal
Validation: Manual .proto formatting and placement check
Checklist
I have signed the Contributor License Agreement.
I have read guidelines for pull request.
My code follows the coding guidelines.
I have performed a self code review of my own code.
I have commented my code, particularly in hard-to-understand areas.
I have made corresponding changes to the documentation.
My changes generate no new warnings.
[n/a] I have added tests that prove my fix is effective or that my feature works.