-
Notifications
You must be signed in to change notification settings - Fork 21
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
GSOC: Add GPU Explanation Section to Documentation #470
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Very nice! I think a few more details could be included to make the implementation easier to understand
Codecov ReportAll modified and coverable lines are covered by tests ✅
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
Flags with carried forward coverage won't be shown. Click here to find out more. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Very nice!!! 🥳🥳🎊
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. |
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 |
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 ? |
Yeah, it makes sense. Let's put the URL for the readme later, in the docs I think you can do relative urls |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the link was not using the correct syntax (comment)[linkurl]
instead of [comment](linkurl)
.
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/):