Skip to content

Add a guide for creating new conversion packages for rosidl::Buffer#6654

Merged
ahcorde merged 2 commits into
rollingfrom
nvcyc/buffer_conversion_doc
May 11, 2026
Merged

Add a guide for creating new conversion packages for rosidl::Buffer#6654
ahcorde merged 2 commits into
rollingfrom
nvcyc/buffer_conversion_doc

Conversation

@nvcyc
Copy link
Copy Markdown
Contributor

@nvcyc nvcyc commented May 8, 2026

Description

Add a new page for a guide to creating a new conversion packages for rosidl::Buffer.

The page explains how conversions packages differ from rosidl::BufferBackend plugins: backends handle storage and transport, while conversions packages adapt existing ROS messages with uint8[] payload fields, such as tensors, images, or point clouds, into library-specific native types.

It also includes tensor-specific guidance for tensor_msgs/msg/ExperimentalTensor, documents torch_conversions as the first reference implementation, and outlines how future packages such as ONNX, NumPy, or CuPy conversions can interoperate through the common tensor message while using CPU or supported non-CPU buffer backends underneath.

Did you use Generative AI?

Yes, GPT-5.5 was used to help create an initial draft of the content.

@nvcyc nvcyc requested review from karsten-nvidia and yuanknv May 8, 2026 18:32
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 8, 2026

HTML artifacts: https://github.com/ros2/ros2_documentation/actions/runs/25677433100/artifacts/6921715528.

To view the resulting site:

  1. Click on the above link to download the artifacts archive
  2. Extract it
  3. Open html-artifacts-6654/index.html in your favorite browser

@ahcorde ahcorde merged commit 3900e22 into rolling May 11, 2026
7 checks passed
@ahcorde ahcorde deleted the nvcyc/buffer_conversion_doc branch May 11, 2026 15:07
ahcorde pushed a commit that referenced this pull request May 11, 2026
…6654) (#6682)

(cherry picked from commit 3900e22)

Signed-off-by: CY Chen <cyc@nvidia.com>
Co-authored-by: CY Chen <cyc@nvidia.com>
Co-authored-by: Michael Carroll <mjcarroll.oss@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants