MathiasMagnus SAXPY tutorial #3487

neon60 · 2024-05-17T14:34:31Z

The SAXPY tutorial.

docs/tutorials/reduction.rst

randyh62

provided comments

docs/tutorials/reduction.rst

neon60 · 2024-05-23T11:54:57Z

IMAGE OF FINAL ALGO is missing

neon60 · 2024-05-27T10:48:13Z

IMAGE OF FINAL ALGO is missing

Fixed.

peterjunpark · 2024-06-05T13:37:32Z

Added language suggestions from @lpaoletti. Review the diff if needed 2b4a8be

neon60 · 2024-06-05T14:51:24Z

@lpaoletti Can I get an approval?

neon60 · 2024-06-05T14:53:46Z

The reduction tutorial PR: #3513

peterjunpark · 2024-06-05T15:25:02Z

Should we remove the tab sync?

I don't like how the page jumps around when you select a tab due to the length of content changing all over the place at the same time.

neon60 · 2024-06-05T15:51:53Z

Should we remove the tab sync?

I don't like how the page jumps around when you select a tab due to content lengths changing everywhere at the same time.

Probably we should. I am thinking what we can do with it.

randyh62 · 2024-06-05T15:59:20Z

Should we remove the tab sync?
I don't like how the page jumps around when you select a tab due to content lengths changing everywhere at the same time.

Probably we should. I am thinking what we can do with it.

I think we should keep it. I think a user is going to pick their flow in the first tab, and the page will update the content to display their flow. I don't think people will be flipping back and forth between flows except to see what differences there might be.

docs/tutorial/saxpy.rst

cjatin · 2024-06-19T14:06:49Z

docs/tutorial/saxpy.rst

+============================
+
+First, let's do the "Hello, World!" of GPGPU: SAXPY. *SAXPY* is a mathematical
+acronym; a vector equation :math:`a\cdot x+y=z` where :math:`a\in\mathbb{R}` is


I think you have mentioned SAXPY's full form below. Can we move it up here.

cjatin · 2024-06-19T14:09:32Z

docs/tutorial/saxpy.rst

+
+``HIP_CHECK`` is a custom macro borrowed from the examples utilities which
+checks the error code returned by API functions for errors and reports them to
+the console. It's not essential to the API.


It is not essential to the API but it is a good practice to check the error codes of the HIP APIs incase you pass on incorrect values to the API or the API might be out of resources.

cjatin · 2024-06-19T14:12:05Z

docs/tutorial/saxpy.rst

+This function is launched from the host using a language extension often called
+the triple chevron syntax. Inside the angle brackets, provide the following.
+
+- The number of blocks to launch (our grid size)


Do we have any documentation describing grid and block sizes? If yes can we point the user to it from here. I think these are non trivial concepts and user who just wants to exec stuff on their GPU can go it it if they want to.

cjatin · 2024-06-19T14:14:46Z

docs/tutorial/saxpy.rst

+- A check is made to avoid overindexing the input.
+- The useful part of the computation is carried out.
+
+Retrieval of the result from the device is done much like its dispatching:


dispatching can mean different thing in context of HIP, can we change the wording here. Also the first memcpy should also be explained and here we can mention in simple terms that we are copying result back to host.

Removed dispatching.

docs/tutorial/saxpy.rst

cjatin · 2024-06-19T14:20:39Z

docs/tutorial/saxpy.rst

+  .. tab-item:: Linux and AMD
+    :sync: linux-amd
+
+    The utilities included with ROCm help significantly to inspect binary


I think binary inspection deserves its own doc, rather then putting it alongside saxpy explanation. In my head person looking for saxpy documentation will be least bothered with code object extraction and the person wanting to play with code objects will be least bothered with saxpy.

We can put this feedback to a separate issue. Currently, we do not have binary inspection tutorial and at least we have some here now.

If we finally have the binary inspection page, we can rethink this suggestion. Maybe I can put this into a dropdown:
https://sphinx-design.readthedocs.io/en/latest/dropdowns.html

What do you think?

I would rather have its own page, playing with code objects might require a bit more detail and populating here will overcomplicate this tutorial.

OK. I am creating a separate issue to remove the code inspection from here to a new code inspection tutorial.

The Boy Scout Rule: Leave the campground cleaner than you found it. → I am merging this in. One tutorial better than zero, and we will improve this later.

cjatin

Looks good

cjatin · 2024-06-25T09:17:34Z

docs/tutorial/saxpy.rst

+  .. tab-item:: Linux and AMD
+    :sync: linux-amd
+
+    The utilities included with ROCm help significantly to inspect binary


I would rather have its own page, playing with code objects might require a bit more detail and populating here will overcomplicate this tutorial.

docs/tutorial/saxpy.rst

neon60 · 2024-06-25T10:16:24Z

Looks good

Thanks for the review.

@lpaoletti

- Move md files to rst - Impl editorial suggestions from @lpaoletti - External PR feedbacks from HIP team

neon60 requested review from gandryey, mangupta and rakesroy as code owners May 17, 2024 14:34

neon60 marked this pull request as draft May 17, 2024 14:34

neon60 changed the base branch from develop to docs/develop May 17, 2024 14:39

neon60 marked this pull request as ready for review May 20, 2024 07:51

neon60 changed the title ~~WIP - MathiasMagnus SAXPY and Reduction tutorial~~ MathiasMagnus SAXPY and Reduction tutorial May 20, 2024

neon60 requested review from lpaoletti, matyas-streamhpc and randyh62 May 20, 2024 07:59

randyh62 reviewed May 22, 2024

View reviewed changes

docs/tutorials/reduction.rst Outdated Show resolved Hide resolved

randyh62 reviewed May 22, 2024

View reviewed changes

neon60 force-pushed the saxpy_reduction_tutorial branch from e65cedd to 00f592f Compare May 23, 2024 11:32

neon60 force-pushed the saxpy_reduction_tutorial branch from 177f56f to 317acf5 Compare May 24, 2024 07:56

neon60 force-pushed the docs/develop branch from ecf0b12 to 2a08a20 Compare May 24, 2024 11:22

neon60 force-pushed the saxpy_reduction_tutorial branch from 317acf5 to 7aa88ec Compare May 24, 2024 19:21

neon60 force-pushed the saxpy_reduction_tutorial branch 2 times, most recently from d919307 to b3fbc85 Compare May 28, 2024 12:04

peterjunpark force-pushed the saxpy_reduction_tutorial branch from 2b4a8be to 9a161d8 Compare June 5, 2024 13:41

neon60 force-pushed the saxpy_reduction_tutorial branch from 9a161d8 to 3f9ac23 Compare June 5, 2024 14:43

neon60 changed the title ~~MathiasMagnus SAXPY and Reduction tutorial~~ MathiasMagnus SAXPY tutorial Jun 5, 2024

lpaoletti reviewed Jun 5, 2024

View reviewed changes

docs/tutorial/saxpy.rst Outdated Show resolved Hide resolved

peterjunpark reviewed Jun 5, 2024

View reviewed changes

docs/tutorial/saxpy.rst Outdated Show resolved Hide resolved

neon60 force-pushed the docs/develop branch from 79ff964 to 097af3a Compare June 10, 2024 17:22

neon60 force-pushed the saxpy_reduction_tutorial branch from 915f342 to 3f163ee Compare June 10, 2024 19:42

cjatin requested changes Jun 19, 2024

View reviewed changes

neon60 force-pushed the docs/develop branch from a553751 to 8f70ab4 Compare June 20, 2024 16:31

neon60 force-pushed the saxpy_reduction_tutorial branch from 3f163ee to ea3aa3c Compare June 20, 2024 16:50

neon60 requested a review from cjatin June 21, 2024 11:58

cjatin approved these changes Jun 25, 2024

View reviewed changes

Add MathiasMagnus SAXPY tutorial

8a8e970

- Move md files to rst - Impl editorial suggestions from @lpaoletti - External PR feedbacks from HIP team

neon60 force-pushed the saxpy_reduction_tutorial branch from 8fb29dc to 8a8e970 Compare June 25, 2024 10:27

neon60 merged commit 1bf5ffa into docs/develop Jun 25, 2024
4 checks passed

neon60 deleted the saxpy_reduction_tutorial branch June 29, 2024 10:44

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

MathiasMagnus SAXPY tutorial #3487

MathiasMagnus SAXPY tutorial #3487

neon60 commented May 17, 2024 •

edited

Loading

randyh62 left a comment

neon60 commented May 23, 2024

neon60 commented May 27, 2024

peterjunpark commented Jun 5, 2024

neon60 commented Jun 5, 2024

neon60 commented Jun 5, 2024

peterjunpark commented Jun 5, 2024 •

edited

Loading

neon60 commented Jun 5, 2024

randyh62 commented Jun 5, 2024

cjatin Jun 19, 2024

neon60 Jun 21, 2024

cjatin Jun 19, 2024

neon60 Jun 21, 2024

cjatin Jun 19, 2024

neon60 Jun 21, 2024

cjatin Jun 19, 2024

neon60 Jun 21, 2024

cjatin Jun 19, 2024

neon60 Jun 21, 2024

cjatin Jun 25, 2024

neon60 Jun 25, 2024

cjatin left a comment

cjatin Jun 25, 2024

neon60 commented Jun 25, 2024

MathiasMagnus SAXPY tutorial #3487

MathiasMagnus SAXPY tutorial #3487

Conversation

neon60 commented May 17, 2024 • edited Loading

randyh62 left a comment

Choose a reason for hiding this comment

neon60 commented May 23, 2024

neon60 commented May 27, 2024

peterjunpark commented Jun 5, 2024

neon60 commented Jun 5, 2024

neon60 commented Jun 5, 2024

peterjunpark commented Jun 5, 2024 • edited Loading

neon60 commented Jun 5, 2024

randyh62 commented Jun 5, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cjatin left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

neon60 commented Jun 25, 2024

neon60 commented May 17, 2024 •

edited

Loading

peterjunpark commented Jun 5, 2024 •

edited

Loading