Skip to content

Conversation

Jintao-Huang
Copy link
Collaborator

No description provided.

Copy link
Contributor

Summary of Changes

Hello @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 liger_kernel feature by adding a specific clarification regarding its current compatibility. The update informs users that the liger_kernel is presently limited to causal_lm task types, ensuring that developers have accurate information when configuring their training setups and avoiding potential issues with unsupported task types.

Highlights

  • Documentation Update: Updated both Chinese and English documentation for the liger_kernel parameter.
  • Liger Kernel Limitation Clarification: Added a crucial note indicating that liger_kernel currently only supports task_type='causal_lm'.
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

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.

Copy link
Contributor

Choose a reason for hiding this comment

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

medium

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'`.
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

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.

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