Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Updated docs #473

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Updated docs #473

wants to merge 1 commit into from
+38 −21

Conversation

CongMa13
Copy link
Contributor

@CongMa13 CongMa13 commented Dec 2, 2024

  • Updated target list
  • Add emulation test docs

CongMa13
CongMa13 commented Dec 2, 2024
View reviewed changes
README.md Show resolved Hide resolved
docs/api-reference/api-reference-guide.rst
@@ -268,7 +271,6 @@ layout_t
^^^^^^^^

.. doxygenenum:: rocwmma::layout_t
:members:
Copy link
Contributor Author

Choose a reason for hiding this comment

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

doxygenenum does not have members property. The output is correct after removing it.

image

docs/api-reference/api-reference-guide.rst
@@ -315,3 +317,14 @@ Sample programs

See a sample code for calling rocWMMA functions ``load_matrix_sync``, ``store_matrix_sync``, ``fill_fragment``, and ``mma_sync`` `here <https://github.com/ROCm/rocWMMA/blob/develop/samples/simple_hgemm.cpp>`_.
For more such sample programs, refer to the `Samples directory <https://github.com/ROCm/rocWMMA/tree/develop/samples>`_.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

image

docs/install/installation.rst
@@ -214,6 +218,8 @@ Below are the project options available to build rocWMMA library with or without
- Use system Google Test library instead of downloading and building it
- OFF (requires ROCWMMA_BUILD_TESTS=ON)

.. [1] The default AMDGPU_TARGET is: ``ggfx908;gfx90a;gfx942;gfx1100;gfx1101;gfx1102;gfx1200;gfx1201``
Copy link
Contributor Author

Choose a reason for hiding this comment

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

image

@CongMa13 CongMa13 marked this pull request as ready for review December 2, 2024 22:51
@CongMa13 CongMa13 requested a review from a team as a code owner December 2, 2024 22:51
@CongMa13 CongMa13 added ci:docs-only Skip most non-doc CI on this PR documentation Improvements or additions to documentation labels Dec 2, 2024
@CongMa13
Updated docs
65bde58 
- Updated target list
- Add emulation test docs
amd-jnovotny
amd-jnovotny approved these changes Dec 3, 2024
View reviewed changes
Copy link
Contributor

@amd-jnovotny amd-jnovotny left a comment

Choose a reason for hiding this comment

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

Docs changes look good overall: one question and one editorial suggestion.

docs/api-reference/api-reference-guide.rst Show resolved Hide resolved
docs/api-reference/api-reference-guide.rst

The emulation test is a smaller test suite specifically designed for emulators. It comprises a selection of test cases from the full ROCWMM test set, allowing for significantly faster execution on emulated platforms. Despite its concise nature, the emulation test supports ``smoke``, ``regression``, and ``extended`` modes.

For example, run a smoke test.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
For example, run a smoke test.
For example, the following command runs the smoke test.

cgmillette
cgmillette reviewed Dec 3, 2024
View reviewed changes
docs/api-reference/api-reference-guide.rst
Emulation tests
---------------

The emulation test is a smaller test suite specifically designed for emulators. It comprises a selection of test cases from the full ROCWMM test set, allowing for significantly faster execution on emulated platforms. Despite its concise nature, the emulation test supports ``smoke``, ``regression``, and ``extended`` modes.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The emulation test is a smaller test suite specifically designed for emulators. It comprises a selection of test cases from the full ROCWMM test set, allowing for significantly faster execution on emulated platforms. Despite its concise nature, the emulation test supports ``smoke``, ``regression``, and ``extended`` modes.
The emulation test is a smaller test suite specifically designed for emulators. It comprises a selection of test cases from the full rocWMMA test set, allowing for significantly faster execution on emulated platforms. Despite its concise nature, the emulation test supports ``smoke``, ``regression``, and ``extended`` modes.

@CongMa13 CongMa13 changed the base branch from staging to develop December 3, 2024 21:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cgmillette cgmillette cgmillette left review comments

@amd-jnovotny amd-jnovotny amd-jnovotny approved these changes

Assignees
No one assigned
Labels
ci:docs-only Skip most non-doc CI on this PR documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@CongMa13 @cgmillette @amd-jnovotny