Skip to content

Revamping documentation#320

Closed
SwRaw wants to merge 2 commits into
ROCm:developfrom
SwRaw:transferbench-docs
Closed

Revamping documentation#320
SwRaw wants to merge 2 commits into
ROCm:developfrom
SwRaw:transferbench-docs

Conversation

@SwRaw

@SwRaw SwRaw commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

Motivation

Technical Details

Test Plan

Test Result

Submission Checklist

@SwRaw SwRaw requested a review from a team as a code owner June 8, 2026 10:57
@SwRaw SwRaw added documentation Improvements or additions to documentation ci:docs-only Skip most non-doc CI for this PR labels Jun 8, 2026

@mattwill-amd mattwill-amd left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Peer review 06/08

Comment thread docs/index.rst

TransferBench is a utility to benchmark simultaneous transfers between user-specified devices (CPUs or GPUs). A transfer is a single operation where an executor reads and adds values from source (SRC) memory locations, then writes the sum to destination (DST) memory locations.
This simplifies to a simple copy operation when dealing with a single SRC or DST.
TransferBench is a utility for benchmarking simultaneous memory transfers between user-specified devices (CPUs, GPUs, and NICs).

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This information may be slightly too long for the index page. I believe the guidance is: 2-3 sentences on the index page that briefly describes the component, then move large paragraphs of content to another "What is" page. Consider creating a new "What is Transferbench?" page and moving the content there.

Comment thread docs/index.rst
Comment thread docs/index.rst
Comment thread docs/index.rst Outdated
Comment thread docs/sphinx/_toc.yml.in Outdated
Comment thread docs/how to/running-presets.rst Outdated
Comment thread docs/how to/running-presets.rst Outdated
Comment thread docs/how to/running-presets.rst Outdated
Comment thread docs/how to/running-transferbench-customized.rst Outdated
Comment thread docs/reference/faq.rst
@SwRaw

SwRaw commented Jun 9, 2026

Copy link
Copy Markdown
Contributor Author

Closing this one as #321 has been opened.

@SwRaw SwRaw closed this Jun 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci:docs-only Skip most non-doc CI for this PR documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants