Skip to content

docs(gpu-offload): update provenance documentation - #2203

Open
SHIVANG RAJ (shivang-raj) wants to merge 6 commits into
microsoft:mainfrom
shivang-raj:docs/update-gpu-offload-provenance-2194
Open

SHIVANG RAJ (shivang-raj) wants to merge 6 commits into
microsoft:mainfrom
shivang-raj:docs/update-gpu-offload-provenance-2194

Conversation

@shivang-raj

@shivang-raj SHIVANG RAJ (shivang-raj) commented Nov 11, 2026 •

Copy link
Copy Markdown
Contributor

Pull Request

Description

Updates gpu-offload/PROVENANCE.md to address the documentation issues raised in #2194.

Changes include:

  • Clarified the upstream snapshot and its recorded file dispositions.
  • Clarified that licensing permission for reuse of the pinned upstream snapshot was recorded during the original port (feat(deployment): add Xavier GPU offload for robot inference #1556).
  • Documented that audit evidence for the licensing permission remains outstanding and is tracked in XAVIER-PORTING.md.
  • Restored the explicit MIT licensing statement covering repository-authored and adapted GPU-offload material.
  • Clarified the distinction between repository licensing and third-party dependency licensing.
  • Documented the pinned LeRobot Python dependency (0.6.1).
  • Removed the outdated ROS 2 bridge Apache-2.0 exception and references to the missing ros2_bridge/ directory.

Closes #2194

Type of Change

  • Bug fix (non-breaking change fixing an issue)
  • ✨ New feature (non-breaking change adding functionality)
  • Breaking change (fix or feature causing existing functionality to change)
  • Documentation update
  • Infrastructure change (Terraform/IaC)
  • ♻️ Refactoring (no functional changes)

Component(s) Affected

  • gpu-offload/ - GPU offload documentation
  • docs/ - Documentation

Testing Performed

  • git diff --check passed
  • Reviewed the documentation changes
  • Functional testing (not applicable; documentation-only change)

Documentation Impact

  • No documentation changes needed
  • Documentation updated in this PR
  • Documentation issue filed

Bug Fix Checklist

Not applicable — documentation-only change.

Checklist

  • Commit message follows conventional commit format
  • Changes reviewed locally
  • Documentation impact assessed
  • No new linting warnings introduced

Formatted the provenance table and standardized the spelling of license.

Prepared by GPT (OpenAI Codex) at Shivang Raj's request; committed under Shivang Raj's GitHub account.
@shivang-raj

Copy link
Copy Markdown
Contributor Author

Please review this Katrien De Graeve (@katriendg)

@codecov-commenter

Codecov Comments Bot (codecov-commenter) commented Nov 17, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 87.17%. Comparing base (23f78a8) to head (6c239fb).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2203      +/-   ##
==========================================
- Coverage   87.30%   87.17%   -0.13%     
==========================================
  Files         402      389      -13     
  Lines       52480    51386    -1094     
  Branches     7309     7162     -147     
==========================================
- Hits        45817    44796    -1021     
+ Misses       5362     5319      -43     
+ Partials     1301     1271      -30     
Flag Coverage Δ *Carryforward flag
docusaurus 89.13% <ø> (ø) Carriedforward from 23f78a8
go 100.00% <ø> (ø)
pester 88.40% <ø> (ø) Carriedforward from 23f78a8
pytest-accessibility 82.41% <ø> (ø) Carriedforward from 23f78a8
pytest-curation 95.92% <ø> (ø) Carriedforward from 23f78a8
pytest-data-pipeline 100.00% <ø> (ø) Carriedforward from 23f78a8
pytest-dataset-io 97.48% <ø> (ø) Carriedforward from 23f78a8
pytest-dataviewer 91.55% <ø> (ø) Carriedforward from 23f78a8
pytest-dm-tools 93.20% <ø> (ø) Carriedforward from 23f78a8
pytest-evaluation 79.45% <ø> (ø)
pytest-fuzz 1.74% <ø> (ø) Carriedforward from 23f78a8
pytest-inference 99.16% <ø> (ø) Carriedforward from 23f78a8
pytest-shared-ci 100.00% <ø> (ø) Carriedforward from 23f78a8
pytest-training 91.79% <ø> (ø) Carriedforward from 23f78a8
pytest-vlm-judge ∅ <ø> (∅) Carriedforward from 23f78a8
vitest 92.83% <ø> (ø) Carriedforward from 23f78a8
vitest-app 87.50% <ø> (ø) Carriedforward from 23f78a8
vitest-components 91.55% <ø> (ø) Carriedforward from 23f78a8
vitest-features 90.33% <ø> (ø) Carriedforward from 23f78a8
vitest-lib 96.06% <ø> (ø) Carriedforward from 23f78a8
vitest-state 94.13% <ø> (ø) Carriedforward from 23f78a8

*This pull request uses carry forward flags. Click here to find out more.
see 13 files with indirect coverage changes

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@jkim323 Jamie Kim (jkim323) 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.

Thank you for picking up #2194, SHIVANG RAJ (@shivang-raj), and for checking this provenance record against what's actually in the tree. You're right that ros2_bridge/ never landed on main, so removing that Apache-2.0 exception makes the file more accurate, and recording the LeRobot 0.6.1 pin is a helpful addition.

Because this file is the licensing record behind the MIT headers on the adapted gpu-offload files, we have a few suggested changes before merge:

  • Keep an explicit MIT statement that covers the material adapted from the upstream reference (lines 47-49).
  • State the licensing permission directly rather than citing an "original porting record" that readers can't locate (lines 29 and 33-34).
  • Remove the paragraph about the missing ros2_bridge/ directory (lines 58-61).
  • Mention the MIT section change in the PR description, and check or briefly explain the two open checklist items.

Each inline comment includes a suggestion you can apply directly. Please comment if you have questions about any of these, and we're happy to discuss.

Comment thread gpu-offload/PROVENANCE.md Resolved
Comment thread gpu-offload/PROVENANCE.md Resolved
Comment thread gpu-offload/PROVENANCE.md Resolved
Comment thread gpu-offload/PROVENANCE.md Resolved
@shivang-raj

Copy link
Copy Markdown
Contributor Author

Jamie Kim (@jkim323) Thanks for the detailed review and suggestions!

I've addressed all four inline comments in the latest commit:

  • Removed the unnecessary reference to the original porting record.
  • Clarified the licensing permission history and linked the outstanding audit-evidence checkpoint in XAVIER-PORTING.md.
  • Restored the explicit MIT licensing statement for adapted GPU-offload material.
  • Removed the paragraph referring to the missing ros2_bridge/ directory.

I've also updated the PR description to reflect the licensing clarification.

Thanks again for the helpful feedback!

@shivang-raj

Copy link
Copy Markdown
Contributor Author

Jamie Kim (@jkim323) please review this once free.
Thanks!

This branch has not been deployed

No deployments
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.

docs: Update stale documentation - gpu-offload/PROVENANCE.md

3 participants