Skip to content

Commit ca94db1

Browse files
committed
fix docs
1 parent 547555e commit ca94db1

File tree

7 files changed

+129
-139
lines changed

7 files changed

+129
-139
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ pip install -e .
8181

8282
We are rolling out training service built atop Twinkle✨ on ModelScope. It is currently in _Beta_. You may
8383
sign up for free access by joining the [Twinkle-Explorers](https://modelscope.cn/organization/twinkle-explorers) organization, and
84-
train via API endpoint `base_url=https://www.modelscope.cn/twinkle`. For more details, please refer to
84+
train via API endpoint `base_url=https://www.modelscope.cn/twinkle`. For more details, please refer to
8585
our [documentation](docs/source_en/Usage%20Guide/ModelScope-Official-Resources.md).
8686

8787
## Supported Hardware
@@ -96,9 +96,9 @@ our [documentation](docs/source_en/Usage%20Guide/ModelScope-Official-Resources.m
9696
## Supported Models
9797

9898
We will be adding support for more models as new models are released. The following table lists current models
99-
supported on Twinkle✨ framework.
99+
supported on Twinkle✨ framework.
100100

101-
>[!Note]
101+
>[!Note]
102102
> For serverless training service accessed via `base_url=https://www.modelscope.cn/twinkle`, it currently supports
103103
> one training base at a time, and currently it is [Qwen3-30B-A3B-Instruct-2507](https://modelscope.cn/models/Qwen/Qwen3-30B-A3B-Instruct-2507).
104104
@@ -203,7 +203,7 @@ from twinkle.dataset import Dataset, DatasetMeta
203203
from twinkle.preprocessor import SelfCognitionProcessor
204204
from twinkle.server.tinker.common import input_feature_to_datum
205205

206-
base_model = 'ms://Qwen/Qwen2.5-0.5B-Instruct'
206+
base_model = 'ms://Qwen/Qwen3-30B-A3B-Instruct-2507'
207207
base_url='http://www.modelscope.cn/twinkle'
208208
api_key=os.environ.get('MODELSCOPE_TOKEN')
209209

README_ZH.md

Lines changed: 89 additions & 88 deletions
Large diffs are not rendered by default.

docs/source_en/Usage Guide/ModelScope-Official-Resources.md

Lines changed: 0 additions & 40 deletions
This file was deleted.

docs/source_en/Usage Guide/Quick-Start.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,11 @@
1-
<div align="center">
2-
31
## ✨ What is Twinkle?
42

53
A component library for large model training. Based on PyTorch, simpler, more flexible, production-ready.
64

7-
<p align="center">
85
🧩 <b>Loosely Coupled Architecture</b> · Standardized Interfaces<br>
96
🚀 <b>Multiple Runtime Modes</b> · torchrun / Ray / HTTP<br>
107
🔌 <b>Multi-Framework Compatible</b> · Transformers / Megatron<br>
118
👥 <b>Multi-Tenant Support</b> · Single Base Model Deployment
12-
</p>
13-
14-
</div>
159

1610
## Twinkle Compatibility
1711

@@ -23,7 +17,6 @@ Twinkle and [ms-swift](https://github.com/modelscope/ms-swift) are both model tr
2317
- If you are a large model researcher who wants to customize models or training methods
2418
- If you are good at writing training loops and want to customize the training process
2519
- If you want to provide enterprise-level or commercial training platforms
26-
- If you lack training hardware and want to use community resources
2720

2821
### When to Choose ms-swift
2922

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Twinkle Training Service on ModelScope
2+
3+
Alongside the open-source release of the Twinkle framework, we also provide a hosted model training service (Training as a Service) powered by ModelScope's backend infrastructure. Developers can use this service to experience Twinkle's training API for free.
4+
5+
The model currently running on the cluster is [Qwen/Qwen3-30B-A3B-Instruct-2507](https://www.modelscope.cn/models/Qwen/Qwen3-30B-A3B-Instruct-2507). Below are the detailed usage instructions:
6+
7+
## Step 1. Register a ModelScope Account and Apply to Join the twinkle-explorers Organization
8+
9+
Developers first need to register as a ModelScope user and apply to join the [Twinkle-Explorers](https://modelscope.cn/organization/twinkle-explorers) organization to obtain access permissions. The current free Serverless training experience is still in beta testing and is only available to users within the organization. You can also use Twinkle✨ by deploying the service locally.
10+
11+
Registration link: https://www.modelscope.cn/
12+
13+
After registering and being approved to join the [Twinkle-Explorers](https://modelscope.cn/organization/twinkle-explorers) organization, obtain your API-Key (i.e., the ModelScope platform access token) from this page: https://www.modelscope.cn/my/access/token.
14+
15+
API endpoint: `base_url="https://www.modelscope.cn/twinkle"`
16+
17+
## Step 2. Review the Cookbook and Customize Development
18+
19+
We strongly recommend that developers review our [cookbook](https://github.com/modelscope/twinkle/tree/main/cookbook/client/) and build upon the training code provided there.
20+
21+
Developers can customize datasets, advantage functions, rewards, templates, and more. However, the Loss component is not currently customizable since it needs to be executed on the server side (for security reasons). If you need support for additional Loss functions, you can upload your Loss implementation to ModelHub and contact us via the Q&A group or through an issue to have the corresponding component added to the whitelist.
22+
23+
## Appendix: Supported Training Methods
24+
25+
This model is a text-only model, so multimodal tasks are not currently supported. For text-only tasks, you can train using:
26+
27+
1. Standard PT/SFT training methods, including Agentic training
28+
2. Self-sampling RL algorithms such as GRPO/RLOO
29+
3. Distillation methods like GKD/On-policy. Since the official ModelScope endpoint only supports a single model, the other Teacher/Student model must be prepared by the developer
30+
31+
The current official environment only supports LoRA training, with the following requirements:
32+
33+
1. Maximum rank = 32
34+
2. modules_to_save is not supported

docs/source_en/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Twinkle DOCUMENTATION
1313
Usage Guide/Installation.md
1414
Usage Guide/Server and Client/index.rst
1515
Usage Guide/NPU-Support.md
16+
Usage Guide/Train-as-a-Service.md
1617

1718
.. toctree::
1819
:maxdepth: 2

docs/source_zh/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Twinkle DOCUMENTATION
1313
使用指引/安装.md
1414
使用指引/服务端和客户端/index.rst
1515
使用指引/NPU的支持.md
16+
使用指引/训练服务.md
1617

1718
.. toctree::
1819
:maxdepth: 2

0 commit comments

Comments
 (0)