Skip to content

Improve Synet API documentation#367

Merged
ermig1979 merged 5 commits into
masterfrom
cursor/improve-synet-docs-e1ee
Jun 5, 2026
Merged

Improve Synet API documentation#367
ermig1979 merged 5 commits into
masterfrom
cursor/improve-synet-docs-e1ee

Conversation

@ermig1979
Copy link
Copy Markdown
Owner

@ermig1979 ermig1979 commented Jun 5, 2026

Summary

  • Improve SimdLib.h descriptions for Synet add, bias, channel-sum, 8-bit conversion, FP32/BF16/INT8 convolution, and FP32 deconvolution APIs based on their implementation behavior.
  • Document per-channel formulas, NCHW/NHWC offsets, BF16 conversion, supported Add16b types/shapes, UINT8 saturation ranges, convolution/deconvolution context validation, buffer sizing units, parameter and statistics handling, implementation info strings, quantization behavior, and forward behavior.

Testing

  • git diff --check
  • git diff --name-only
  • git status --short --branch

Full test suite was not run per request.

Open in Web Open in Cursor 

cursoragent and others added 5 commits June 5, 2026 08:45
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>
@ermig1979 ermig1979 marked this pull request as ready for review June 5, 2026 09:19
Copilot AI review requested due to automatic review settings June 5, 2026 09:19
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@ermig1979 ermig1979 merged commit 9c0da8d into master Jun 5, 2026
42 of 45 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants