Fix docs and add new start scripts

[tastelikefeet]

PR type

• Bug Fix
• New Feature
• Document Updates
• More Models or Datasets Support

PR information

Write the detail information belongs to this PR.

Experiment results

Paste your experiment result here(if needed).

[gemini-code-assist]

Summary of Changes

Hello, 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 streamlines the client setup experience by introducing dedicated installation scripts for Windows and Unix-like systems. It also enriches the project's documentation with a comprehensive overview of Twinkle's training approach and practical examples for utilizing the sampling API within the training service. Underlying dependencies were updated to accommodate these new features and improvements.

Highlights

• New Client Installation Scripts: Two new scripts, INSTALL_CLIENT.ps1 for Windows PowerShell and INSTALL_CLIENT.sh for Mac/Linux Bash, have been added to automate the setup of a Python environment for the Twinkle client. These scripts handle Conda installation (if not present), environment creation with Python 3.11, and installation of twinkle-kit with tinker dependencies.
• Enhanced Documentation: The documentation has been significantly updated across multiple files. This includes adding instructions for the new client installation scripts in README.md and README_ZH.md. The Quick-Start.md (English and Chinese versions) now features a new section detailing Twinkle's model training philosophy and capabilities, along with a mention of the sampling API. The Train-as-a-Service.md (English and Chinese versions) has updated training examples, reducing epochs and demonstrating checkpoint saving and sampling client usage.
• Dependency Updates: The poetry.lock and pyproject.toml files were updated to include new dependencies such as oss2, aliyun-python-sdk-core, aliyun-python-sdk-kms, crcmod, and pycryptodome, supporting the new functionalities and ensuring proper environment setup.

🧠 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

• INSTALL_CLIENT.ps1
  • Added a new PowerShell script for automated Twinkle client installation on Windows.
• INSTALL_CLIENT.sh
  • Added a new Bash script for automated Twinkle client installation on Mac/Linux.
• README.md
  • Updated with instructions for using the new client installation scripts.
• README_ZH.md
  • Updated with Chinese instructions for using the new client installation scripts.
• docs/source_en/Usage Guide/Quick-Start.md
  • Expanded content with a new section on Twinkle's training philosophy and a note on the sampling API.
• docs/source_en/Usage Guide/Train-as-a-Service.md
  • Updated training example code to reduce epochs and demonstrate sampling client usage.
  • Added code for saving checkpoints and printing training metrics.
• docs/source_zh/使用指引/快速开始.md
  • Expanded content with a new section on Twinkle's training philosophy and a note on the sampling API.
• docs/source_zh/使用指引/训练服务.md
  • Updated training example code to reduce epochs and demonstrate sampling client usage.
  • Added code for saving checkpoints and printing training metrics.
• poetry.lock
  • Updated dependencies to include aliyun-python-sdk-core, aliyun-python-sdk-kms, crcmod, oss2, and pycryptodome.
• pyproject.toml
  • Added oss2 as a core dependency.

Activity

• No explicit human activity (comments, reviews) was recorded for this pull request.

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 introduces one-click installation scripts for both Windows (PowerShell) and Unix-like systems (Bash) to set up the twinkle-client environment, along with documentation updates and dependency additions. However, two security vulnerabilities were identified: a potential privilege escalation in the PowerShell script due to insecure search paths in C:\ProgramData, and insecure temporary file usage in the Bash script that could lead to symlink attacks or race conditions. Addressing these security concerns is critical. Additionally, there are suggestions to improve the robustness of the PowerShell script, the readability of the Bash script, and a minor clarification is needed in the English documentation.