GSOC: Add GPU Explanation Section to Documentation

[rkierulf]

I added a section to the documentation explaining the GPU functionality a bit more based on the updates made this summer. Feel free to make any changes!

Since I'm using this as my GSOC work submission, I will also leave a list below of all PRs that were merged as part of this project. This particular PR is for documenting these updates in a new section of the repository documentation (https://juliahealth.org/KomaMRI.jl/previews/PR470/explanation/4-gpu-explanation/):

• Extend GPU support to Metal, ROCm, and oneAPI backends #405
• Fix some test failures #406
• Add Buildkite GPU pipeline #411
• Add kernel-based matrix cumsum #416
• Initial benchmarking implementation: steps to run benchmarks and comb… #418
• Updates to github-action-benchmark index.html #421
• Fix monorepo script not working for pushes to main #423
• Change 'main' to 'master' so benchmarking action actually runs #424
• Optimize run_spin_precession! and run_spin_excitation! for CPU #443
• Optimize run_spin_precession! for GPU #459
• Optimize run_spin_excitation! for GPU #462
• Add Distributed Examples to Documentation #468

[cncastillo]

Very nice! I think a few more details could be included to make the implementation easier to understand

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.93%. Comparing base (e805677) to head (d3268f2).
Report is 13 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master     #470   +/-   ##
=======================================
  Coverage   90.93%   90.93%           
=======================================
  Files          53       53           
  Lines        2934     2934           
=======================================
  Hits         2668     2668           
  Misses        266      266           

Flag	Coverage Δ
base	88.20% <ø> (ø)
core	92.61% <ø> (ø)
files	93.55% <ø> (ø)
komamri	93.98% <ø> (ø)
plots	89.30% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

[cncastillo]

Very nice!!! 🥳🥳🎊

[cncastillo]

Oh sorry, could you add the "using CUDA" to getting started and the readme and point to this section? As now it is needed for the GPU acceleration.

[rkierulf]

Yep, no problem! I think I got the URL correct for linking to the new section but I'll need to check once the documentation is built

[rkierulf]

Hmm, it looks like the URL still isn't appearing as a link. It might be ok once it gets merged into the main branch. Thoughts @cncastillo ?

[cncastillo]

Yeah, it makes sense. Let's put the URL for the readme later, in the docs I think you can do relative urls

[cncastillo]

I think the link was not using the correct syntax (comment)[linkurl] instead of [comment](linkurl).