Skip to content

Document backend-only Adapt targets - #50

Merged
nHackel merged 2 commits into
JuliaImageRecon:mainfrom
shukebeta:docs/issue-40-adapt-targets
Nov 4, 2026
Merged

nHackel merged 2 commits into
JuliaImageRecon:mainfrom
shukebeta:docs/issue-40-adapt-targets

Conversation

@shukebeta

Copy link
Copy Markdown
Contributor

As discussed in #49 (#49 (comment)), Adapt.adapt should be given the backing array type of the target backend, such as Array, CuArray or ROCArray, without element-type parameters. The element type is chosen when the operator is constructed.

  • Add a "Moving an Operator to Another Backend" section to the GPU how-to. It explains the target, contrasts it with the parameterized storage type S (CuArray{T, 1}), and gives a short GradientOp example in a non-executed code block.
  • State the same in the GradientOp docstring.

Documentation only. No code or test changes. julia --project=docs docs/make.jl builds locally.

shukebeta and others added 2 commits November 4, 2026 18:09
Adapt.adapt takes the backing array type of the target backend, such as
Array, CuArray or ROCArray, without element-type parameters; the element
type is chosen when the operator is constructed. Add a section to the GPU
guide that contrasts the Adapt target with the parameterized storage type
S, and state the same in the GradientOp docstring.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@codecov

codecov Bot commented Nov 4, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 81.23%. Comparing base (9fe52df) to head (c14b05c).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #50   +/-   ##
=======================================
  Coverage   81.23%   81.23%           
=======================================
  Files          15       15           
  Lines         613      613           
=======================================
  Hits          498      498           
  Misses        115      115           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@nHackel nHackel left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I like the howto GPU note on adaption. I think once everything is settled, you can do a last clean up pass and instead of each operator repeating what you essentially says there we can either just attach it to the specific adapt doc string or make a very small mention in the constructor.

Or even just a small list in the howto docs

I'll merge this for now

@nHackel
nHackel merged commit c88ef94 into JuliaImageRecon:main Nov 4, 2026
6 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.

2 participants