Improve Synet API documentation#367
Merged
Merged
Conversation
Co-authored-by: Ihar Yermalayeu <ermig@tut.by>
Co-authored-by: Ihar Yermalayeu <ermig@tut.by>
Co-authored-by: Ihar Yermalayeu <ermig@tut.by>
Co-authored-by: Ihar Yermalayeu <ermig@tut.by>
Co-authored-by: Ihar Yermalayeu <ermig@tut.by>
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request updates the public Synet API documentation in SimdLib.h to more accurately reflect the actual runtime behavior and constraints of several Synet operations (add/bias, channel sum, 8-bit conversion, and convolution/deconvolution contexts).
Changes:
- Expanded API docs with explicit per-format (NCHW/NHWC) indexing formulas and BF16/FP32 conversion semantics.
- Clarified convolution/deconvolution context validation rules (type/format constraints) and output shape formulas.
- Documented buffer sizing units (elements vs bytes) and clarified implementation info/parameter attachment behavior for convolution contexts.
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.hdescriptions for Synet add, bias, channel-sum, 8-bit conversion, FP32/BF16/INT8 convolution, and FP32 deconvolution APIs based on their implementation behavior.Testing
git diff --checkgit diff --name-onlygit status --short --branchFull test suite was not run per request.