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

[Docs] hint to enable use of GPU performance counters in profiling tools for multi-node distributed serving #11235

Merged
merged 2 commits into from
Dec 16, 2024

Conversation

bk-TurbaAI
Copy link
Contributor

@bk-TurbaAI bk-TurbaAI commented Dec 16, 2024

In case of multi-node distributed serving, there is a a helper script to start the cluster. However, this script understandably launches docker without administrative privileges and at times is it curtails the GPU profiling and tracing. The change in the document is to help the users know that if they want to use profiling tools (e.g. NVIDIA NSIGHT) in the docker, they can use CAP_SYS_ADMIN to the docker container by using the --cap-add option in the docker run command.

In case of multi-node distributed serving, there is a a helper [script](https://github.com/vllm-project/vllm/tree/main/examples/run_cluster.sh) to start the cluster.  However, this script understandably launches docker without administrative privileges and at times is it curtails the GPU profiling and tracing. The change in the document is to help the users know that if they want to use profiling tools (e.g. NVIDIA NSIGHT) in the docker, they can use `CAP_SYS_ADMIN` to the docker container by using the `--cap-add` option in the docker run command.
Copy link

👋 Hi! Thank you for contributing to the vLLM project.
Just a reminder: PRs would not trigger full CI run by default. Instead, it would only run fastcheck CI which starts running only a small and essential subset of CI tests to quickly catch errors. You can run other CI tests on top of those by going to your fastcheck build on Buildkite UI (linked in the PR checks section) and unblock them. If you do not have permission to unblock, ping simon-mo or khluu to add you in our Buildkite org.

Once the PR is approved and ready to go, your PR reviewer(s) can run CI to test the changes comprehensively before merging.

To run CI, PR reviewers can do one of these:

  • Add ready label to the PR
  • Enable auto-merge.

🚀

@mergify mergify bot added the documentation Improvements or additions to documentation label Dec 16, 2024
Copy link
Member

@mgoin mgoin left a comment

Choose a reason for hiding this comment

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

Thanks for the hint

docs/source/serving/distributed_serving.rst Outdated Show resolved Hide resolved
@mgoin mgoin added the ready ONLY add when PR is ready to merge/full CI is needed label Dec 16, 2024
@mgoin mgoin enabled auto-merge (squash) December 16, 2024 20:11
@mgoin mgoin merged commit 35ffa68 into vllm-project:main Dec 16, 2024
44 of 46 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation ready ONLY add when PR is ready to merge/full CI is needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants