Skip to content

[docs] update arch docs#8185

Open
Jintao-Huang wants to merge 3 commits intomodelscope:mainfrom
Jintao-Huang:update_arch_docs
Open

[docs] update arch docs#8185
Jintao-Huang wants to merge 3 commits intomodelscope:mainfrom
Jintao-Huang:update_arch_docs

Conversation

@Jintao-Huang
Copy link
Collaborator

No description provided.

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the project's documentation by introducing a detailed guide to the ms-swift 4.0 modular architecture. It centralizes information previously scattered across multiple files, making it easier for developers to understand and extend the framework's core components. The update also ensures consistency across all documentation by refreshing internal links and expanding coverage for newer model parameters.

Highlights

  • New Architecture Documentation: A new comprehensive documentation file, Architecture.md, has been added to detail the modular design of ms-swift 4.0, covering various customizable components like Agent Templates, Callbacks, Loss, Loss Scale, Metrics, Optimizers, ORM, PRM, and Tuner Plugins.
  • Documentation Consolidation and Removal: The previous Pluginization.md document has been removed, and its relevant content has been integrated into the new Architecture.md for better organization and clarity.
  • Documentation Link Updates: Existing documentation files have been updated to reflect the new architecture document and correct outdated links, ensuring all references point to the most current and accurate information.
  • Model Parameter Updates: References to model-specific parameters in Qwen3-VL-Best-Practice.md and Command-line-parameters.md have been updated to explicitly include qwen3_5 alongside qwen3_vl.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • docs/source/BestPractices/Qwen3-VL-Best-Practice.md
    • Updated reference for model parameters to include qwen3_5.
  • docs/source/Customization/Architecture.md
    • Added new documentation detailing the modular architecture of ms-swift 4.0, covering Agent Templates, Callbacks, Loss, Loss Scale, Metrics, Optimizers, ORM, PRM, and Tuner Plugins, along with other directory structures.
  • docs/source/Customization/Pluginization.md
    • Removed the old pluginization documentation.
  • docs/source/Instruction/Agent-support.md
    • Updated link for loss_scale plugin design to point to the new architecture document.
  • docs/source/Instruction/Command-line-parameters.md
    • Updated the heading for qwen3_vl parameters to also include qwen3_5.
  • docs/source/Instruction/GRPO/DeveloperGuide/multi_turn.md
    • Updated link for custom loss_scale documentation to point to the new architecture document.
  • docs/source/index.rst
    • Updated the table of contents to include Architecture.md and remove Pluginization.md.
  • docs/source_en/BestPractices/Qwen3-VL-Best-Practice.md
    • Updated English reference for model parameters to include qwen3_5.
  • docs/source_en/Instruction/Command-line-parameters.md
    • Updated English command-line parameters documentation to include qwen3_5.
  • docs/source_en/index.rst
    • Updated English table of contents for customization documents.
Activity
  • No specific activity (comments, reviews, progress) has been recorded for this pull request yet.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@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

本次 PR 主要更新了架构文档,用新的 Architecture.md 替换了旧的 Pluginization.md,并相应地更新了各处链接。整体上改进了文档结构。

我发现了一些小问题:

  1. 在新的 Architecture.md 文件中,有一个 Markdown 链接因换行而失效。
  2. 在英文文档的目录 (docs/source_en/index.rst) 中,添加了一个指向中文架构文档的链接,这可能会导致链接失效或将用户引导至错误的语言版本。

我已经就这些问题提出了具体的修改建议。修复后,文档的可用性会更好。

Comment on lines +98 to +99
此外你也可以使用[json配置文件]
(https://github.com/modelscope/ms-swift/tree/main/swift/loss_scale/config),继承内置的ConfigLossScale类,来自定义loss_scale。目前支持两种配置方式:字符串精确匹配和正则表达式匹配。你可以参考[Agent支持文档](../Instruction/Agent-support.md#loss_scale的使用)的内容进行理解。
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

这里的 Markdown 链接格式不正确,导致链接失效。[json配置文件](https://...) 之间不应该有换行符。请将它们合并到同一行以修复链接。

Suggested change
此外你也可以使用[json配置文件]
(https://github.com/modelscope/ms-swift/tree/main/swift/loss_scale/config),继承内置的ConfigLossScale类,来自定义loss_scale。目前支持两种配置方式:字符串精确匹配和正则表达式匹配。你可以参考[Agent支持文档](../Instruction/Agent-support.md#loss_scale的使用)的内容进行理解。
此外你也可以使用[json配置文件](https://github.com/modelscope/ms-swift/tree/main/swift/loss_scale/config),继承内置的ConfigLossScale类,来自定义loss_scale。目前支持两种配置方式:字符串精确匹配和正则表达式匹配。你可以参考[Agent支持文档](../Instruction/Agent-support.md#loss_scale的使用)的内容进行理解。

:maxdepth: 2
:caption: Customization

Customization/Architecture.md
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

此更改在英文文档的目录中添加了 Customization/Architecture.md,但该文件是中文的,并且不存在对应的英文版本 docs/source_en/Customization/Architecture.md。这会导致一个断开的链接或将用户引导至中文文档。请为 Architecture.md 添加英文翻译版本,或从英文目录中移除此链接。

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