Skip to content

feat(doc): update docker tag examples#2851

Merged
winglian merged 2 commits into
mainfrom
feat/doc-128
Jul 2, 2025
Merged

feat(doc): update docker tag examples#2851
winglian merged 2 commits into
mainfrom
feat/doc-128

Conversation

@NanoCode012
Copy link
Copy Markdown
Collaborator

@NanoCode012 NanoCode012 commented Jul 1, 2025

Description

We encouraged users to use cu128 for Blackwell but didn't provide example tags. This PR adds that.

Motivation and Context

How has this been tested?

Screenshots (if appropriate)

Types of changes

Social Handles (Optional)

Summary by CodeRabbit

  • Documentation
    • Updated Docker documentation to include new and alternative image tags for base and main images.
    • Revised tagged release version information to reflect the latest release.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jul 1, 2025

"""

Walkthrough

The documentation for Docker image tags was updated to include new and alternative tags for both base and main images, reflecting the availability of updated versions. The tagged release version reference was also changed from 0.9.2 to 0.10.1.

Changes

File(s) Change Summary
docs/docker.qmd Updated Docker image tags for base and main images; revised tagged release version from 0.9.2 to 0.10.1.

Possibly related PRs

Suggested labels

documentation

Suggested reviewers

  • SalmanMohammadi
  • winglian

Poem

🐇
Docker tags hop, a version parade,
New numbers gleam where old once stayed.
Images fresh as morning dew,
Docs now show what's latest and true.
Rabbits rejoice in this tidy array—
Pull the right tag, and code away!

"""


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3f6c3a7 and 7d2d969.

📒 Files selected for processing (1)
  • docs/docker.qmd (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/docker.qmd
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: preview

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 docstrings to generate docstrings for this 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.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (3)
docs/docker.qmd (3)

11-13: Capitalize “PyTorch” for brand correctness

Minor nit: “PyTorch” is the canonical spelling (capital “T”).

-For Blackwell GPUs, please use the tags with Pytorch 2.7.1 and CUDA 12.8.
+For Blackwell GPUs, please use the tags with PyTorch 2.7.1 and CUDA 12.8.

33-38: Keep base-image tag examples ordered & scoped

Nice addition of the cu128 example.
To reduce visual scanning cost, consider ordering the list by CUDA version (desc) and, within that, by PyTorch version. This keeps the Blackwell-focused tag (cu128-2.7.1) clearly on top and prevents the older cu126-2.6.0 from appearing between two 2.7.1 examples.


75-79: Apply the same ordering to “main” image tags

Same comment as above: ordering the main-* examples by CUDA version first (cu128cu126cu124) and then by PyTorch version makes it easier for readers to spot the recommended tag quickly.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 35fdbce and 3f6c3a7.

📒 Files selected for processing (1)
  • docs/docker.qmd (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: preview
🔇 Additional comments (1)
docs/docker.qmd (1)

85-85: Confirm version bump consistency across docs

The tagged release example now shows 0.10.1. Please verify that all other documentation sections (e.g., CHANGELOG, README badges) and any automation referring to the previous 0.9.2 tag are updated accordingly.

@NanoCode012
Copy link
Copy Markdown
Collaborator Author

@coderabbitai , can you check where the ordering needs to be? I think it's already ordered across sections by cuda then torch.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jul 1, 2025

Tip

For best results, initiate chat on the files or code changes.

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Read the docker.qmd file to examine the Docker tag ordering
cat docs/docker.qmd

Length of output: 3393


@NanoCode012, you're absolutely correct! After examining the docs/docker.qmd file, I can confirm that the Docker tags are already properly ordered across both sections:

Current ordering pattern:

  1. Primary sort: CUDA version (descending: cu128 → cu126 → cu124)
  2. Secondary sort: PyTorch version (descending within same CUDA: 2.7.1 → 2.6.0 → 2.5.1)

Base image tags:

  • main-base-py3.11-cu128-2.7.1 (newest CUDA + newest PyTorch)
  • main-base-py3.11-cu126-2.7.1
  • main-base-py3.11-cu126-2.6.0
  • main-base-py3.11-cu124-2.6.0
  • main-base-py3.11-cu124-2.5.1

Main image tags:

  • main-py3.11-cu128-2.7.1
  • main-py3.11-cu126-2.7.1
  • main-py3.11-cu126-2.6.0
  • main-py3.11-cu124-2.6.0
  • main-py3.11-cu124-2.5.1

This ordering is logical and user-friendly, as it prioritizes the newest CUDA versions first (important for Blackwell GPU compatibility), followed by the newest PyTorch versions within each CUDA group. No reordering is needed! 👍

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jul 1, 2025

@github-actions github-actions Bot temporarily deployed to preview July 1, 2025 05:27 Inactive
@winglian winglian merged commit bf5928d into main Jul 2, 2025
3 checks passed
@winglian winglian deleted the feat/doc-128 branch July 2, 2025 12:05
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.

3 participants