Docs: Add comment for IdentityResizer in image_resizer.proto#13578
Docs: Add comment for IdentityResizer in image_resizer.proto#13578rajonya-m wants to merge 1 commit intotensorflow:masterfrom
Conversation
|
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. |
|
I added this comment because IdentityResizer was previously undocumented in image_resizer.proto. For new users, it may not be obvious that this option is valid or what its purpose is. Documenting it clarifies that: |
|
It is an empty proto. It does not need to be documented by itself. |
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.