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

Open
wants to merge 7 commits into
base: docs/develop
Choose a base branch
from
Open

Update faq #3596

wants to merge 7 commits into from

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
@@ -5,6 +5,9 @@ defaults:
maxdepth: 6
root: index
subtrees:
- entries:
- file: faq
title: Frequently asked questions
Copy link
Contributor

Choose a reason for hiding this comment

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

Please put this to the bottom.

docs/faq.rst Outdated
------------------

HIP-Clang is a Clang/LLVM based compiler to compile HIP programs for AMD
platforms. It's executable is ``amdclang++``.
Copy link
Contributor

Choose a reason for hiding this comment

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

At windows, they just call it clang++. Should we mention here?

Copy link

Choose a reason for hiding this comment

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

Done

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

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

* HIP provides device-level control over memory allocation and placement.
* HIP offers an offline compilation model.

How does porting CUDA to HIP compare to porting CUDA to OpenCL?
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.

Added a link


Yes. Beware, that you still need a compatible GPU to actually run the compiled code.

HIP detected my platform (``amd`` vs ``nvidia``) 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.

Copy link

Choose a reason for hiding this comment

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

Done

@MKKnorr MKKnorr force-pushed the update-faq branch 2 times, most recently from 49a908d to 958ca19 Compare October 1, 2024 14:59
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.

4 participants