Improve Synet API documentation - #368
Merged
Merged
Conversation
Co-authored-by: Ihar Yermalayeu <ermig@tut.by>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves the in-header (Doxygen) documentation for several Synet-related public APIs in SimdLib.h, aligning the comments with the actual behavior and parameter semantics implemented in the Synet backends.
Changes:
- Expanded BF16/FP32 deconvolution (
SimdSynetDeconvolution16b*) documentation with shape constraints, buffer semantics, and forward behavior notes. - Clarified semantics for dequantization, eltwise, and multiple activation helpers (parameter units, “only [0] used” patterns, and formulas).
- Documented GatherElements and GridSample2D contexts with explicit tensor shapes, supported data types, and implementation notes; expanded inner-product API docs (FP32 and BF16/FP32) including buffer units and const-weight behavior.
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
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.
Summary
SimdLib.hdocumentation for Synet deconvolution, dequantization, eltwise, activation, gather-elements, grid-sample, and inner-product APIs based on implementation behavior.Testing
git diff --checkprintf '#include "Simd/SimdLib.h"\nint main(){return 0;}\n' | g++ -std=c++11 -I./src -x c++ -fsyntax-only -Full test suite was intentionally not run per request.