Skip to content

Commit 09216a7

Browse files
author
Yingda Chen
committed
update readme
1 parent 8ea76ca commit 09216a7

File tree

2 files changed

+10
-6
lines changed

2 files changed

+10
-6
lines changed

README.md

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

8282
## Changelog
8383

84-
- 🎉2026-02-13 Initial version of Twinkle✨ released, including SFT/PT/RL support for text models and serverless training capabilities on [ModelScope](https://modelscope.cn).
84+
- 🎉2026-02-13 Initial version of Twinkle✨ released, including SFT/PT/RL support for text models.
85+
We also made available serverless training capabilities on [ModelScope](https://modelscope.cn) via
86+
Tinker-compatible APIs.
8587

8688
## Training as a Service on ModelScope
8789

@@ -105,8 +107,10 @@ We will be adding support for more models as new models are released. The follow
105107
supported on Twinkle✨ framework.
106108

107109
>[!Note]
108-
> For serverless training service accessed via `base_url=https://www.modelscope.cn/twinkle`, it currently supports
109-
> 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).
110+
> For serverless training service accessed via `base_url=https://www.modelscope.cn/twinkle`, it
111+
> is currently provided via the Tinker-compatible APIs. We will be rolling out services that support
112+
> both Tinker APIs, as well as the full-fledged Twinkle✨ native APIs. The serverless endpoint is backed
113+
> by 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).
110114
111115

112116
| Model Type | Model ID on [ModelScope](https://modelscope.cn) | Requires | Megatron Support | HF Model ID |
@@ -197,7 +201,7 @@ if __name__ == '__main__':
197201
train()
198202
```
199203

200-
### Using Tinker-Like API
204+
### Access the Serverless Training Services via Tinker-compatible API
201205

202206
```python
203207
import os

src/twinkle/metric/train_metric.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ def calculate(self):
4444
self.lr = self.lr[0]
4545
if isinstance(self.lr, list):
4646
for idx, lr in enumerate(self.lr):
47-
results[f'learning rate(param group {idx+1})'] = lr
47+
results[f'learning rate(param group {idx + 1})'] = lr
4848
else:
4949
results['learning rate'] = self.lr
5050
if self.step is not None:
@@ -54,7 +54,7 @@ def calculate(self):
5454
if interval < 60:
5555
results['total time elapse'] = f'{(time.time() - self.start_time):.0f} seconds'
5656
else:
57-
results['total time elapse'] = f'{(time.time() - self.start_time)/60:.1f} minutes'
57+
results['total time elapse'] = f'{(time.time() - self.start_time) / 60:.1f} minutes'
5858
results['speed'] = f'{speed:.2f} iters/s'
5959
self.reset()
6060
return results

0 commit comments

Comments
 (0)