-
Notifications
You must be signed in to change notification settings - Fork 900
[WIP] refactor template #6085
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.
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
base: main
Are you sure you want to change the base?
[WIP] refactor template #6085
Conversation
Summary of ChangesHello @Jintao-Huang, 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 refines the documentation for the Highlights
Using Gemini Code AssistThe 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
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 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
|
There was a problem hiding this 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 for the use_liger_kernel
argument, clarifying that it is only supported for task_type='causal_lm'
. This is a helpful addition for users. To improve robustness, I've suggested adding a runtime check to enforce this constraint, which will prevent potential errors from misconfiguration. On a minor note, the pull request title [WIP] refactor template
doesn't seem to accurately reflect the changes, which are focused on documentation. Consider updating it to something more descriptive like docs: Add limitation for use_liger_kernel
.
docs/source/Instruction/命令行参数.md
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This documentation update is helpful. To make the implementation more robust and prevent misuse, consider adding a check in the argument parsing logic to enforce this constraint. For example, in swift/llm/argument/train_args.py
, within the TrainArguments.__post_init__
method, you could add:
if getattr(self, 'use_liger_kernel', False) and self.task_type != 'causal_lm':
raise ValueError("`use_liger_kernel` only supports `task_type='causal_lm'`.")
This would provide immediate feedback to users who try to use liger_kernel
with an unsupported task type.
- 🔥neftune_noise_alpha: Noise magnitude for NEFTune. Default is 0. Common values: 5, 10, 15. | ||
- 🔥use_liger_kernel: Whether to enable the [Liger](https://github.com/linkedin/Liger-Kernel) kernel to accelerate training and reduce GPU memory consumption. Defaults to False. Example shell script can be found [here](https://github.com/modelscope/ms-swift/blob/main/examples/train/liger). | ||
- Note: Liger kernel does not support `device_map`. Use DDP or DeepSpeed for multi-GPU training. | ||
- Note: Liger kernel does not support `device_map`. Use DDP or DeepSpeed for multi-GPU training. Currently, liger_kernel only supports `task_type='causal_lm'`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This documentation update is helpful. To make the implementation more robust and prevent misuse, consider adding a check in the argument parsing logic to enforce this constraint. For example, in swift/llm/argument/train_args.py
, within the TrainArguments.__post_init__
method, you could add:
if getattr(self, 'use_liger_kernel', False) and self.task_type != 'causal_lm':
raise ValueError("`use_liger_kernel` only supports `task_type='causal_lm'`.")
This would provide immediate feedback to users who try to use liger_kernel
with an unsupported task type.
No description provided.