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

Update faq #3596

Merged
merged 1 commit into from
Oct 30, 2024
Merged

Update faq #3596

merged 1 commit into from
Oct 30, 2024

Conversation

parbenc
Copy link

@parbenc parbenc commented Sep 10, 2024

No description provided.

@parbenc parbenc changed the base branch from amd-staging to docs/develop September 10, 2024 14:05
@parbenc parbenc changed the title WIP - Update faq Update faq Sep 11, 2024
@parbenc parbenc self-assigned this Sep 11, 2024
@parbenc parbenc marked this pull request as ready for review September 11, 2024 13:31
docs/faq.rst Outdated Show resolved Hide resolved
docs/faq.rst Outdated Show resolved Hide resolved
docs/faq.rst Outdated Show resolved Hide resolved
docs/faq.rst Outdated Show resolved Hide resolved
docs/faq.rst Outdated Show resolved Hide resolved
docs/faq.rst Outdated Show resolved Hide resolved
docs/faq.rst Outdated Show resolved Hide resolved
docs/faq.rst Outdated Show resolved Hide resolved
docs/sphinx/_toc.yml.in Outdated Show resolved Hide resolved
docs/faq.rst Outdated Show resolved Hide resolved
This means you can compile host code with the compiler of your choice and link the
generated host object code with device code.

Can HIP applications be compiled with a C compiler?
Copy link
Contributor

Choose a reason for hiding this comment

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

Copy link

Choose a reason for hiding this comment

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

I would have to rebase on top of that. Let's wait until either is merged in and add it to the other one

docs/faq.rst Outdated
Miscellaneous
=============

How to create a guard for code that is specific to the host or the GPU?
Copy link
Contributor

Choose a reason for hiding this comment

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

This should be in the porting guide and we should link here.

Copy link

Choose a reason for hiding this comment

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

I think this does not (only) belong to the porting guide, this is also relevant for other users. So either the programming guide, the compilers. I'd vote for the compilers or somewhere where we explain the compilation process.

Compiler related questions
==========================

How to use HIP-Clang to build HIP programs?
Copy link
Contributor

Choose a reason for hiding this comment

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

Please link this tutorial: https://rocm.docs.amd.com/projects/HIP/en/latest/tutorial/saxpy.html#compiling-on-the-command-line

It is written to represent the compiler usage on different OS or platform.

Copy link

Choose a reason for hiding this comment

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

I was thinking of whether to even keep this question in the FAQ. That tutorial is a bit overkill for this question. Maybe something similar can also be added to the HIP compilers page of #3622 and we could link to that

docs/faq.rst Show resolved Hide resolved
docs/faq.rst Outdated Show resolved Hide resolved
@MKKnorr MKKnorr force-pushed the update-faq branch 4 times, most recently from bc6184e to 50931d5 Compare October 8, 2024 12:16
docs/faq.rst Outdated Show resolved Hide resolved
docs/faq.rst Outdated Show resolved Hide resolved
docs/faq.rst Outdated Show resolved Hide resolved
docs/faq.rst Outdated Show resolved Hide resolved
docs/faq.rst Outdated Show resolved Hide resolved
docs/faq.rst Outdated Show resolved Hide resolved
docs/faq.rst Show resolved Hide resolved
docs/faq.rst Outdated Show resolved Hide resolved
docs/faq.rst Outdated Show resolved Hide resolved
docs/faq.rst Outdated Show resolved Hide resolved
docs/faq.rst Outdated Show resolved Hide resolved
docs/faq.rst Outdated Show resolved Hide resolved
docs/faq.rst Outdated
The supported operating systems are listed in the
:doc:`rocm:compatibility/compatibility-matrix`.

CUDA and OpenCL
Copy link
Contributor

Choose a reason for hiding this comment

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

This tittle should be removed.

Copy link

Choose a reason for hiding this comment

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

I changed it. Removing it would expand the dynamic table of contents on the right side too much, and it's also not directly related to "HIP support"

Copy link
Contributor

Choose a reason for hiding this comment

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

Sure

Is HIP a drop-in replacement for CUDA?
--------------------------------------

The `HIPIFY <https://github.com/ROCm/HIPIFY>`_ tools can automatically convert
Copy link
Contributor

Choose a reason for hiding this comment

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

HIP applications can be used on both AMD platform and non-AMD platform, like NVIDIA, using the conversion tool HIPIFY.

Copy link

Choose a reason for hiding this comment

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

This logic is backwards - CUDA code can be ported to the (portable) HIP code using HIPIFY. Also the question itself already implies, that the code can also run on NVIDIA platforms.

docs/faq.rst Outdated

HIP detected my platform incorrectly. What should I do?
-------------------------------------------------------

Copy link
Contributor

Choose a reason for hiding this comment

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

For this question, I think the original explanation is better. User needs to know how to differentiate the platform, not how to port the code.

Copy link

Choose a reason for hiding this comment

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

The goal for this PR is to reduce the amount of content duplication, so where possible it is preferred to link to existing documentation. I found a better explanation in the hipcc documentation

docs/faq.rst Outdated

Miscellaneous
=============

Copy link
Contributor

Choose a reason for hiding this comment

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

I think a question need to add "Can I develop applications with HIP APIs on Windows the same on Linux?"

Copy link

Choose a reason for hiding this comment

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

Is that really a frequently asked question? What would the answer to that be?

@jujiang-del
Copy link
Contributor

FAQ looks good to me.

@MKKnorr MKKnorr merged commit d688673 into docs/develop Oct 30, 2024
4 checks passed
@jamesxu2
Copy link

jamesxu2 commented Nov 8, 2024

@parbenc @MKKnorr

Some unintended consequences of the .md to .rst change that I just noticed are live:

Single backticks produce italics, instead of unformatted blocks. Here is an example - HIP_PLATFORM is now rendered as HIP_PLATFORM (ref)

Also, these nested bullet points got messed up and rendered as a single line

HIP provides * pointers and host-side pointer arithmetic. * device-level control over memory allocation and placement. * an offline compilation model.

(ref)

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.

6 participants