初始化项目,由ModelHub XC社区提供模型
Model: Xtra-Computing/XtraGPT-7B Source: Original Platform
This commit is contained in:
36
.gitattributes
vendored
Normal file
36
.gitattributes
vendored
Normal file
@@ -0,0 +1,36 @@
|
|||||||
|
*.7z filter=lfs diff=lfs merge=lfs -text
|
||||||
|
*.arrow filter=lfs diff=lfs merge=lfs -text
|
||||||
|
*.bin filter=lfs diff=lfs merge=lfs -text
|
||||||
|
*.bz2 filter=lfs diff=lfs merge=lfs -text
|
||||||
|
*.ckpt filter=lfs diff=lfs merge=lfs -text
|
||||||
|
*.ftz filter=lfs diff=lfs merge=lfs -text
|
||||||
|
*.gz filter=lfs diff=lfs merge=lfs -text
|
||||||
|
*.h5 filter=lfs diff=lfs merge=lfs -text
|
||||||
|
*.joblib filter=lfs diff=lfs merge=lfs -text
|
||||||
|
*.lfs.* filter=lfs diff=lfs merge=lfs -text
|
||||||
|
*.mlmodel filter=lfs diff=lfs merge=lfs -text
|
||||||
|
*.model filter=lfs diff=lfs merge=lfs -text
|
||||||
|
*.msgpack filter=lfs diff=lfs merge=lfs -text
|
||||||
|
*.npy filter=lfs diff=lfs merge=lfs -text
|
||||||
|
*.npz filter=lfs diff=lfs merge=lfs -text
|
||||||
|
*.onnx filter=lfs diff=lfs merge=lfs -text
|
||||||
|
*.ot filter=lfs diff=lfs merge=lfs -text
|
||||||
|
*.parquet filter=lfs diff=lfs merge=lfs -text
|
||||||
|
*.pb filter=lfs diff=lfs merge=lfs -text
|
||||||
|
*.pickle filter=lfs diff=lfs merge=lfs -text
|
||||||
|
*.pkl filter=lfs diff=lfs merge=lfs -text
|
||||||
|
*.pt filter=lfs diff=lfs merge=lfs -text
|
||||||
|
*.pth filter=lfs diff=lfs merge=lfs -text
|
||||||
|
*.rar filter=lfs diff=lfs merge=lfs -text
|
||||||
|
*.safetensors filter=lfs diff=lfs merge=lfs -text
|
||||||
|
saved_model/**/* filter=lfs diff=lfs merge=lfs -text
|
||||||
|
*.tar.* filter=lfs diff=lfs merge=lfs -text
|
||||||
|
*.tar filter=lfs diff=lfs merge=lfs -text
|
||||||
|
*.tflite filter=lfs diff=lfs merge=lfs -text
|
||||||
|
*.tgz filter=lfs diff=lfs merge=lfs -text
|
||||||
|
*.wasm filter=lfs diff=lfs merge=lfs -text
|
||||||
|
*.xz filter=lfs diff=lfs merge=lfs -text
|
||||||
|
*.zip filter=lfs diff=lfs merge=lfs -text
|
||||||
|
*.zst filter=lfs diff=lfs merge=lfs -text
|
||||||
|
*tfevents* filter=lfs diff=lfs merge=lfs -text
|
||||||
|
*.json filter=lfs diff=lfs merge=lfs -text
|
||||||
199
README.md
Normal file
199
README.md
Normal file
@@ -0,0 +1,199 @@
|
|||||||
|
---
|
||||||
|
license: other
|
||||||
|
license_name: mg0-2.0
|
||||||
|
license_link: https://github.com/Xtra-Computing/ModelGo/blob/main/MG_licenses/V2/MG0-2.0.txt
|
||||||
|
language:
|
||||||
|
- zho
|
||||||
|
- eng
|
||||||
|
- fra
|
||||||
|
- spa
|
||||||
|
- por
|
||||||
|
- deu
|
||||||
|
- ita
|
||||||
|
- rus
|
||||||
|
- jpn
|
||||||
|
- kor
|
||||||
|
- vie
|
||||||
|
- tha
|
||||||
|
- ara
|
||||||
|
pipeline_tag: text-generation
|
||||||
|
base_model: Qwen/Qwen2.5-7B-Instruct
|
||||||
|
tags:
|
||||||
|
- chat
|
||||||
|
library_name: transformers
|
||||||
|
---
|
||||||
|
|
||||||
|
# XtraGPT: Context-Aware and Controllable Academic Paper Revision for Human-AI Collaboration
|
||||||
|
|
||||||
|
<p align="center">
|
||||||
|
<a href="https://arxiv.org/abs/2505.11336">
|
||||||
|
<img alt="arXiv" src="https://img.shields.io/badge/arXiv-2505.11336-b31b1b.svg">
|
||||||
|
</a>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
## Model Overview
|
||||||
|
|
||||||
|
**XtraGPT** is a family of open-source Large Language Models (LLMs) designed specifically for **human-AI collaborative academic paper revision**. Unlike general-purpose models that often perform surface-level polishing, XtraGPT is fine-tuned to **understand the full context** of a research paper and execute specific, **criteria-guided** revision instructions.
|
||||||
|
|
||||||
|
The models were trained on a dataset of 140,000 high-quality instruction-revision pairs derived from top-tier conference papers (ICLR).
|
||||||
|
|
||||||
|
**Key Features:**
|
||||||
|
* **Context-Aware:** Processes the full paper context to ensure revisions maintain consistency with the global narrative.
|
||||||
|
* **Controllable:** Follows specific user instructions aligned with 20 academic writing criteria across 6 sections (Abstract, Introduction, etc.).
|
||||||
|
* **Iterative Workflow:** Designed to support the "Human-AI Collaborative" (HAC) lifecycle where authors retain creative control.
|
||||||
|
|
||||||
|
**Available Model Sizes:**
|
||||||
|
* **1.5B** (Based on Qwen/Qwen2.5-1.5B-Instruct)
|
||||||
|
* **3B** (Based on meta-llama/Llama-3.2-3B-Instruct)
|
||||||
|
* **7B** (Based on Qwen/Qwen2.5-7B-Instruct)
|
||||||
|
* **14B** (Based on microsoft/phi-4)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Inference with Transformers
|
||||||
|
|
||||||
|
To use XtraGPT with the standard Hugging Face `transformers` library, ensure you format your input using the specific tags `<PAPER_CONTENT>`, `<SELECTED_CONTENT>`, and `<QUESTION>`.
|
||||||
|
|
||||||
|
```python
|
||||||
|
import torch
|
||||||
|
from transformers import AutoModelForCausalLM, AutoTokenizer
|
||||||
|
|
||||||
|
# Select the model size: "XtraGPT-1.5B", "XtraGPT-3B", "XtraGPT-7B", or "XtraGPT-14B"
|
||||||
|
model_name = "Xtra-Computing/XtraGPT-7B"
|
||||||
|
|
||||||
|
tokenizer = AutoTokenizer.from_pretrained(model_name)
|
||||||
|
model = AutoModelForCausalLM.from_pretrained(
|
||||||
|
model_name,
|
||||||
|
torch_dtype=torch.float16,
|
||||||
|
device_map="auto"
|
||||||
|
)
|
||||||
|
|
||||||
|
# Define the Prompt Template tailored for XtraGPT
|
||||||
|
prompt_template = """Act as an expert model for improving articles **PAPER_CONTENT**.
|
||||||
|
The output needs to answer the **QUESTION** on **SELECTED_CONTENT** in the input. Avoid adding unnecessary length, unrelated details, overclaims, or vague statements.
|
||||||
|
Focus on clear, concise, and evidence-based improvements that align with the overall context of the paper.
|
||||||
|
<PAPER_CONTENT>
|
||||||
|
{paper_content}
|
||||||
|
</PAPER_CONTENT>
|
||||||
|
<SELECTED_CONTENT>
|
||||||
|
{selected_content}
|
||||||
|
</SELECTED_CONTENT>
|
||||||
|
<QUESTION>
|
||||||
|
{user_question}
|
||||||
|
</QUESTION>"""
|
||||||
|
|
||||||
|
# Example Data (from the "Attention Is All You Need" paper)
|
||||||
|
paper_content = "The dominant sequence transduction models are based on complex recurrent or convolutional neural networks in an encoder-decoder configuration. The best performing models also connect the encoder and decoder through an attention mechanism. We propose a new simple network architecture, the Transformer, based solely on attention mechanisms, dispensing with recurrence and convolutions entirely. Experiments on two machine translation tasks show these models to be superior in quality while being more parallelizable and requiring significantly less time to train."
|
||||||
|
selected_content = "The dominant sequence transduction models are based on complex recurrent or convolutional neural networks in an encoder-decoder configuration."
|
||||||
|
user_question = "help me make it more concise."
|
||||||
|
|
||||||
|
# Format the input
|
||||||
|
formatted_prompt = prompt_template.format(
|
||||||
|
paper_content=paper_content,
|
||||||
|
selected_content=selected_content,
|
||||||
|
user_question=user_question
|
||||||
|
)
|
||||||
|
|
||||||
|
messages = [
|
||||||
|
{"role": "user", "content": formatted_prompt}
|
||||||
|
]
|
||||||
|
|
||||||
|
# Apply chat template
|
||||||
|
text = tokenizer.apply_chat_template(
|
||||||
|
messages,
|
||||||
|
tokenize=False,
|
||||||
|
add_generation_prompt=True
|
||||||
|
)
|
||||||
|
|
||||||
|
model_inputs = tokenizer([text], return_tensors="pt").to(model.device)
|
||||||
|
|
||||||
|
# Generate
|
||||||
|
generated_ids = model.generate(
|
||||||
|
**model_inputs,
|
||||||
|
max_new_tokens=16384,
|
||||||
|
temperature=0.1
|
||||||
|
)
|
||||||
|
|
||||||
|
generated_ids = [
|
||||||
|
output_ids[len(input_ids):] for input_ids, output_ids in zip(model_inputs.input_ids, generated_ids)
|
||||||
|
]
|
||||||
|
|
||||||
|
response = tokenizer.batch_decode(generated_ids, skip_special_tokens=True)[0]
|
||||||
|
print(response)
|
||||||
|
```
|
||||||
|
|
||||||
|
-----
|
||||||
|
|
||||||
|
## Inference with vLLM
|
||||||
|
|
||||||
|
XtraGPT is compatible with vLLM for high-throughput inference.
|
||||||
|
|
||||||
|
### 1\. Launch the Server
|
||||||
|
|
||||||
|
Replace `XtraGPT-14B` with your specific model variant.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python -m vllm.entrypoints.openai.api_server \
|
||||||
|
--port 8088 \
|
||||||
|
--model Xtra-Computing/XtraGPT-14B \
|
||||||
|
--served-model-name xtragpt \
|
||||||
|
--max-model-len 16384 \
|
||||||
|
--gpu-memory-utilization 0.95
|
||||||
|
```
|
||||||
|
|
||||||
|
### 2\. Send a Request (Client Side)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl [http://127.0.0.1:8088/v1/chat/completions](http://127.0.0.1:8088/v1/chat/completions) \
|
||||||
|
-H "Content-Type: application/json" \
|
||||||
|
-d '{
|
||||||
|
"model": "xtragpt",
|
||||||
|
"messages": [
|
||||||
|
{
|
||||||
|
"role": "user",
|
||||||
|
"content": "Please improve the selected content based on the following. Act as an expert model for improving articles **PAPER_CONTENT**.\nThe output needs to answer the **QUESTION** on **SELECTED_CONTENT** in the input. Avoid adding unnecessary length, unrelated details, overclaims, or vague statements.\nFocus on clear, concise, and evidence-based improvements that align with the overall context of the paper.\n<PAPER_CONTENT>\nThe dominant sequence transduction models are based on complex recurrent or convolutional neural networks in an encoder-decoder configuration. The best performing models also connect the encoder and decoder through an attention mechanism. We propose a new simple network architecture, the Transformer, based solely on attention mechanisms, dispensing with recurrence and convolutions entirely. Experiments on two machine translation tasks show these models to be superior in quality while being more parallelizable and requiring significantly less time to train.\n</PAPER_CONTENT>\n<SELECTED_CONTENT>\nThe dominant sequence transduction models are based on complex recurrent or convolutional neural networks in an encoder-decoder configuration.\n</SELECTED_CONTENT>\n<QUESTION>\nhelp me make it more concise.\n</QUESTION>"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"temperature": 0.1,
|
||||||
|
"max_new_tokens": 16384,
|
||||||
|
"stream": false
|
||||||
|
}'
|
||||||
|
```
|
||||||
|
|
||||||
|
-----
|
||||||
|
|
||||||
|
## Run Locally with Ollama
|
||||||
|
|
||||||
|
You can easily run **XtraGPT** locally using [Ollama](https://ollama.com/). We have provided GGUF format models compatible with 4-bit quantization and full precision.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
ollama run hf.co/Xtra-Computing/XtraGPT-GGUF:{X}B-q4
|
||||||
|
ollama run hf.co/Xtra-Computing/XtraGPT-GGUF:{X}Bf16
|
||||||
|
```
|
||||||
|
|
||||||
|
-----
|
||||||
|
|
||||||
|
## Model License
|
||||||
|
|
||||||
|
This model is released under the **ModelGo Zero License 2.0 (MG0-2.0)**.
|
||||||
|
|
||||||
|
MG0-2.0 is a highly permissive open model license designed to facilitate the widest possible adoption and collaboration. It allows for **unrestricted use**, reproduction, distribution, and the creation of derivative works including for commercial purposes, without requiring attribution or imposing copyleft restrictions.
|
||||||
|
|
||||||
|
For more details on the license terms, please visit [ModelGo.li](https://www.modelgo.li/) or refer to the `LICENSE` file in the repository.
|
||||||
|
|
||||||
|
-----
|
||||||
|
|
||||||
|
## Citation
|
||||||
|
|
||||||
|
If you use XtraGPT in your research, please cite our paper:
|
||||||
|
|
||||||
|
```
|
||||||
|
@inproceedings{
|
||||||
|
chen2026xtragpt,
|
||||||
|
title={XtraGPT: Context-Aware and Controllable Academic Paper Revision via Human-AI Collaboration},
|
||||||
|
author={Nuo Chen and Andre Lin HuiKai and Jiaying Wu and Junyi Hou and Zining Zhang and Qian Wang and Xidong Wang and Bingsheng He},
|
||||||
|
booktitle = "Proceedings of the 64th Annual Meeting of the Association for Computational Linguistics (Volume 1: Long Papers)",
|
||||||
|
year={2026},
|
||||||
|
note={Available on arXiv:2505.11336}
|
||||||
|
}
|
||||||
|
```
|
||||||
BIN
added_tokens.json
(Stored with Git LFS)
Normal file
BIN
added_tokens.json
(Stored with Git LFS)
Normal file
Binary file not shown.
3
config.json
Normal file
3
config.json
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:474176df5672854eeafad8eb79300cd5b9c80e706098c7e4e5ffb794555f9dec
|
||||||
|
size 742
|
||||||
3
generation_config.json
Normal file
3
generation_config.json
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:960809bb05bcd0855dd46749f7933c963bbaa2e62ea02567e720729aab0303e7
|
||||||
|
size 243
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:4aef40698102632570290973c910a713f195d138365889b46d337dcb63a0a56c
|
||||||
|
size 22846855236
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:b952033dcf287cb1ad7f097af8d678509562c1c3fa082e8c4bf8413fdc9ba2e4
|
||||||
|
size 22846855236
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:ae8e6432ae34604b02bd30a549e430b1da3750eaf1e0244fe26aeff277ba06c0
|
||||||
|
size 22846855236
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:3d16a4fe0448850b607bfee72e4d3e3c6454800896f016da5410d6f5d17ba84e
|
||||||
|
size 22846855236
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:0e2e4a3fcafda76354a3e7c4b4cbf7fe0ce83ddbc4747a7dd9bc953faf1c27f8
|
||||||
|
size 166741
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:a1bf5a2233c68a660f67a9de3aacb92906f9287796aee36a719dcc776c8d4ef0
|
||||||
|
size 166741
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:cbefc553378acc586cea507181edd313e6bef0bc6104e8f726ad1addd2dad16e
|
||||||
|
size 166741
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:a1ad1aadd978f7810698222df20240eb3b06ff54805d89d78ab4f24facab1cc4
|
||||||
|
size 166741
|
||||||
151388
merges.txt
Normal file
151388
merges.txt
Normal file
File diff suppressed because it is too large
Load Diff
3
model-00001-of-00009.safetensors
Normal file
3
model-00001-of-00009.safetensors
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:c5fd8fc793e6275b642a21abf20774bfd632891af3c27cb62af529946d2e2547
|
||||||
|
size 1886423520
|
||||||
3
model-00002-of-00009.safetensors
Normal file
3
model-00002-of-00009.safetensors
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:a50957457af678fdef88f678b4c904b5236cf1069a4d9eaec87b8c65b331fdce
|
||||||
|
size 1864467800
|
||||||
3
model-00003-of-00009.safetensors
Normal file
3
model-00003-of-00009.safetensors
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:f20514056bf659a9494869b4704b31b5eef5f5b02419c09bc47a0398971da4d4
|
||||||
|
size 1864467800
|
||||||
3
model-00004-of-00009.safetensors
Normal file
3
model-00004-of-00009.safetensors
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:5c0b9205690b132aff3261918270d3a6978cf0492ecd4a25f6c7b3831d2faac1
|
||||||
|
size 1864467824
|
||||||
3
model-00005-of-00009.safetensors
Normal file
3
model-00005-of-00009.safetensors
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:8934254f79708adf2472fda08a74092cf38f6963de13a8fb28b0b9392a542556
|
||||||
|
size 1864467848
|
||||||
3
model-00006-of-00009.safetensors
Normal file
3
model-00006-of-00009.safetensors
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:e0b24bf0109829ad81fe49c99a11fdb94a0ea00015692c30597d4077653a46fd
|
||||||
|
size 1864467848
|
||||||
3
model-00007-of-00009.safetensors
Normal file
3
model-00007-of-00009.safetensors
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:42c89b61897fec478b65e51c2995e7481c91750eaa2168159fe761e65942a23c
|
||||||
|
size 1864467848
|
||||||
3
model-00008-of-00009.safetensors
Normal file
3
model-00008-of-00009.safetensors
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:135d8d69f778bd55c60cb5a4826240c580ca284eff5ff5fe3c9fb206f9285e3e
|
||||||
|
size 1068046456
|
||||||
3
model-00009-of-00009.safetensors
Normal file
3
model-00009-of-00009.safetensors
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:06006972c3be88e8a44fe21cfe2b0472b130780c781a741f8f90f1fe5ba3aae2
|
||||||
|
size 1089994880
|
||||||
BIN
model.safetensors.index.json
(Stored with Git LFS)
Normal file
BIN
model.safetensors.index.json
(Stored with Git LFS)
Normal file
Binary file not shown.
3
pytorch_model-00001-of-00007.bin
Normal file
3
pytorch_model-00001-of-00007.bin
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:582fcaa04a20457c9222498f36510281d7efbd649e405400c3c24b27b7736555
|
||||||
|
size 4976637618
|
||||||
3
pytorch_model-00002-of-00007.bin
Normal file
3
pytorch_model-00002-of-00007.bin
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:26eef6f818000004e97829eb09850ea514715e3746ed4307c2bc1ac11e821240
|
||||||
|
size 4778521132
|
||||||
3
pytorch_model-00003-of-00007.bin
Normal file
3
pytorch_model-00003-of-00007.bin
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:c24b5e71c2331b7400b75079595dc791644a0c17c34c59e31d18674ba6519cd1
|
||||||
|
size 4932660802
|
||||||
3
pytorch_model-00004-of-00007.bin
Normal file
3
pytorch_model-00004-of-00007.bin
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:45773ad971cd9b974e8c1f236ca293b1ad8199daf3937661fa2747c12c624549
|
||||||
|
size 4932660802
|
||||||
3
pytorch_model-00005-of-00007.bin
Normal file
3
pytorch_model-00005-of-00007.bin
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:00a321371586adec923b9bc27cee2fda646c8c1c85b838f94dd4d4fd1965037f
|
||||||
|
size 4998751416
|
||||||
3
pytorch_model-00006-of-00007.bin
Normal file
3
pytorch_model-00006-of-00007.bin
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:fd59c088728a03430649bf6d3c92a7e3f8ea05a9dd8d1d810f5a064c845d65ef
|
||||||
|
size 3662816782
|
||||||
3
pytorch_model-00007-of-00007.bin
Normal file
3
pytorch_model-00007-of-00007.bin
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:4b4f405b79c1d6fa29f4eb3b17c466c51a9ec0603da04553e77b53e05ead25fe
|
||||||
|
size 2180533924
|
||||||
3
pytorch_model.bin.index.json
Normal file
3
pytorch_model.bin.index.json
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:65db82d515b33379f1660a4e5a76bda1758b7757e83521494bab6d22e2873c23
|
||||||
|
size 27752
|
||||||
3
rng_state_0.pth
Normal file
3
rng_state_0.pth
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:92cc13315f24c28015d695b6cde08bb1cd6fea4cbc435998485ed6fbe4c91285
|
||||||
|
size 15024
|
||||||
3
rng_state_1.pth
Normal file
3
rng_state_1.pth
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:f4c154b6a63e0b1f98f7d2847944398f99f1657d35e8eddf7fdf0ae2c24b0552
|
||||||
|
size 15024
|
||||||
3
rng_state_2.pth
Normal file
3
rng_state_2.pth
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:f784c6a9507b51189f2caffbd178ea9882103b75852e31c15f47fdae6a43af1d
|
||||||
|
size 15024
|
||||||
3
rng_state_3.pth
Normal file
3
rng_state_3.pth
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:34b023e05bc2d12b91dc436d4922b990d50ec8dc56d40dc3e36b3bb34fc81341
|
||||||
|
size 15024
|
||||||
3
scheduler.pt
Normal file
3
scheduler.pt
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:c32c4e7313651033a3ad86d53aba85177e5dedba0aff17b3c3d08a993d9b26fd
|
||||||
|
size 1064
|
||||||
BIN
special_tokens_map.json
(Stored with Git LFS)
Normal file
BIN
special_tokens_map.json
(Stored with Git LFS)
Normal file
Binary file not shown.
3
tokenizer.json
Normal file
3
tokenizer.json
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:9c5ae00e602b8860cbd784ba82a8aa14e8feecec692e7076590d014d7b7fdafa
|
||||||
|
size 11421896
|
||||||
3
tokenizer_config.json
Normal file
3
tokenizer_config.json
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:459b8b85d5068661c69fe0fe391b42be728abc9eb62d44c9467dc06d88f8c93e
|
||||||
|
size 7362
|
||||||
3
trainer_state.json
Normal file
3
trainer_state.json
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:5f423c771a66c70c97cc1c3400b34b5d187a38d217610d5611a39eeaae3ec2f7
|
||||||
|
size 53004
|
||||||
3
training_args.bin
Normal file
3
training_args.bin
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
version https://git-lfs.github.com/spec/v1
|
||||||
|
oid sha256:90c787cce39177d6c24b9605bb3b3bb8ffce6fa048549863c90022ebff66768b
|
||||||
|
size 7672
|
||||||
BIN
vocab.json
(Stored with Git LFS)
Normal file
BIN
vocab.json
(Stored with Git LFS)
Normal file
Binary file not shown.
674
zero_to_fp32.py
Normal file
674
zero_to_fp32.py
Normal file
@@ -0,0 +1,674 @@
|
|||||||
|
#!/usr/bin/env python
|
||||||
|
|
||||||
|
# Copyright (c) Microsoft Corporation.
|
||||||
|
# SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
|
# DeepSpeed Team
|
||||||
|
|
||||||
|
# This script extracts fp32 consolidated weights from a zero 1, 2 and 3 DeepSpeed checkpoints. It gets
|
||||||
|
# copied into the top level checkpoint dir, so the user can easily do the conversion at any point in
|
||||||
|
# the future. Once extracted, the weights don't require DeepSpeed and can be used in any
|
||||||
|
# application.
|
||||||
|
#
|
||||||
|
# example:
|
||||||
|
# python zero_to_fp32.py . output_dir/
|
||||||
|
# or
|
||||||
|
# python zero_to_fp32.py . output_dir/ --safe_serialization
|
||||||
|
|
||||||
|
import argparse
|
||||||
|
import torch
|
||||||
|
import glob
|
||||||
|
import math
|
||||||
|
import os
|
||||||
|
import re
|
||||||
|
import json
|
||||||
|
from tqdm import tqdm
|
||||||
|
from collections import OrderedDict
|
||||||
|
from dataclasses import dataclass
|
||||||
|
|
||||||
|
# while this script doesn't use deepspeed to recover data, since the checkpoints are pickled with
|
||||||
|
# DeepSpeed data structures it has to be available in the current python environment.
|
||||||
|
from deepspeed.utils import logger
|
||||||
|
from deepspeed.checkpoint.constants import (DS_VERSION, OPTIMIZER_STATE_DICT, SINGLE_PARTITION_OF_FP32_GROUPS,
|
||||||
|
FP32_FLAT_GROUPS, ZERO_STAGE, PARTITION_COUNT, PARAM_SHAPES, BUFFER_NAMES,
|
||||||
|
FROZEN_PARAM_SHAPES, FROZEN_PARAM_FRAGMENTS)
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass
|
||||||
|
class zero_model_state:
|
||||||
|
buffers: dict()
|
||||||
|
param_shapes: dict()
|
||||||
|
shared_params: list
|
||||||
|
ds_version: int
|
||||||
|
frozen_param_shapes: dict()
|
||||||
|
frozen_param_fragments: dict()
|
||||||
|
|
||||||
|
|
||||||
|
debug = 0
|
||||||
|
|
||||||
|
# load to cpu
|
||||||
|
device = torch.device('cpu')
|
||||||
|
|
||||||
|
|
||||||
|
def atoi(text):
|
||||||
|
return int(text) if text.isdigit() else text
|
||||||
|
|
||||||
|
|
||||||
|
def natural_keys(text):
|
||||||
|
'''
|
||||||
|
alist.sort(key=natural_keys) sorts in human order
|
||||||
|
http://nedbatchelder.com/blog/200712/human_sorting.html
|
||||||
|
(See Toothy's implementation in the comments)
|
||||||
|
'''
|
||||||
|
return [atoi(c) for c in re.split(r'(\d+)', text)]
|
||||||
|
|
||||||
|
|
||||||
|
def get_model_state_file(checkpoint_dir, zero_stage):
|
||||||
|
if not os.path.isdir(checkpoint_dir):
|
||||||
|
raise FileNotFoundError(f"Directory '{checkpoint_dir}' doesn't exist")
|
||||||
|
|
||||||
|
# there should be only one file
|
||||||
|
if zero_stage <= 2:
|
||||||
|
file = os.path.join(checkpoint_dir, "mp_rank_00_model_states.pt")
|
||||||
|
elif zero_stage == 3:
|
||||||
|
file = os.path.join(checkpoint_dir, "zero_pp_rank_0_mp_rank_00_model_states.pt")
|
||||||
|
|
||||||
|
if not os.path.exists(file):
|
||||||
|
raise FileNotFoundError(f"can't find model states file at '{file}'")
|
||||||
|
|
||||||
|
return file
|
||||||
|
|
||||||
|
|
||||||
|
def get_checkpoint_files(checkpoint_dir, glob_pattern):
|
||||||
|
# XXX: need to test that this simple glob rule works for multi-node setup too
|
||||||
|
ckpt_files = sorted(glob.glob(os.path.join(checkpoint_dir, glob_pattern)), key=natural_keys)
|
||||||
|
|
||||||
|
if len(ckpt_files) == 0:
|
||||||
|
raise FileNotFoundError(f"can't find {glob_pattern} files in directory '{checkpoint_dir}'")
|
||||||
|
|
||||||
|
return ckpt_files
|
||||||
|
|
||||||
|
|
||||||
|
def get_optim_files(checkpoint_dir):
|
||||||
|
return get_checkpoint_files(checkpoint_dir, "*_optim_states.pt")
|
||||||
|
|
||||||
|
|
||||||
|
def get_model_state_files(checkpoint_dir):
|
||||||
|
return get_checkpoint_files(checkpoint_dir, "*_model_states.pt")
|
||||||
|
|
||||||
|
|
||||||
|
def parse_model_states(files):
|
||||||
|
zero_model_states = []
|
||||||
|
for file in files:
|
||||||
|
state_dict = torch.load(file, map_location=device)
|
||||||
|
|
||||||
|
if BUFFER_NAMES not in state_dict:
|
||||||
|
raise ValueError(f"{file} is not a model state checkpoint")
|
||||||
|
buffer_names = state_dict[BUFFER_NAMES]
|
||||||
|
if debug:
|
||||||
|
print("Found buffers:", buffer_names)
|
||||||
|
|
||||||
|
# recover just the buffers while restoring them to fp32 if they were saved in fp16
|
||||||
|
buffers = {k: v.float() for k, v in state_dict["module"].items() if k in buffer_names}
|
||||||
|
param_shapes = state_dict[PARAM_SHAPES]
|
||||||
|
|
||||||
|
# collect parameters that are included in param_shapes
|
||||||
|
param_names = []
|
||||||
|
for s in param_shapes:
|
||||||
|
for name in s.keys():
|
||||||
|
param_names.append(name)
|
||||||
|
|
||||||
|
# update with frozen parameters
|
||||||
|
frozen_param_shapes = state_dict.get(FROZEN_PARAM_SHAPES, None)
|
||||||
|
if frozen_param_shapes is not None:
|
||||||
|
if debug:
|
||||||
|
print(f"Found frozen_param_shapes: {frozen_param_shapes}")
|
||||||
|
param_names += list(frozen_param_shapes.keys())
|
||||||
|
|
||||||
|
# handle shared params
|
||||||
|
shared_params = [[k, v] for k, v in state_dict["shared_params"].items()]
|
||||||
|
|
||||||
|
ds_version = state_dict.get(DS_VERSION, None)
|
||||||
|
|
||||||
|
frozen_param_fragments = state_dict.get(FROZEN_PARAM_FRAGMENTS, None)
|
||||||
|
|
||||||
|
z_model_state = zero_model_state(buffers=buffers,
|
||||||
|
param_shapes=param_shapes,
|
||||||
|
shared_params=shared_params,
|
||||||
|
ds_version=ds_version,
|
||||||
|
frozen_param_shapes=frozen_param_shapes,
|
||||||
|
frozen_param_fragments=frozen_param_fragments)
|
||||||
|
zero_model_states.append(z_model_state)
|
||||||
|
|
||||||
|
return zero_model_states
|
||||||
|
|
||||||
|
|
||||||
|
def parse_optim_states(files, ds_checkpoint_dir):
|
||||||
|
total_files = len(files)
|
||||||
|
state_dicts = []
|
||||||
|
for f in files:
|
||||||
|
state_dict = torch.load(f, map_location=device)
|
||||||
|
# immediately discard the potentially huge 2 optimizer states as we only care for fp32 master weights
|
||||||
|
# and also handle the case where it was already removed by another helper script
|
||||||
|
state_dict["optimizer_state_dict"].pop("optimizer_state_dict", None)
|
||||||
|
state_dicts.append(state_dict)
|
||||||
|
|
||||||
|
if not ZERO_STAGE in state_dicts[0][OPTIMIZER_STATE_DICT]:
|
||||||
|
raise ValueError(f"{files[0]} is not a zero checkpoint")
|
||||||
|
zero_stage = state_dicts[0][OPTIMIZER_STATE_DICT][ZERO_STAGE]
|
||||||
|
world_size = state_dicts[0][OPTIMIZER_STATE_DICT][PARTITION_COUNT]
|
||||||
|
|
||||||
|
# For ZeRO-2 each param group can have different partition_count as data parallelism for expert
|
||||||
|
# parameters can be different from data parallelism for non-expert parameters. So we can just
|
||||||
|
# use the max of the partition_count to get the dp world_size.
|
||||||
|
|
||||||
|
if type(world_size) is list:
|
||||||
|
world_size = max(world_size)
|
||||||
|
|
||||||
|
if world_size != total_files:
|
||||||
|
raise ValueError(
|
||||||
|
f"Expected {world_size} of '*_optim_states.pt' under '{ds_checkpoint_dir}' but found {total_files} files. "
|
||||||
|
"Possibly due to an overwrite of an old checkpoint, or a checkpoint didn't get saved by one or more processes."
|
||||||
|
)
|
||||||
|
|
||||||
|
# the groups are named differently in each stage
|
||||||
|
if zero_stage <= 2:
|
||||||
|
fp32_groups_key = SINGLE_PARTITION_OF_FP32_GROUPS
|
||||||
|
elif zero_stage == 3:
|
||||||
|
fp32_groups_key = FP32_FLAT_GROUPS
|
||||||
|
else:
|
||||||
|
raise ValueError(f"unknown zero stage {zero_stage}")
|
||||||
|
|
||||||
|
if zero_stage <= 2:
|
||||||
|
fp32_flat_groups = [state_dicts[i][OPTIMIZER_STATE_DICT][fp32_groups_key] for i in range(len(state_dicts))]
|
||||||
|
elif zero_stage == 3:
|
||||||
|
# if there is more than one param group, there will be multiple flattened tensors - one
|
||||||
|
# flattened tensor per group - for simplicity merge them into a single tensor
|
||||||
|
#
|
||||||
|
# XXX: could make the script more memory efficient for when there are multiple groups - it
|
||||||
|
# will require matching the sub-lists of param_shapes for each param group flattened tensor
|
||||||
|
|
||||||
|
fp32_flat_groups = [
|
||||||
|
torch.cat(state_dicts[i][OPTIMIZER_STATE_DICT][fp32_groups_key], 0) for i in range(len(state_dicts))
|
||||||
|
]
|
||||||
|
|
||||||
|
return zero_stage, world_size, fp32_flat_groups
|
||||||
|
|
||||||
|
|
||||||
|
def _get_fp32_state_dict_from_zero_checkpoint(ds_checkpoint_dir, exclude_frozen_parameters):
|
||||||
|
"""
|
||||||
|
Returns fp32 state_dict reconstructed from ds checkpoint
|
||||||
|
|
||||||
|
Args:
|
||||||
|
- ``ds_checkpoint_dir``: path to the deepspeed checkpoint folder (where the optimizer files are)
|
||||||
|
|
||||||
|
"""
|
||||||
|
print(f"Processing zero checkpoint '{ds_checkpoint_dir}'")
|
||||||
|
|
||||||
|
optim_files = get_optim_files(ds_checkpoint_dir)
|
||||||
|
zero_stage, world_size, fp32_flat_groups = parse_optim_states(optim_files, ds_checkpoint_dir)
|
||||||
|
print(f"Detected checkpoint of type zero stage {zero_stage}, world_size: {world_size}")
|
||||||
|
|
||||||
|
model_files = get_model_state_files(ds_checkpoint_dir)
|
||||||
|
|
||||||
|
zero_model_states = parse_model_states(model_files)
|
||||||
|
print(f'Parsing checkpoint created by deepspeed=={zero_model_states[0].ds_version}')
|
||||||
|
|
||||||
|
if zero_stage <= 2:
|
||||||
|
return _get_fp32_state_dict_from_zero2_checkpoint(world_size, fp32_flat_groups, zero_model_states,
|
||||||
|
exclude_frozen_parameters)
|
||||||
|
elif zero_stage == 3:
|
||||||
|
return _get_fp32_state_dict_from_zero3_checkpoint(world_size, fp32_flat_groups, zero_model_states,
|
||||||
|
exclude_frozen_parameters)
|
||||||
|
|
||||||
|
|
||||||
|
def _zero2_merge_frozen_params(state_dict, zero_model_states):
|
||||||
|
if zero_model_states[0].frozen_param_shapes is None or len(zero_model_states[0].frozen_param_shapes) == 0:
|
||||||
|
return
|
||||||
|
|
||||||
|
frozen_param_shapes = zero_model_states[0].frozen_param_shapes
|
||||||
|
frozen_param_fragments = zero_model_states[0].frozen_param_fragments
|
||||||
|
|
||||||
|
if debug:
|
||||||
|
num_elem = sum(s.numel() for s in frozen_param_shapes.values())
|
||||||
|
print(f'rank 0: {FROZEN_PARAM_SHAPES}.numel = {num_elem}')
|
||||||
|
|
||||||
|
wanted_params = len(frozen_param_shapes)
|
||||||
|
wanted_numel = sum(s.numel() for s in frozen_param_shapes.values())
|
||||||
|
avail_numel = sum([p.numel() for p in frozen_param_fragments.values()])
|
||||||
|
print(f'Frozen params: Have {avail_numel} numels to process.')
|
||||||
|
print(f'Frozen params: Need {wanted_numel} numels in {wanted_params} params')
|
||||||
|
|
||||||
|
total_params = 0
|
||||||
|
total_numel = 0
|
||||||
|
for name, shape in frozen_param_shapes.items():
|
||||||
|
total_params += 1
|
||||||
|
unpartitioned_numel = shape.numel()
|
||||||
|
total_numel += unpartitioned_numel
|
||||||
|
|
||||||
|
state_dict[name] = frozen_param_fragments[name]
|
||||||
|
|
||||||
|
if debug:
|
||||||
|
print(f"{name} full shape: {shape} unpartitioned numel {unpartitioned_numel} ")
|
||||||
|
|
||||||
|
print(f"Reconstructed Frozen fp32 state dict with {total_params} params {total_numel} elements")
|
||||||
|
|
||||||
|
|
||||||
|
def _has_callable(obj, fn):
|
||||||
|
attr = getattr(obj, fn, None)
|
||||||
|
return callable(attr)
|
||||||
|
|
||||||
|
|
||||||
|
def _zero2_merge_trainable_params(state_dict, world_size, fp32_flat_groups, zero_model_states):
|
||||||
|
param_shapes = zero_model_states[0].param_shapes
|
||||||
|
|
||||||
|
# Reconstruction protocol:
|
||||||
|
#
|
||||||
|
# XXX: document this
|
||||||
|
|
||||||
|
if debug:
|
||||||
|
for i in range(world_size):
|
||||||
|
for j in range(len(fp32_flat_groups[0])):
|
||||||
|
print(f"{FP32_FLAT_GROUPS}[{i}][{j}].shape={fp32_flat_groups[i][j].shape}")
|
||||||
|
|
||||||
|
# XXX: memory usage doubles here (zero2)
|
||||||
|
num_param_groups = len(fp32_flat_groups[0])
|
||||||
|
merged_single_partition_of_fp32_groups = []
|
||||||
|
for i in range(num_param_groups):
|
||||||
|
merged_partitions = [sd[i] for sd in fp32_flat_groups]
|
||||||
|
full_single_fp32_vector = torch.cat(merged_partitions, 0)
|
||||||
|
merged_single_partition_of_fp32_groups.append(full_single_fp32_vector)
|
||||||
|
avail_numel = sum(
|
||||||
|
[full_single_fp32_vector.numel() for full_single_fp32_vector in merged_single_partition_of_fp32_groups])
|
||||||
|
|
||||||
|
if debug:
|
||||||
|
wanted_params = sum([len(shapes) for shapes in param_shapes])
|
||||||
|
wanted_numel = sum([sum(shape.numel() for shape in shapes.values()) for shapes in param_shapes])
|
||||||
|
# not asserting if there is a mismatch due to possible padding
|
||||||
|
print(f"Have {avail_numel} numels to process.")
|
||||||
|
print(f"Need {wanted_numel} numels in {wanted_params} params.")
|
||||||
|
|
||||||
|
# params
|
||||||
|
# XXX: for huge models that can't fit into the host's RAM we will have to recode this to support
|
||||||
|
# out-of-core computing solution
|
||||||
|
total_numel = 0
|
||||||
|
total_params = 0
|
||||||
|
for shapes, full_single_fp32_vector in zip(param_shapes, merged_single_partition_of_fp32_groups):
|
||||||
|
offset = 0
|
||||||
|
avail_numel = full_single_fp32_vector.numel()
|
||||||
|
for name, shape in shapes.items():
|
||||||
|
|
||||||
|
unpartitioned_numel = shape.numel() if _has_callable(shape, 'numel') else math.prod(shape)
|
||||||
|
total_numel += unpartitioned_numel
|
||||||
|
total_params += 1
|
||||||
|
|
||||||
|
if debug:
|
||||||
|
print(f"{name} full shape: {shape} unpartitioned numel {unpartitioned_numel} ")
|
||||||
|
state_dict[name] = full_single_fp32_vector.narrow(0, offset, unpartitioned_numel).view(shape)
|
||||||
|
offset += unpartitioned_numel
|
||||||
|
|
||||||
|
# Z2 started to align to 2*world_size to improve nccl performance. Therefore both offset and
|
||||||
|
# avail_numel can differ by anywhere between 0..2*world_size. Due to two unrelated complex
|
||||||
|
# paddings performed in the code it's almost impossible to predict the exact numbers w/o the
|
||||||
|
# live optimizer object, so we are checking that the numbers are within the right range
|
||||||
|
align_to = 2 * world_size
|
||||||
|
|
||||||
|
def zero2_align(x):
|
||||||
|
return align_to * math.ceil(x / align_to)
|
||||||
|
|
||||||
|
if debug:
|
||||||
|
print(f"original offset={offset}, avail_numel={avail_numel}")
|
||||||
|
|
||||||
|
offset = zero2_align(offset)
|
||||||
|
avail_numel = zero2_align(avail_numel)
|
||||||
|
|
||||||
|
if debug:
|
||||||
|
print(f"aligned offset={offset}, avail_numel={avail_numel}")
|
||||||
|
|
||||||
|
# Sanity check
|
||||||
|
if offset != avail_numel:
|
||||||
|
raise ValueError(f"consumed {offset} numels out of {avail_numel} - something is wrong")
|
||||||
|
|
||||||
|
print(f"Reconstructed fp32 state dict with {total_params} params {total_numel} elements")
|
||||||
|
|
||||||
|
|
||||||
|
def _get_fp32_state_dict_from_zero2_checkpoint(world_size, fp32_flat_groups, zero_model_states,
|
||||||
|
exclude_frozen_parameters):
|
||||||
|
state_dict = OrderedDict()
|
||||||
|
|
||||||
|
# buffers
|
||||||
|
buffers = zero_model_states[0].buffers
|
||||||
|
state_dict.update(buffers)
|
||||||
|
if debug:
|
||||||
|
print(f"added {len(buffers)} buffers")
|
||||||
|
|
||||||
|
if not exclude_frozen_parameters:
|
||||||
|
_zero2_merge_frozen_params(state_dict, zero_model_states)
|
||||||
|
|
||||||
|
_zero2_merge_trainable_params(state_dict, world_size, fp32_flat_groups, zero_model_states)
|
||||||
|
|
||||||
|
# recover shared parameters
|
||||||
|
for pair in zero_model_states[0].shared_params:
|
||||||
|
if pair[1] in state_dict:
|
||||||
|
state_dict[pair[0]] = state_dict[pair[1]]
|
||||||
|
|
||||||
|
return state_dict
|
||||||
|
|
||||||
|
|
||||||
|
def zero3_partitioned_param_info(unpartitioned_numel, world_size):
|
||||||
|
remainder = unpartitioned_numel % world_size
|
||||||
|
padding_numel = (world_size - remainder) if remainder else 0
|
||||||
|
partitioned_numel = math.ceil(unpartitioned_numel / world_size)
|
||||||
|
return partitioned_numel, padding_numel
|
||||||
|
|
||||||
|
|
||||||
|
def _zero3_merge_frozen_params(state_dict, world_size, zero_model_states):
|
||||||
|
if zero_model_states[0].frozen_param_shapes is None or len(zero_model_states[0].frozen_param_shapes) == 0:
|
||||||
|
return
|
||||||
|
|
||||||
|
if debug:
|
||||||
|
for i in range(world_size):
|
||||||
|
num_elem = sum(s.numel() for s in zero_model_states[i].frozen_param_fragments.values())
|
||||||
|
print(f'rank {i}: {FROZEN_PARAM_SHAPES}.numel = {num_elem}')
|
||||||
|
|
||||||
|
frozen_param_shapes = zero_model_states[0].frozen_param_shapes
|
||||||
|
wanted_params = len(frozen_param_shapes)
|
||||||
|
wanted_numel = sum(s.numel() for s in frozen_param_shapes.values())
|
||||||
|
avail_numel = sum([p.numel() for p in zero_model_states[0].frozen_param_fragments.values()]) * world_size
|
||||||
|
print(f'Frozen params: Have {avail_numel} numels to process.')
|
||||||
|
print(f'Frozen params: Need {wanted_numel} numels in {wanted_params} params')
|
||||||
|
|
||||||
|
total_params = 0
|
||||||
|
total_numel = 0
|
||||||
|
for name, shape in zero_model_states[0].frozen_param_shapes.items():
|
||||||
|
total_params += 1
|
||||||
|
unpartitioned_numel = shape.numel()
|
||||||
|
total_numel += unpartitioned_numel
|
||||||
|
|
||||||
|
param_frags = tuple(model_state.frozen_param_fragments[name] for model_state in zero_model_states)
|
||||||
|
state_dict[name] = torch.cat(param_frags, 0).narrow(0, 0, unpartitioned_numel).view(shape)
|
||||||
|
|
||||||
|
partitioned_numel, partitioned_padding_numel = zero3_partitioned_param_info(unpartitioned_numel, world_size)
|
||||||
|
|
||||||
|
if debug:
|
||||||
|
print(
|
||||||
|
f"Frozen params: {total_params} {name} full shape: {shape} partition0 numel={partitioned_numel} partitioned_padding_numel={partitioned_padding_numel}"
|
||||||
|
)
|
||||||
|
|
||||||
|
print(f"Reconstructed Frozen fp32 state dict with {total_params} params {total_numel} elements")
|
||||||
|
|
||||||
|
|
||||||
|
def _zero3_merge_trainable_params(state_dict, world_size, fp32_flat_groups, zero_model_states):
|
||||||
|
param_shapes = zero_model_states[0].param_shapes
|
||||||
|
avail_numel = fp32_flat_groups[0].numel() * world_size
|
||||||
|
# Reconstruction protocol: For zero3 we need to zip the partitions together at boundary of each
|
||||||
|
# param, re-consolidating each param, while dealing with padding if any
|
||||||
|
|
||||||
|
# merge list of dicts, preserving order
|
||||||
|
param_shapes = {k: v for d in param_shapes for k, v in d.items()}
|
||||||
|
|
||||||
|
if debug:
|
||||||
|
for i in range(world_size):
|
||||||
|
print(f"{FP32_FLAT_GROUPS}[{i}].shape={fp32_flat_groups[i].shape}")
|
||||||
|
|
||||||
|
wanted_params = len(param_shapes)
|
||||||
|
wanted_numel = sum(shape.numel() for shape in param_shapes.values())
|
||||||
|
# not asserting if there is a mismatch due to possible padding
|
||||||
|
avail_numel = fp32_flat_groups[0].numel() * world_size
|
||||||
|
print(f"Trainable params: Have {avail_numel} numels to process.")
|
||||||
|
print(f"Trainable params: Need {wanted_numel} numels in {wanted_params} params.")
|
||||||
|
|
||||||
|
# params
|
||||||
|
# XXX: for huge models that can't fit into the host's RAM we will have to recode this to support
|
||||||
|
# out-of-core computing solution
|
||||||
|
offset = 0
|
||||||
|
total_numel = 0
|
||||||
|
total_params = 0
|
||||||
|
for name, shape in tqdm(param_shapes.items(), desc='Gathering Sharded Weights'):
|
||||||
|
unpartitioned_numel = shape.numel()
|
||||||
|
total_numel += unpartitioned_numel
|
||||||
|
total_params += 1
|
||||||
|
partitioned_numel, partitioned_padding_numel = zero3_partitioned_param_info(unpartitioned_numel, world_size)
|
||||||
|
|
||||||
|
if debug:
|
||||||
|
print(
|
||||||
|
f"Trainable params: {total_params} {name} full shape: {shape} partition0 numel={partitioned_numel} partitioned_padding_numel={partitioned_padding_numel}"
|
||||||
|
)
|
||||||
|
|
||||||
|
# XXX: memory usage doubles here
|
||||||
|
state_dict[name] = torch.cat(
|
||||||
|
tuple(fp32_flat_groups[i].narrow(0, offset, partitioned_numel) for i in range(world_size)),
|
||||||
|
0).narrow(0, 0, unpartitioned_numel).view(shape)
|
||||||
|
offset += partitioned_numel
|
||||||
|
|
||||||
|
offset *= world_size
|
||||||
|
|
||||||
|
# Sanity check
|
||||||
|
if offset != avail_numel:
|
||||||
|
raise ValueError(f"consumed {offset} numels out of {avail_numel} - something is wrong")
|
||||||
|
|
||||||
|
print(f"Reconstructed Trainable fp32 state dict with {total_params} params {total_numel} elements")
|
||||||
|
|
||||||
|
|
||||||
|
def _get_fp32_state_dict_from_zero3_checkpoint(world_size, fp32_flat_groups, zero_model_states,
|
||||||
|
exclude_frozen_parameters):
|
||||||
|
state_dict = OrderedDict()
|
||||||
|
|
||||||
|
# buffers
|
||||||
|
buffers = zero_model_states[0].buffers
|
||||||
|
state_dict.update(buffers)
|
||||||
|
if debug:
|
||||||
|
print(f"added {len(buffers)} buffers")
|
||||||
|
|
||||||
|
if not exclude_frozen_parameters:
|
||||||
|
_zero3_merge_frozen_params(state_dict, world_size, zero_model_states)
|
||||||
|
|
||||||
|
_zero3_merge_trainable_params(state_dict, world_size, fp32_flat_groups, zero_model_states)
|
||||||
|
|
||||||
|
# recover shared parameters
|
||||||
|
for pair in zero_model_states[0].shared_params:
|
||||||
|
if pair[1] in state_dict:
|
||||||
|
state_dict[pair[0]] = state_dict[pair[1]]
|
||||||
|
|
||||||
|
return state_dict
|
||||||
|
|
||||||
|
|
||||||
|
def get_fp32_state_dict_from_zero_checkpoint(checkpoint_dir, tag=None, exclude_frozen_parameters=False):
|
||||||
|
"""
|
||||||
|
Convert ZeRO 2 or 3 checkpoint into a single fp32 consolidated state_dict that can be loaded with
|
||||||
|
``load_state_dict()`` and used for training without DeepSpeed or shared with others, for example
|
||||||
|
via a model hub.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
- ``checkpoint_dir``: path to the desired checkpoint folder
|
||||||
|
- ``tag``: checkpoint tag used as a unique identifier for checkpoint. If not provided will attempt to load tag in 'latest' file. e.g., ``global_step14``
|
||||||
|
- ``exclude_frozen_parameters``: exclude frozen parameters
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
- pytorch ``state_dict``
|
||||||
|
|
||||||
|
Note: this approach may not work if your application doesn't have sufficient free CPU memory and
|
||||||
|
you may need to use the offline approach using the ``zero_to_fp32.py`` script that is saved with
|
||||||
|
the checkpoint.
|
||||||
|
|
||||||
|
A typical usage might be ::
|
||||||
|
|
||||||
|
from deepspeed.utils.zero_to_fp32 import get_fp32_state_dict_from_zero_checkpoint
|
||||||
|
# do the training and checkpoint saving
|
||||||
|
state_dict = get_fp32_state_dict_from_zero_checkpoint(checkpoint_dir) # already on cpu
|
||||||
|
model = model.cpu() # move to cpu
|
||||||
|
model.load_state_dict(state_dict)
|
||||||
|
# submit to model hub or save the model to share with others
|
||||||
|
|
||||||
|
In this example the ``model`` will no longer be usable in the deepspeed context of the same
|
||||||
|
application. i.e. you will need to re-initialize the deepspeed engine, since
|
||||||
|
``model.load_state_dict(state_dict)`` will remove all the deepspeed magic from it.
|
||||||
|
|
||||||
|
If you want it all done for you, use ``load_state_dict_from_zero_checkpoint`` instead.
|
||||||
|
|
||||||
|
"""
|
||||||
|
if tag is None:
|
||||||
|
latest_path = os.path.join(checkpoint_dir, 'latest')
|
||||||
|
if os.path.isfile(latest_path):
|
||||||
|
with open(latest_path, 'r') as fd:
|
||||||
|
tag = fd.read().strip()
|
||||||
|
else:
|
||||||
|
raise ValueError(f"Unable to find 'latest' file at {latest_path}")
|
||||||
|
|
||||||
|
ds_checkpoint_dir = os.path.join(checkpoint_dir, tag)
|
||||||
|
|
||||||
|
if not os.path.isdir(ds_checkpoint_dir):
|
||||||
|
raise FileNotFoundError(f"Directory '{ds_checkpoint_dir}' doesn't exist")
|
||||||
|
|
||||||
|
return _get_fp32_state_dict_from_zero_checkpoint(ds_checkpoint_dir, exclude_frozen_parameters)
|
||||||
|
|
||||||
|
|
||||||
|
def convert_zero_checkpoint_to_fp32_state_dict(checkpoint_dir,
|
||||||
|
output_dir,
|
||||||
|
max_shard_size="5GB",
|
||||||
|
safe_serialization=False,
|
||||||
|
tag=None,
|
||||||
|
exclude_frozen_parameters=False):
|
||||||
|
"""
|
||||||
|
Convert ZeRO 2 or 3 checkpoint into a single fp32 consolidated ``state_dict`` file that can be
|
||||||
|
loaded with ``torch.load(file)`` + ``load_state_dict()`` and used for training without DeepSpeed.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
- ``checkpoint_dir``: path to the desired checkpoint folder. (one that contains the tag-folder, like ``global_step14``)
|
||||||
|
- ``output_dir``: directory to the pytorch fp32 state_dict output files
|
||||||
|
- ``max_shard_size``: the maximum size for a checkpoint before being sharded, default value is 5GB
|
||||||
|
- ``safe_serialization``: whether to save the model using `safetensors` or the traditional PyTorch way (that uses `pickle`).
|
||||||
|
- ``tag``: checkpoint tag used as a unique identifier for checkpoint. If not provided will attempt to load tag in the file named ``latest`` in the checkpoint folder, e.g., ``global_step14``
|
||||||
|
- ``exclude_frozen_parameters``: exclude frozen parameters
|
||||||
|
"""
|
||||||
|
# Dependency pre-check
|
||||||
|
if safe_serialization:
|
||||||
|
try:
|
||||||
|
from safetensors.torch import save_file
|
||||||
|
except ImportError:
|
||||||
|
print('If you want to use `safe_serialization`, please `pip install safetensors`')
|
||||||
|
raise
|
||||||
|
if max_shard_size is not None:
|
||||||
|
try:
|
||||||
|
from huggingface_hub import split_torch_state_dict_into_shards
|
||||||
|
except ImportError:
|
||||||
|
print('If you want to use `max_shard_size`, please `pip install huggingface_hub`')
|
||||||
|
raise
|
||||||
|
|
||||||
|
# Convert zero checkpoint to state_dict
|
||||||
|
state_dict = get_fp32_state_dict_from_zero_checkpoint(checkpoint_dir, tag, exclude_frozen_parameters)
|
||||||
|
|
||||||
|
# Shard the model if it is too big.
|
||||||
|
weights_name = "model.safetensors" if safe_serialization else "pytorch_model.bin"
|
||||||
|
if max_shard_size is not None:
|
||||||
|
filename_pattern = weights_name.replace(".bin", "{suffix}.bin").replace(".safetensors", "{suffix}.safetensors")
|
||||||
|
state_dict_split = split_torch_state_dict_into_shards(state_dict,
|
||||||
|
filename_pattern=filename_pattern,
|
||||||
|
max_shard_size=max_shard_size)
|
||||||
|
else:
|
||||||
|
from collections import namedtuple
|
||||||
|
StateDictSplit = namedtuple("StateDictSplit", ["is_sharded", "filename_to_tensors"])
|
||||||
|
state_dict_split = StateDictSplit(is_sharded=False,
|
||||||
|
filename_to_tensors={weights_name: list(state_dict.keys())})
|
||||||
|
|
||||||
|
# Save the model
|
||||||
|
filename_to_tensors = state_dict_split.filename_to_tensors.items()
|
||||||
|
for shard_file, tensors in tqdm(filename_to_tensors, desc="Saving checkpoint shards"):
|
||||||
|
shard = {tensor: state_dict[tensor].contiguous() for tensor in tensors}
|
||||||
|
output_path = os.path.join(output_dir, shard_file)
|
||||||
|
if safe_serialization:
|
||||||
|
save_file(shard, output_path, metadata={"format": "pt"})
|
||||||
|
else:
|
||||||
|
torch.save(shard, output_path)
|
||||||
|
|
||||||
|
# Save index if sharded
|
||||||
|
if state_dict_split.is_sharded:
|
||||||
|
index = {
|
||||||
|
"metadata": state_dict_split.metadata,
|
||||||
|
"weight_map": state_dict_split.tensor_to_filename,
|
||||||
|
}
|
||||||
|
save_index_file = "model.safetensors.index.json" if safe_serialization else "pytorch_model.bin.index.json"
|
||||||
|
save_index_file = os.path.join(output_dir, save_index_file)
|
||||||
|
with open(save_index_file, "w", encoding="utf-8") as f:
|
||||||
|
content = json.dumps(index, indent=2, sort_keys=True) + "\n"
|
||||||
|
f.write(content)
|
||||||
|
|
||||||
|
|
||||||
|
def load_state_dict_from_zero_checkpoint(model, checkpoint_dir, tag=None):
|
||||||
|
"""
|
||||||
|
1. Put the provided model to cpu
|
||||||
|
2. Convert ZeRO 2 or 3 checkpoint into a single fp32 consolidated ``state_dict``
|
||||||
|
3. Load it into the provided model
|
||||||
|
|
||||||
|
Args:
|
||||||
|
- ``model``: the model object to update
|
||||||
|
- ``checkpoint_dir``: path to the desired checkpoint folder. (one that contains the tag-folder, like ``global_step14``)
|
||||||
|
- ``tag``: checkpoint tag used as a unique identifier for checkpoint. If not provided will attempt to load tag in the file named ``latest`` in the checkpoint folder, e.g., ``global_step14``
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
- ``model`: modified model
|
||||||
|
|
||||||
|
Make sure you have plenty of CPU memory available before you call this function. If you don't
|
||||||
|
have enough use the ``zero_to_fp32.py`` utility to do the conversion. You will find it
|
||||||
|
conveniently placed for you in the checkpoint folder.
|
||||||
|
|
||||||
|
A typical usage might be ::
|
||||||
|
|
||||||
|
from deepspeed.utils.zero_to_fp32 import load_state_dict_from_zero_checkpoint
|
||||||
|
model = load_state_dict_from_zero_checkpoint(trainer.model, checkpoint_dir)
|
||||||
|
# submit to model hub or save the model to share with others
|
||||||
|
|
||||||
|
Note, that once this was run, the ``model`` will no longer be usable in the deepspeed context
|
||||||
|
of the same application. i.e. you will need to re-initialize the deepspeed engine, since
|
||||||
|
``model.load_state_dict(state_dict)`` will remove all the deepspeed magic from it.
|
||||||
|
|
||||||
|
"""
|
||||||
|
logger.info(f"Extracting fp32 weights")
|
||||||
|
state_dict = get_fp32_state_dict_from_zero_checkpoint(checkpoint_dir, tag)
|
||||||
|
|
||||||
|
logger.info(f"Overwriting model with fp32 weights")
|
||||||
|
model = model.cpu()
|
||||||
|
model.load_state_dict(state_dict, strict=False)
|
||||||
|
|
||||||
|
return model
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
parser = argparse.ArgumentParser()
|
||||||
|
parser.add_argument("checkpoint_dir",
|
||||||
|
type=str,
|
||||||
|
help="path to the desired checkpoint folder, e.g., path/checkpoint-12")
|
||||||
|
parser.add_argument("output_dir",
|
||||||
|
type=str,
|
||||||
|
help="directory to the pytorch fp32 state_dict output files"
|
||||||
|
"(e.g. path/checkpoint-12-output/)")
|
||||||
|
parser.add_argument(
|
||||||
|
"--max_shard_size",
|
||||||
|
type=str,
|
||||||
|
default="5GB",
|
||||||
|
help="The maximum size for a checkpoint before being sharded. Checkpoints shard will then be each of size"
|
||||||
|
"lower than this size. If expressed as a string, needs to be digits followed by a unit (like `5MB`"
|
||||||
|
"We default it to 5GB in order for models to be able to run easily on free-tier google colab instances"
|
||||||
|
"without CPU OOM issues.")
|
||||||
|
parser.add_argument(
|
||||||
|
"--safe_serialization",
|
||||||
|
default=False,
|
||||||
|
action='store_true',
|
||||||
|
help="Whether to save the model using `safetensors` or the traditional PyTorch way (that uses `pickle`).")
|
||||||
|
parser.add_argument("-t",
|
||||||
|
"--tag",
|
||||||
|
type=str,
|
||||||
|
default=None,
|
||||||
|
help="checkpoint tag used as a unique identifier for checkpoint. e.g., global_step1")
|
||||||
|
parser.add_argument("--exclude_frozen_parameters", action='store_true', help="exclude frozen parameters")
|
||||||
|
parser.add_argument("-d", "--debug", action='store_true', help="enable debug")
|
||||||
|
args = parser.parse_args()
|
||||||
|
|
||||||
|
debug = args.debug
|
||||||
|
|
||||||
|
convert_zero_checkpoint_to_fp32_state_dict(args.checkpoint_dir,
|
||||||
|
args.output_dir,
|
||||||
|
max_shard_size=args.max_shard_size,
|
||||||
|
safe_serialization=args.safe_serialization,
|
||||||
|
tag=args.tag,
|
||||||
|
exclude_frozen_parameters=args.exclude_frozen_parameters)
|
||||||
Reference in New Issue
Block a user