Skip to content

[docs] update readme #82

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.

Sign up for GitHub

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
Jintao-Huang merged 1 commit into from
May 15, 2026
+4 −4
Merged

[docs] update readme #82

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,9 +109,9 @@ Recommended Runtime Environment:
| cuda | | cuda12.8/13.0 | |
| torch | >=2.0 | 2.8.0/2.11.0 | |
| transformer-engine | >=2.3 | 2.14.1 | |
| apex | | 0.1 | |
| apex | | 0.1 | Optional |
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot May 15, 2026

Choose a reason for hiding this comment

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

medium

The table row for apex is poorly aligned compared to the surrounding rows. Standardizing the column widths to match the table header and separator improves the readability of the document in raw text format.

Suggested change
| apex | | 0.1 | Optional |
| apex | | 0.1 | Optional |

| megatron-core | >=0.15,<0.18 | 0.17.0 | |
| flash-attn | | 2.8.3/3.0.0b1 | |
| flash-attn | | 2.8.3/3.0.0b1 | Optional |
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot May 15, 2026

Choose a reason for hiding this comment

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

medium

The table row for flash-attn has inconsistent padding. Aligning the columns with the rest of the table makes the documentation more professional and easier to maintain.

Suggested change
| flash-attn | | 2.8.3/3.0.0b1 | Optional |
| flash-attn | | 2.8.3/3.0.0b1 | Optional |

| transformers | >=4.33 | 4.57.6/5.8.1 | |
| modelscope | >=1.23 | | |
| peft | >=0.11,<0.20 | | LoRA |
Expand Down
4 changes: 2 additions & 2 deletions README_zh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,9 +107,9 @@ uv pip install -e . --torch-backend=auto
| cuda | | cuda12.8/13.0 | |
| torch | >=2.0 | 2.8.0/2.11.0 | |
| transformer-engine | >=2.3 | 2.14.1 | |
| apex | | 0.1 | |
| apex | | 0.1 | 可选 |
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot May 15, 2026

Choose a reason for hiding this comment

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

medium

The alignment for the apex row is inconsistent with the rest of the table. Standardizing the column widths improves the visual structure and maintainability of the document.

Suggested change
| apex | | 0.1 | 可选 |
| apex | | 0.1 | 可选 |

| megatron-core | >=0.15,<0.18 | 0.17.0 | |
| flash-attn | | 2.8.3/3.0.0b1 | |
| flash-attn | | 2.8.3/3.0.0b1 | 可选 |
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot May 15, 2026

Choose a reason for hiding this comment

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

medium

The flash-attn row is misaligned and contains excessive padding in the 'Notes' column. Suggesting a cleaner, standardized format.

Suggested change
| flash-attn | | 2.8.3/3.0.0b1 | 可选 |
| flash-attn | | 2.8.3/3.0.0b1 | 可选 |

| transformers | >=4.33 | 4.57.6/5.8.1 | |
| modelscope | >=1.23 | | |
| peft | >=0.11,<0.20 | | LoRA |
Expand Down
Loading