Merge develop into candidate#336
Merged
Merged
Conversation
* Revamping documentation * More updates * doc corrections * Peer-review edits * minor corrections * Peter's review edits * Update package_install.rst * Review edits
Contributor
There was a problem hiding this comment.
Pull request overview
This PR syncs develop into candidate by bringing in a host-accessibility fix for reading GPU sub-executor parameters (to support systems where host cannot directly read GPU allocations) and a substantial documentation reorganization/expansion to improve end-user guidance.
Changes:
- Add host-accessibility detection for GPU allocations and fall back to copying
SubExecParamto host when needed. - Expand and restructure Sphinx documentation (new conceptual/how-to/reference pages, updated TOC and index).
- Update license year.
Reviewed changes
Copilot reviewed 14 out of 27 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
src/header/TransferBench.hpp |
Adds GetMemHostAccessibility(), tracks subExecParamHostAccessible, and conditionally copies GPU sub-exec params to host for per-iteration CU/timing data; adds an extra device sync during SRC buffer initialization. |
LICENSE.md |
Updates copyright year to 2026. |
docs/what-is-transferbench.rst |
Adds a new high-level overview page. |
docs/sphinx/_toc.yml.in |
Reorganizes the documentation TOC and adds new sections/pages. |
docs/reference/transfer-definition-syntax.rst |
Adds detailed transfer definition syntax reference. |
docs/reference/presets.rst |
Adds an extensive presets reference page. |
docs/reference/faq.rst |
Adds a FAQ page covering common issues and warnings. |
docs/reference/environment-variables.rst |
Adds a consolidated environment variables reference. |
docs/install/install.rst |
Removes the prior install page (replaced by new build-from-source doc). |
docs/install/build_from_source.rst |
Adds a new build-from-source guide (Makefile + CMake). |
docs/index.rst |
Updates doc landing page content/links to match the new structure. |
docs/how to/running-transferbench-customized.rst |
Adds a how-to guide for running custom tests (config/cmdline/dryrun). |
docs/conceptual/transferbench-workflow.rst |
Adds conceptual overview of backend workflow phases. |
docs/conceptual/transferbench-timing.rst |
Adds conceptual explanation of timing methodology. |
docs/conceptual/transferbench-data-validation.rst |
Adds conceptual explanation of correctness validation. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
gilbertlee-amd
approved these changes
Jul 15, 2026
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.
Motivation
Sync urgent fixes and doc changes from
developintocandidateTechnical Details
Test Plan
Test Result
Submission Checklist