Skip to content

[docs] update readme#82

Merged
Jintao-Huang merged 1 commit into
modelscope:mainfrom
Jintao-Huang:update_readme_0515_2
May 15, 2026
Merged

[docs] update readme#82
Jintao-Huang merged 1 commit into
modelscope:mainfrom
Jintao-Huang:update_readme_0515_2

Conversation

@Jintao-Huang
Copy link
Copy Markdown
Collaborator

No description provided.

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates the documentation in README.md and README_zh.md to mark apex and flash-attn as optional dependencies in the recommended runtime environment tables. The reviewer suggested improving the visual alignment and padding of these table rows to ensure consistency and readability across both the English and Chinese versions of the documentation.

Comment thread README.md
| 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

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 |

Comment thread README.md
| 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

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 |

Comment thread README_zh.md
| 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

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 | 可选 |

Comment thread README_zh.md
| 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

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 | 可选 |

@Jintao-Huang Jintao-Huang merged commit 5549cff into modelscope:main May 15, 2026
1 check passed
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.

1 participant