Skip to content

docs(getting-started): add image and data API tutorial#731

Merged
michalharakal merged 1 commit into
developfrom
docs/image-data-tutorial
Jun 10, 2026
Merged

docs(getting-started): add image and data API tutorial#731
michalharakal merged 1 commit into
developfrom
docs/image-data-tutorial

Conversation

@michalharakal

Copy link
Copy Markdown
Contributor

Summary

Adds a new getting-started tutorial covering SKaiNET's image/data stack — an area not yet documented in the tutorials section.

New page: tutorials/image-data-getting-started.adoc (Kotlin/JVM). Walks through how the three image modules fit together:

  • skainet-io-image — platform image ⇄ tensor (PlatformBitmapImage, platformImageSize)
  • skainet-data-transformpipeline() based resize / pad / toTensor / rescale preprocessing, demonstrated with a YOLO-style letterbox into a (1, 3, 640, 640) tensor
  • skainet-data-mediaImage.fromTensor(...) metadata wrapper (layout, color space)

Changes

  • New tutorial page (216 lines).
  • Wired into nav.adoc (under Tutorials) and the using/index.adoc section index (new "Working with images and image-shaped tensors" pointer, kept alongside the existing export/deployment section).
  • BOM pinned to the current 0.29.0 release (was 0.27.0), matching the other docs.

Verification

  • All referenced APIs verified to exist in develop with matching signatures (resize, pad(red/green/blue), toTensor(ctx), rescale(ctx, 255f), pipeline<T>(), Image.fromTensor, ImageLayout, ColorSpace).
  • All xref: link targets resolve.
  • Docs-only change; no source or build impact.

🤖 Generated with Claude Code

Add a Kotlin/JVM tutorial covering the skainet-io-image, skainet-data-transform, and skainet-data-media modules: load a platform image, letterbox it into a YOLO-style (1,3,H,W) tensor, and wrap it in the Image metadata API. Pin the BOM to the current 0.29.0 release and wire the page into nav and the Using section index.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown

📖 Documentation Preview

The documentation has been built successfully for this PR.

Generated Files:

  • Operator documentation: docs/modules/operators/_generated_/
  • JSON schema output: operators.json

Artifacts:

  • Download the documentation-preview-731 artifact to view the complete documentation locally.

This comment will be updated automatically when the PR is updated.

@michalharakal michalharakal merged commit 717a0b8 into develop Jun 10, 2026
7 checks passed
@michalharakal michalharakal deleted the docs/image-data-tutorial branch June 10, 2026 15:27
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.

1 participant