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.

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

Driver API #3564

Merged
merged 1 commit into from
Sep 30, 2024
Merged

Driver API #3564

merged 1 commit into from
Sep 30, 2024

Conversation

matyas-streamhpc
Copy link

No description provided.

@matyas-streamhpc matyas-streamhpc self-assigned this Aug 6, 2024
@MKKnorr MKKnorr self-requested a review August 13, 2024 13:20
Copy link

@MKKnorr MKKnorr left a comment

Choose a reason for hiding this comment

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

Just a first superficial review. I think this might need some more in-depth changes

docs/how-to/hip_porting_driver_api.rst Outdated Show resolved Hide resolved
docs/how-to/hip_porting_driver_api.rst Outdated Show resolved Hide resolved
docs/how-to/hip_porting_driver_api.rst Outdated Show resolved Hide resolved
docs/how-to/hip_porting_driver_api.rst Outdated Show resolved Hide resolved
docs/how-to/hip_porting_driver_api.rst Outdated Show resolved Hide resolved
docs/how-to/hip_porting_driver_api.rst Outdated Show resolved Hide resolved
docs/how-to/hip_porting_driver_api.rst Outdated Show resolved Hide resolved
docs/how-to/hip_porting_driver_api.rst Outdated Show resolved Hide resolved
docs/how-to/hip_porting_driver_api.rst Outdated Show resolved Hide resolved
docs/how-to/hip_porting_driver_api.rst Outdated Show resolved Hide resolved
Copy link

@MKKnorr MKKnorr left a comment

Choose a reason for hiding this comment

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

I think the reference-file is not needed. A proper "understand" section instead would be better. This way a lot of the stuff in the how-to section could also be incorporated there, as it is not strictly a how-to right now

docs/how-to/hip_porting_driver_api.rst Outdated Show resolved Hide resolved
docs/how-to/hip_porting_driver_api.rst Outdated Show resolved Hide resolved
docs/how-to/hip_porting_driver_api.rst Outdated Show resolved Hide resolved
docs/how-to/hip_porting_driver_api.rst Outdated Show resolved Hide resolved
docs/how-to/hip_porting_driver_api.rst Outdated Show resolved Hide resolved
docs/how-to/hip_porting_driver_api.rst Outdated Show resolved Hide resolved
docs/how-to/hip_porting_driver_api.rst Outdated Show resolved Hide resolved
docs/how-to/hip_porting_driver_api.rst Outdated Show resolved Hide resolved
docs/how-to/hip_porting_driver_api.rst Outdated Show resolved Hide resolved
docs/reference/driver_api_reference.rst Outdated Show resolved Hide resolved
@matyas-streamhpc matyas-streamhpc force-pushed the driver-api branch 2 times, most recently from af8d215 to 5163cde Compare August 17, 2024 01:41
Copy link

@MKKnorr MKKnorr left a comment

Choose a reason for hiding this comment

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

I think a lot of the stuff that currently is in the how-to section actually belongs in the understand section. How-to should be condensed to mostly just give instructions on... well, "how to" port from the cuda driver api to the hip api. The parts explaining what the driver api is used for would better fit in the understand section.

docs/understand/driver_api.rst Outdated Show resolved Hide resolved
docs/understand/driver_api.rst Outdated Show resolved Hide resolved
docs/understand/driver_api.rst Outdated Show resolved Hide resolved
@neon60 neon60 marked this pull request as ready for review August 19, 2024 12:59
docs/how-to/hip_porting_driver_api.rst Outdated Show resolved Hide resolved
docs/how-to/hip_porting_driver_api.rst Outdated Show resolved Hide resolved
docs/how-to/hip_porting_driver_api.rst Outdated Show resolved Hide resolved
docs/how-to/hip_porting_driver_api.rst Outdated Show resolved Hide resolved
docs/how-to/hip_porting_driver_api.rst Outdated Show resolved Hide resolved
docs/how-to/hip_porting_driver_api.rst Outdated Show resolved Hide resolved
docs/how-to/hip_porting_driver_api.rst Outdated Show resolved Hide resolved
docs/how-to/hip_porting_driver_api.rst Outdated Show resolved Hide resolved
Copy link

@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.

Here is a batch of edits for you to review and process. I'll review the rest of the document today. Sorry that this task wound up being split between two reviewers.

docs/how-to/hip_porting_driver_api.rst Outdated Show resolved Hide resolved
docs/how-to/hip_porting_driver_api.rst Outdated Show resolved Hide resolved
docs/how-to/hip_porting_driver_api.rst Outdated Show resolved Hide resolved
docs/how-to/hip_porting_driver_api.rst Outdated Show resolved Hide resolved
docs/how-to/hip_porting_driver_api.rst Outdated Show resolved Hide resolved
docs/how-to/hip_porting_driver_api.rst Outdated Show resolved Hide resolved
docs/how-to/hip_porting_driver_api.rst Outdated Show resolved Hide resolved
docs/how-to/hip_porting_driver_api.rst Outdated Show resolved Hide resolved
docs/how-to/hip_porting_driver_api.rst Outdated Show resolved Hide resolved
docs/how-to/hip_porting_driver_api.rst Outdated Show resolved Hide resolved
Copy link

@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.

Here are the rest of my editorial suggestions.

docs/how-to/hip_porting_driver_api.rst Outdated Show resolved Hide resolved
docs/how-to/hip_porting_driver_api.rst Outdated Show resolved Hide resolved
docs/how-to/hip_porting_driver_api.rst Outdated Show resolved Hide resolved
docs/how-to/hip_porting_driver_api.rst Outdated Show resolved Hide resolved
docs/how-to/hip_porting_driver_api.rst Outdated Show resolved Hide resolved
docs/how-to/hip_porting_driver_api.rst Outdated Show resolved Hide resolved
docs/how-to/hip_porting_driver_api.rst Outdated Show resolved Hide resolved
docs/how-to/hip_porting_driver_api.rst Outdated Show resolved Hide resolved
.wordlist.txt Outdated Show resolved Hide resolved
docs/how-to/hip_porting_driver_api.rst Show resolved Hide resolved
@amd-jnovotny
Copy link

@matyas-streamhpc Please let me know when it's ready for review. Looks like some edits (that were in the hidden ... click to expand section) are still outstanding. No rush if you're busy.

Copy link

@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.

Overall, it looks very good now, so I'll approve. I've added a couple of minor edits and a few questions involving capitalization consistency and the use of must vs. should.

docs/how-to/hip_porting_driver_api.rst Outdated Show resolved Hide resolved
docs/how-to/hip_porting_driver_api.rst Outdated Show resolved Hide resolved
docs/how-to/hip_porting_driver_api.rst Outdated Show resolved Hide resolved
docs/how-to/hip_porting_driver_api.rst Outdated Show resolved Hide resolved
docs/how-to/hip_porting_driver_api.rst Outdated Show resolved Hide resolved
docs/how-to/hip_porting_driver_api.rst Outdated Show resolved Hide resolved
docs/how-to/hip_porting_driver_api.rst Outdated Show resolved Hide resolved
@matyas-streamhpc matyas-streamhpc force-pushed the driver-api branch 4 times, most recently from be4d00b to 147a614 Compare August 29, 2024 15:54
@yiakwy-xpu-ml-framework-team
Copy link

yiakwy-xpu-ml-framework-team commented Sep 7, 2024

Note __frcp_rn is not supported in ROCM 6.2.

Many customer codes invovles PTX inline asm. We need a table to show

  • How amd asm is different from PTX and practices in porting
  • Existing C primitives support AMD asm instruction (ISA CDNA3) and many existing tools pointing to old RDNA or GCN arch (for PC and DIY users, not datacenter users).

@jujiang-del
Copy link
Contributor

jujiang-del commented Sep 23, 2024

Do we really need a separate doc for HIP driver APIs? The content doesn't cover all as supported in
https://github.com/ROCm/HIPIFY/blob/amd-staging/docs/tables/CUDA_Driver_API_functions_supported_by_HIP.md
Some of ctx APIs are deprecated, only for porting support.
RST file for driver porting guide looks good.

@neon60
Copy link
Contributor

neon60 commented Sep 30, 2024

Do we really need a separate doc for HIP driver APIs? The content doesn't cover all as supported in https://github.com/ROCm/HIPIFY/blob/amd-staging/docs/tables/CUDA_Driver_API_functions_supported_by_HIP.md Some of ctx APIs are deprecated, only for porting support. RST file for driver porting guide looks good.

@jujiang-del Update the PR based on the comment. Removed the separate doc and kept the groups.

@neon60 neon60 merged commit e05587c into docs/develop Sep 30, 2024
4 checks passed
@neon60 neon60 deleted the driver-api branch October 2, 2024 17:00
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.

7 participants