Skip to content

docs: fix the README link to the perf.sh file #1501

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

Merged
merged 1 commit into from
Jun 12, 2025
Merged

Conversation

richardhuo-nv
Copy link
Contributor

@richardhuo-nv richardhuo-nv commented Jun 12, 2025

Overview:

fix the broken README link to the perf.sh file, since the file has been moved to a different place

Details:

Where should the reviewer start?

Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)

  • closes GitHub issue: #xxx

Summary by CodeRabbit

  • Documentation
    • Corrected the script path for the benchmarking utility in the documentation to ensure accurate references in the usage instructions.

Copy link

copy-pr-bot bot commented Jun 12, 2025

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

Copy link
Contributor

coderabbitai bot commented Jun 12, 2025

Walkthrough

This change updates documentation in two README files to correct the file paths referencing the benchmarking script perf.sh. The paths were modified to reflect the script's new location after a directory restructuring, ensuring that documentation points to the correct script locations. No functional code or interface changes were made.

Changes

File(s) Change Summary
examples/llm/benchmarks/README.md Updated path to perf.sh script in documentation.
examples/tensorrt_llm/README.md Corrected relative path to perf.sh in documentation.

Possibly related PRs

Poem

🐇
I hopped through docs with nimble feet,
Fixing paths so scripts you’ll meet.
From folders deep, to top they go,
Now benchmarks run without a woe.
A simple change, but neat and clear—
Your scripts are found, so never fear!


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0e7d4d8 and 5b268d5.

📒 Files selected for processing (2)
  • examples/llm/benchmarks/README.md (1 hunks)
  • examples/tensorrt_llm/README.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
examples/llm/benchmarks/README.md

[uncategorized] ~252-~252: Possible missing article found.
Context: ...ovide this information to the script in form of command line arguments. The benchmar...

(AI_HYDRA_LEO_MISSING_THE)


[style] ~252-~252: This phrase is redundant. Consider writing “various” or “different”.
Context: ...l to collect the performance numbers at various different request concurrencies. The perf.sh scri...

(VARIOUS_DIFFERENT)


[style] ~252-~252: This phrase is redundant. Consider writing “various” or “different”.
Context: ...n multiple times to collect numbers for various different deployments. Each script execution will...

(VARIOUS_DIFFERENT)

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Build and Test - vllm
🔇 Additional comments (2)
examples/llm/benchmarks/README.md (1)

104-104: Corrected perf.sh invocation path
The benchmarking command now points to /workspace/benchmarks/llm/perf.sh, matching the script’s new location after the directory restructuring.

examples/tensorrt_llm/README.md (1)

289-289: Fixed relative link to perf.sh
The link now uses ../../benchmarks/llm/perf.sh, accurately referencing the benchmarking script from this README’s location.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@richardhuo-nv richardhuo-nv merged commit 0bba09a into main Jun 12, 2025
9 checks passed
@richardhuo-nv richardhuo-nv deleted the rihuo/fix_link branch June 12, 2025 23:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants