Skip to content

Merge develop into candidate#336

Merged
nileshnegi merged 3 commits into
candidatefrom
develop
Jul 15, 2026
Merged

Merge develop into candidate#336
nileshnegi merged 3 commits into
candidatefrom
develop

Conversation

@nileshnegi

Copy link
Copy Markdown
Collaborator

Motivation

Sync urgent fixes and doc changes from develop into candidate

Technical Details

Test Plan

Test Result

Submission Checklist

SwRaw and others added 3 commits July 8, 2026 22:46
* Revamping documentation

* More updates

* doc corrections

* Peer-review edits

* minor corrections

* Peter's review edits

* Update package_install.rst

* Review edits
Copilot AI review requested due to automatic review settings July 15, 2026 16:18
@nileshnegi
nileshnegi requested review from a team as code owners July 15, 2026 16:18

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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 SubExecParam to 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.

Comment thread src/header/TransferBench.hpp
@nileshnegi
nileshnegi merged commit cd7fa5e into candidate Jul 15, 2026
16 of 19 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.

5 participants