[mcore_bridge] update docs

[Jintao-Huang]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello @Jintao-Huang, I'm Gemini Code Assist¹! 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 primarily enhances the Mcore-Bridge documentation by providing practical, runnable code examples for managing model weights. It covers the full lifecycle of loading, exporting, and saving weights for both standard models and those fine-tuned with LoRA, making it easier for users to interact with Megatron-SWIFT models. Additionally, it includes minor internal code refactorings to improve consistency in accessing model metadata.

Highlights

• Documentation Update: New code examples have been added to the Mcore-Bridge documentation in both Chinese and English, illustrating how to load, export, and save model weights.
• Weight Management Examples: The updated documentation now includes specific Python and shell script examples for handling both base model weights and LoRA (Low-Rank Adaptation) weights.
• Code Consistency Refinement: Minor code adjustments were made across several files to consistently use args.megatron_model_meta instead of args.model_meta for accessing model metadata.
• Module Exports: The swift.megatron package's __init__.py has been updated to explicitly import and expose convert_hf_config and MegatronArguments.

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. ↩

[gemini-code-assist]

Code Review

This pull request updates the documentation for mcore_bridge, adding examples for full and LoRA weight management. The changes also include minor refactoring in the Python codebase to align with the new documentation. The documentation is mostly clear and helpful, but I've pointed out a potentially confusing line in the LoRA code example in both the Chinese and English documents. The code changes are correct and consistent.

[gemini-code-assist]

This commented-out line # bridge.load_weights(mg_model, 'adapter-path', is_peft_format=True) might be confusing for users. This example primarily demonstrates how to save LoRA weights, not how to load them. If this line is intended to show how to load LoRA weights, it would be better to move it to a separate example or add a comment explaining its purpose. If it's not relevant to this example, removing it would improve clarity.

[gemini-code-assist]

This commented-out line # bridge.load_weights(mg_model, 'adapter-path', is_peft_format=True) could be confusing for users. The example's main purpose is to demonstrate how to save LoRA weights, not load them. If this line is meant to show how to load LoRA weights, consider moving it to a separate, dedicated example or adding an explanatory comment. If it's not relevant to this example, it would be clearer to remove it.