Conversation
Summary of ChangesHello @yingdachen, 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 primarily focuses on updating and clarifying the project's documentation, particularly regarding the new 'Training as a Service' offering on ModelScope. It streamlines installation guides, provides more precise information on model support, and refines code examples for better usability. The changes aim to enhance the user experience by offering clearer instructions and up-to-date information for both English and Chinese audiences. Highlights
🧠 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
Activity
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
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates documentation, primarily in the README.md file, to provide new information about the Training as a Service offering on ModelScope. The changes include updating the changelog, clarifying service access, and refactoring code examples.
While the updates are helpful, I've identified a few issues:
- A likely bug in a Python code example in
README.mdwhere a wrong variable is passed to a function. - Several markdown formatting errors in
README.mdthat could affect readability and rendering. - A link in
README.mdpoints to an English documentation file that is now outdated and inconsistent with the changes in this PR. - The Chinese documentation (
README_ZH.md) has not been fully synchronized with the English version, leading to inconsistencies.
Please see my detailed comments for suggestions on how to address these points.
|
|
||
| # Initialize tinker client | ||
| service_client = init_tinker_compat_client(base_url='http://www.modelscope.cn/twinkle', api_key=os.environ.get('MODELSCOPE_SDK_TOKEN')) | ||
| service_client = init_tinker_compat_client(base_model, api_key) |
There was a problem hiding this comment.
There seems to be a bug in this example. The init_tinker_compat_client function is called with base_model as the first argument, but it likely expects base_url. The base_url variable is defined on line 207 but never used. This will probably cause the example code to fail. Please verify the function signature and pass base_url instead.
| service_client = init_tinker_compat_client(base_model, api_key) | |
| service_client = init_tinker_compat_client(base_url, api_key) |
| We are rolling out training service built atop Twinkle✨ on ModelScope. It is currently in _Beta_. You may | ||
| sign up for free access by joining the [Twinkle-Explorers](https://modelscope.cn/organization/twinkle-explorers) organization, and | ||
| train via API endpoint `base_url=https://www.modelscope.cn/twinkle`. For more details, please refer to | ||
| our [documentation](docs/source_en/Usage%20Guide/ModelScope-Official-Resources.md). |
There was a problem hiding this comment.
The linked English documentation file (docs/source_en/Usage Guide/ModelScope-Official-Resources.md) appears to be outdated. It still contains the old instructions, which are inconsistent with the new process described in this README and the updated Chinese documentation (docs/source_zh/使用指引/训练服务.md). To avoid confusion for English-speaking users, please consider updating this document and renaming it (e.g., to Training-Service.md) to match the changes made to the Chinese documentation.
| | Model Type | Model ID on [ModelScope](https://modelscope.cn) | Requires | Megatron Support | HF Model ID | | ||
| | ------------------- |--------------------------------------------------------------------------------------------------------------------------| -------------------- | ---------------- | ---------------------------------------------------------------------------------------------------------- | |
There was a problem hiding this comment.
The markdown table formatting appears to be broken. The separator for the second column is not aligned and lacks spacing, which can cause rendering issues on some platforms. Please adjust the separator line to align with the headers for better readability and consistent rendering.
| | Model Type | Model ID on [ModelScope](https://modelscope.cn) | Requires | Megatron Support | HF Model ID | | |
| | ------------------- |--------------------------------------------------------------------------------------------------------------------------| -------------------- | ---------------- | ---------------------------------------------------------------------------------------------------------- | | |
| | Model Type | Model ID on [ModelScope](https://modelscope.cn) | Requires | Megatron Support | HF Model ID | | |
| | ------------------- | ------------------------------------------------------------------------------------------------------------------------ | -------------------- | ---------------- | ---------------------------------------------------------------------------------------------------------- | |
2 participants
No description provided.