commit 39d0ba0499c774f94f78c7d3b084d88ce8223a83
Author: ModelHub XC
Date: Thu May 28 11:22:22 2026 +0800
初始化项目,由ModelHub XC社区提供模型
Model: openbmb/BitCPM-CANN-0.5B-unquantized
Source: Original Platform
diff --git a/.gitattributes b/.gitattributes
new file mode 100644
index 0000000..a6344aa
--- /dev/null
+++ b/.gitattributes
@@ -0,0 +1,35 @@
+*.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
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9a39933
--- /dev/null
+++ b/README.md
@@ -0,0 +1,126 @@
+---
+license: apache-2.0
+language:
+- zh
+- en
+pipeline_tag: text-generation
+library_name: transformers
+---
+
+

+
+
+
+GitHub Repo |
+Technical Report
+
+
+👋 Join us on Discord and WeChat
+
+
+## Overview
+
+BitCPM-CANN-0.5B-unquantized is the **unquantized QAT (Quantization-Aware Training) checkpoint** of BitCPM-CANN-0.5B, designed for **continued pre-training and fine-tuning**. It preserves full-precision latent weights with ternary fake quantizers (weights → {-1, 0, 1} with group-wise scaling, trained via STE) defined in `modeling.py`, enabling the model to keep learning under quantization constraints. For technical details, see our [Technical Report](https://github.com/OpenBMB/MiniCPM/blob/main/docs/BitCPM_CANN.pdf).
+
+> ⚠️ **This model is NOT for direct inference.** For inference, use the pseudo-quantized version: [openbmb/BitCPM-CANN-0.5B](https://huggingface.co/openbmb/BitCPM-CANN-0.5B).
+
+## Continued Pre-training & Fine-tuning
+
+The **only requirement** is that the forward pass must go through the bundled `modeling.py` (which contains the ternary fake quantizer). Load with `trust_remote_code=True` and do NOT replace or bypass the model's forward logic.
+
+### Option 1: DeepSpeed (Recommended)
+
+We provide ready-to-use training scripts in the [example](https://huggingface.co/openbmb/BitCPM-CANN-0.5B-unquantized/tree/main/example) directory (using the 1B model as an example):
+
+- **Continued pre-training**: `example/run.sh` + `example/train.py`
+- **SFT (Supervised Fine-tuning)**: `example/run_sft.sh` + `example/train_sft.py`
+
+Quick start:
+
+```bash
+# Continued pre-training
+cd example && bash run.sh
+
+# Supervised fine-tuning
+cd example && bash run_sft.sh
+```
+
+### Option 2: HuggingFace-compatible Frameworks
+
+Any framework that supports HuggingFace model loading with custom code can be used, such as **LLaMA Factory**, **HuggingFace Trainer**, etc. The key is to ensure `trust_remote_code=True`:
+
+```python
+from transformers import AutoModelForCausalLM, AutoTokenizer
+
+path = 'openbmb/BitCPM-CANN-0.5B-unquantized'
+tokenizer = AutoTokenizer.from_pretrained(path, trust_remote_code=True)
+model = AutoModelForCausalLM.from_pretrained(
+ path,
+ torch_dtype=torch.bfloat16,
+ trust_remote_code=True
+)
+
+# Use with your preferred framework (LLaMA Factory, HF Trainer, etc.)
+# The ternary fake quantizer in modeling.py is applied automatically during forward pass.
+```
+
+## Post-Training Conversion
+
+After training, use `qat-convert.py` to fuse the fake quantizer and produce inference-ready pseudo-quantized weights:
+
+```bash
+python qat-convert.py \
+ --input_bin \
+ --output \
+ --quant_type ternary \
+ --group_size -1
+```
+
+The converted model can be loaded for inference in the same way as [openbmb/BitCPM-CANN-0.5B](https://huggingface.co/openbmb/BitCPM-CANN-0.5B)—no special quantization libraries required.
+
+## Workflow
+
+```
+┌─────────────────────────────────┐
+│ BitCPM-CANN-0.5B-unquantized │ ← This model (QAT checkpoint + fake quantizer in modeling.py)
+└───────────────┬─────────────────┘
+ │
+ ▼ Train (DeepSpeed / LLaMA Factory / HF Trainer / ...)
+┌─────────────────────────────────┐
+│ Fine-tuned checkpoint │ ← Still contains un-fused QAT parameters
+└───────────────┬─────────────────┘
+ │
+ ▼ python qat-convert.py --quant_type ternary --group_size -1
+┌─────────────────────────────────┐
+│ Pseudo-quantized model │ ← Ready for inference (same format as BitCPM-CANN-0.5B)
+└─────────────────────────────────┘
+```
+
+## BitCPM-CANN Model Family
+
+| Model | HuggingFace (Inference) | HuggingFace (Fine-tuning) |
+|-------|-------------------------|---------------------------|
+| BitCPM-CANN-0.5B | [openbmb/BitCPM-CANN-0.5B](https://huggingface.co/openbmb/BitCPM-CANN-0.5B) | [openbmb/BitCPM-CANN-0.5B-unquantized](https://huggingface.co/openbmb/BitCPM-CANN-0.5B-unquantized) |
+| BitCPM-CANN-1B | [openbmb/BitCPM-CANN-1B](https://huggingface.co/openbmb/BitCPM-CANN-1B) | [openbmb/BitCPM-CANN-1B-unquantized](https://huggingface.co/openbmb/BitCPM-CANN-1B-unquantized) |
+| BitCPM-CANN-3B | [openbmb/BitCPM-CANN-3B](https://huggingface.co/openbmb/BitCPM-CANN-3B) | [openbmb/BitCPM-CANN-3B-unquantized](https://huggingface.co/openbmb/BitCPM-CANN-3B-unquantized) |
+| BitCPM-CANN-8B | [openbmb/BitCPM-CANN-8B](https://huggingface.co/openbmb/BitCPM-CANN-8B) | [openbmb/BitCPM-CANN-8B-unquantized](https://huggingface.co/openbmb/BitCPM-CANN-8B-unquantized) |
+
+## Statement
+- As a language model, BitCPM-CANN generates content by learning from a vast amount of text.
+- However, it does not possess the ability to comprehend or express personal opinions or value judgments.
+- Any content generated by BitCPM-CANN does not represent the viewpoints or positions of the model developers.
+- Therefore, when using content generated by BitCPM-CANN, users should take full responsibility for evaluating and verifying it on their own.
+
+## LICENSE
+- This repository and BitCPM-CANN models are released under the [Apache-2.0](https://github.com/OpenBMB/MiniCPM/blob/main/LICENSE) License.
+
+## Citation
+- Please cite our technical report if you find our work valuable.
+
+```bibtex
+@article{bitcpmcann,
+ title={{BitCPM-CANN}: Native 1.58-Bit Large Language Model Training on Ascend NPU},
+ author={BitCPM Team},
+ year={2026}
+}
+```
diff --git a/added_tokens.json b/added_tokens.json
new file mode 100644
index 0000000..7f0cedc
--- /dev/null
+++ b/added_tokens.json
@@ -0,0 +1,10 @@
+{
+ "<|execute_end|>": 73444,
+ "<|execute_start|>": 73443,
+ "<|fim_middle|>": 73446,
+ "<|fim_prefix|>": 73445,
+ "<|fim_suffix|>": 73447,
+ "<|im_end|>": 73440,
+ "<|im_start|>": 73441,
+ "<|tool_call|>": 73442
+}
diff --git a/config.json b/config.json
new file mode 100644
index 0000000..ef0ad71
--- /dev/null
+++ b/config.json
@@ -0,0 +1,37 @@
+{
+ "_name_or_path": "openbmb/MiniCPM4-0.5B",
+ "architectures": [
+ "MiniCPMForCausalLM"
+ ],
+ "auto_map": {
+ "AutoConfig": "configuration_minicpm.MiniCPMConfig",
+ "AutoModel": "modeling_minicpm.MiniCPMModel",
+ "AutoModelForCausalLM": "modeling_minicpm.MiniCPMForCausalLM",
+ "AutoModelForSeq2SeqLM": "modeling_minicpm.MiniCPMForCausalLM",
+ "AutoModelForSequenceClassification": "modeling_minicpm.MiniCPMForSequenceClassification"
+ },
+ "bos_token_id": 1,
+ "eos_token_id": [2, 73440],
+ "hidden_act": "silu",
+ "hidden_size": 1024,
+ "initializer_range": 0.1,
+ "intermediate_size": 4096,
+ "max_position_embeddings": 32768,
+ "num_attention_heads": 16,
+ "num_hidden_layers": 24,
+ "num_key_value_heads": 2,
+ "rms_norm_eps": 1e-05,
+ "rope_scaling": {
+ "rope_type": "longrope",
+ "long_factor": [1.0004360675811768, 1.0668443441390991, 1.1631425619125366, 1.3025742769241333, 1.5040205717086792, 1.7941505908966064, 2.2101221084594727, 2.802666664123535, 3.6389970779418945, 4.804192543029785, 6.39855432510376, 8.527148246765137, 11.277542114257812, 14.684998512268066, 18.69317054748535, 23.13019371032715, 27.72362518310547, 32.1606559753418, 36.168827056884766, 39.57627868652344, 42.32667541503906, 44.45526885986328, 46.04962921142578, 47.21482849121094, 48.05115509033203, 48.64370346069336, 49.05967712402344, 49.34980392456055, 49.551246643066406, 49.69068145751953, 49.78697967529297, 49.85338592529297],
+ "short_factor": [1.0004360675811768, 1.0668443441390991, 1.1631425619125366, 1.3025742769241333, 1.5040205717086792, 1.7941505908966064, 2.2101221084594727, 2.802666664123535, 3.6389970779418945, 4.804192543029785, 6.39855432510376, 8.527148246765137, 11.277542114257812, 14.684998512268066, 18.69317054748535, 23.13019371032715, 27.72362518310547, 32.1606559753418, 36.168827056884766, 39.57627868652344, 42.32667541503906, 44.45526885986328, 46.04962921142578, 47.21482849121094, 48.05115509033203, 48.64370346069336, 49.05967712402344, 49.34980392456055, 49.551246643066406, 49.69068145751953, 49.78697967529297, 49.85338592529297],
+ "original_max_position_embeddings": 32768
+ },
+ "torch_dtype": "bfloat16",
+ "transformers_version": "4.46.3",
+ "use_cache": true,
+ "vocab_size": 73448,
+ "scale_emb": 12,
+ "dim_model_base": 256,
+ "scale_depth": 1.4
+}
\ No newline at end of file
diff --git a/configuration_minicpm.py b/configuration_minicpm.py
new file mode 100644
index 0000000..8fd0bc0
--- /dev/null
+++ b/configuration_minicpm.py
@@ -0,0 +1,203 @@
+# coding=utf-8
+# Copyright 2025 The OpenBMB Team. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+""" MiniCPM model configuration"""
+
+from transformers.configuration_utils import PretrainedConfig
+from transformers.utils import logging
+
+logger = logging.get_logger(__name__)
+
+MINICPM_PRETRAINED_CONFIG_ARCHIVE_MAP = {}
+
+
+class MiniCPMConfig(PretrainedConfig):
+ r"""
+ This is the configuration class to store the configuration of a [`MiniCPMModel`]. It is used to instantiate an MiniCPM
+ model according to the specified arguments, defining the model architecture. Instantiating a configuration with the
+ defaults will yield a similar configuration to that of the MiniCPM-7B.
+
+ Configuration objects inherit from [`PretrainedConfig`] and can be used to control the model outputs. Read the
+ documentation from [`PretrainedConfig`] for more information.
+
+
+ Args:
+ vocab_size (`int`, *optional*, defaults to 32000):
+ Vocabulary size of the MiniCPM model. Defines the number of different tokens that can be represented by the
+ `inputs_ids` passed when calling [`MiniCPMModel`]
+ hidden_size (`int`, *optional*, defaults to 4096):
+ Dimension of the hidden representations.
+ intermediate_size (`int`, *optional*, defaults to 11008):
+ Dimension of the MLP representations.
+ num_hidden_layers (`int`, *optional*, defaults to 32):
+ Number of hidden layers in the Transformer decoder.
+ num_attention_heads (`int`, *optional*, defaults to 32):
+ Number of attention heads for each attention layer in the Transformer decoder.
+ num_key_value_heads (`int`, *optional*):
+ This is the number of key_value heads that should be used to implement Grouped Query Attention. If
+ `num_key_value_heads=num_attention_heads`, the model will use Multi Head Attention (MHA), if
+ `num_key_value_heads=1 the model will use Multi Query Attention (MQA) otherwise GQA is used. When
+ converting a multi-head checkpoint to a GQA checkpoint, each group key and value head should be constructed
+ by meanpooling all the original heads within that group. For more details checkout [this
+ paper](https://arxiv.org/pdf/2305.13245.pdf). If it is not specified, will default to
+ `num_attention_heads`.
+ hidden_act (`str` or `function`, *optional*, defaults to `"silu"`):
+ The non-linear activation function (function or string) in the decoder.
+ max_position_embeddings (`int`, *optional*, defaults to 2048):
+ The maximum sequence length that this model might ever be used with. MiniCPM 1 supports up to 2048 tokens,
+ MiniCPM 2 up to 4096, CodeMiniCPM up to 16384.
+ initializer_range (`float`, *optional*, defaults to 0.02):
+ The standard deviation of the truncated_normal_initializer for initializing all weight matrices.
+ rms_norm_eps (`float`, *optional*, defaults to 1e-06):
+ The epsilon used by the rms normalization layers.
+ use_cache (`bool`, *optional*, defaults to `True`):
+ Whether or not the model should return the last key/values attentions (not used by all models). Only
+ relevant if `config.is_decoder=True`.
+ pad_token_id (`int`, *optional*):
+ Padding token id.
+ bos_token_id (`int`, *optional*, defaults to 1):
+ Beginning of stream token id.
+ eos_token_id (`int`, *optional*, defaults to 2):
+ End of stream token id.
+ pretraining_tp (`int`, *optional*, defaults to 1):
+ Experimental feature. Tensor parallelism rank used during pretraining. Please refer to [this
+ document](https://huggingface.co/docs/transformers/parallelism) to understand more about it. This value is
+ necessary to ensure exact reproducibility of the pretraining results. Please refer to [this
+ issue](https://github.com/pytorch/pytorch/issues/76232).
+ tie_word_embeddings (`bool`, *optional*, defaults to `False`):
+ Whether to tie weight embeddings
+ rope_theta (`float`, *optional*, defaults to 10000.0):
+ The base period of the RoPE embeddings.
+ rope_scaling (`Dict`, *optional*):
+ Dictionary containing the scaling configuration for the RoPE embeddings. Currently supports two scaling
+ strategies: linear and dynamic. Their scaling factor must be a float greater than 1. The expected format is
+ `{"type": strategy name, "factor": scaling factor}`. When using this flag, don't update
+ `max_position_embeddings` to the expected new maximum. See the following thread for more information on how
+ these scaling strategies behave:
+ https://www.reddit.com/r/LocalMiniCPM/comments/14mrgpr/dynamically_scaled_rope_further_increases/. This is an
+ experimental feature, subject to breaking API changes in future versions.
+ attention_bias (`bool`, defaults to `False`, *optional*, defaults to `False`):
+ Whether to use a bias in the query, key, value and output projection layers during self-attention.
+ attention_dropout (`float`, *optional*, defaults to 0.0):
+ The dropout ratio for the attention probabilities.
+
+ ```python
+ >>> from transformers import MiniCPMModel, MiniCPMConfig
+
+ >>> # Initializing a MiniCPM minicpm-7b style configuration
+ >>> configuration = MiniCPMConfig()
+
+ >>> # Initializing a model from the minicpm-7b style configuration
+ >>> model = MiniCPMModel(configuration)
+
+ >>> # Accessing the model configuration
+ >>> configuration = model.config
+ ```"""
+
+ model_type = 'minicpm'
+ keys_to_ignore_at_inference = ['past_key_values']
+
+ def __init__(
+ self,
+ vocab_size=32000,
+ hidden_size=4096,
+ intermediate_size=11008,
+ num_hidden_layers=32,
+ num_attention_heads=32,
+ num_key_value_heads=None,
+ hidden_act='silu',
+ max_position_embeddings=2048,
+ initializer_range=0.02,
+ rms_norm_eps=1e-6,
+ use_cache=True,
+ pad_token_id=None,
+ bos_token_id=1,
+ eos_token_id=2,
+ pretraining_tp=1,
+ tie_word_embeddings=True,
+ rope_theta=10000.0,
+ rope_scaling=None,
+ attention_bias=False,
+ attention_dropout=0.0,
+ scale_emb=1,
+ dim_model_base=1,
+ scale_depth=1,
+ mup_denominator=None,
+ sparse_config=None,
+ **kwargs):
+
+ self.vocab_size = vocab_size
+ self.max_position_embeddings = max_position_embeddings
+ self.hidden_size = hidden_size
+ self.intermediate_size = intermediate_size
+ self.num_hidden_layers = num_hidden_layers
+ self.num_attention_heads = num_attention_heads
+
+ # for backward compatibility
+ if num_key_value_heads is None:
+ num_key_value_heads = num_attention_heads
+
+ self.num_key_value_heads = num_key_value_heads
+ self.hidden_act = hidden_act
+ self.initializer_range = initializer_range
+ self.rms_norm_eps = rms_norm_eps
+ self.pretraining_tp = pretraining_tp
+ self.use_cache = use_cache
+ self.rope_theta = rope_theta
+ self.rope_scaling = rope_scaling
+ # self._rope_scaling_validation()
+ self.attention_bias = attention_bias
+ self.attention_dropout = attention_dropout
+ self.scale_emb = scale_emb
+ self.dim_model_base = dim_model_base
+ self.scale_depth = scale_depth
+ # only used for Eagle Head
+ self.mup_denominator = mup_denominator
+
+ # sparse config
+ self.sparse_config = sparse_config
+
+ super().__init__(
+ pad_token_id=pad_token_id,
+ bos_token_id=bos_token_id,
+ eos_token_id=eos_token_id,
+ tie_word_embeddings=tie_word_embeddings,
+ **kwargs,
+ )
+ try:
+ import flash_attn
+ self._attn_implementation = 'flash_attention_2'
+ except:
+ pass
+
+ def _rope_scaling_validation(self):
+ """
+ Validate the `rope_scaling` configuration.
+ """
+ if self.rope_scaling is None:
+ return
+
+ if not isinstance(self.rope_scaling, dict) or len(self.rope_scaling) != 2:
+ raise ValueError(
+ '`rope_scaling` must be a dictionary with with two fields, `type` and `factor`, '
+ f'got {self.rope_scaling}'
+ )
+ rope_scaling_type = self.rope_scaling.get('type', None)
+ rope_scaling_factor = self.rope_scaling.get('factor', None)
+ if rope_scaling_type is None or rope_scaling_type not in ['linear', 'dynamic']:
+ raise ValueError(
+ f"`rope_scaling`'s type field must be one of ['linear', 'dynamic'], got {rope_scaling_type}"
+ )
+ if rope_scaling_factor is None or not isinstance(rope_scaling_factor, float) or rope_scaling_factor <= 1.0:
+ raise ValueError(f"`rope_scaling`'s factor field must be a float > 1, got {rope_scaling_factor}")
diff --git a/example/README.md b/example/README.md
new file mode 100644
index 0000000..70b2997
--- /dev/null
+++ b/example/README.md
@@ -0,0 +1,105 @@
+# BitCPM Training Example
+
+This project provides scripts for continue pretraining (CPT) and supervised fine-tuning (SFT) of **BitCPM-CANN-1B-unquantized**.
+
+## File Description
+
+CPT and SFT each have a pair of scripts (training script + launch script) and share DeepSpeed configuration files:
+
+| File | Description |
+| --- | --- |
+| `run.sh` | Launch script for CPT with hyperparameter configuration |
+| `run_sft.sh` | Launch script for SFT with hyperparameter configuration |
+| `train.py` | Continue pretrain script based on HuggingFace Trainer + DeepSpeed |
+| `train_sft.py` | Supervised fine-tuning script based on HuggingFace Trainer + DeepSpeed |
+| `ds_config.json` | DeepSpeed ZeRO-3 configuration (with CPU offload) |
+| `ds_config_z2.json` | DeepSpeed ZeRO-2 configuration (used by default) |
+| `requirements.txt` | Python dependency list |
+
+## Environment Setup
+
+### Docker Image
+
+Use the following Huawei NPU image on 910C:
+
+```
+swr.cn-south-1.myhuaweicloud.com/ascendhub/mindspeed-llm:openeuler22.03-mindspeed-llm-2.3.0-a3-arm
+```
+
+Other Huawei NPU images may also work but have not been fully tested.
+
+For GPU environments, there are no special image requirements — just install `requirements.txt` directly.
+
+### Install Dependencies
+
+After entering the container, install the Python dependencies:
+
+```bash
+pip install -r requirements.txt
+```
+
+## Continue Pretrain (CPT)
+
+### Dataset
+
+The test dataset used is [C4-Pro](https://huggingface.co/datasets/gair-prox/c4-pro), stored in parquet format after downloading.
+
+### Usage
+
+Modify the path configuration in `run.sh`:
+
+```bash
+MODEL_PATH="/path/to/BitCPM-CANN-1B-unquantized/"
+DATA_PATH="/path/to/c4-pro/data/your_file.parquet"
+```
+
+Then start training:
+
+```bash
+bash run.sh
+```
+
+## Supervised Fine-Tuning (SFT)
+
+### Dataset
+
+The test dataset used is [UltraChat 200k](https://huggingface.co/datasets/HuggingFaceH4/ultrachat_200k), stored in parquet format after downloading.
+
+### Usage
+
+Modify the path configuration in `run_sft.sh`:
+
+```bash
+MODEL_PATH="/path/to/BitCPM-CANN-1B-unquantized/"
+DATA_PATH="/path/to/ultrachat_200k/data/your_file.parquet"
+```
+
+Then start training:
+
+```bash
+bash run_sft.sh
+```
+
+## Training Results Reference
+
+> **Note:** BitCPM has its own training dataset and data mixture. It is expected that the loss continues to decrease when training on open-source datasets.
+
+Below are the loss curves from smoke tests on GPU and NPU for both CPT and SFT tasks. The results are highly consistent across GPU and NPU, indicating that users can continue pre-training or fine-tuning on various compute devices:
+
+| | GPU | NPU |
+| --- | --- | --- |
+| **CPT** |  |  |
+| **SFT** |  |  |
+
+Training log CSV files (corresponding to the loss curves above):
+
+| CSV File | Corresponding Loss Curve |
+| --- | --- |
+| [gpu_pretrain.csv](gpu_pretrain.csv) | GPU CPT |
+| [npu_pretrain.csv](npu_pretrain.csv) | NPU CPT |
+| [gpu_sft.csv](gpu_sft.csv) | GPU SFT |
+| [npu_sft.csv](npu_sft.csv) | NPU SFT |
+
+---
+
+These scripts provide a convenient, ready-to-use toolkit for QAT-aware continued pre-training and fine-tuning of BitCPM-CANN models, so you can quickly adapt the model to your own data and tasks while preserving ternary quantization constraints.
diff --git a/example/ds_config.json b/example/ds_config.json
new file mode 100644
index 0000000..d827f01
--- /dev/null
+++ b/example/ds_config.json
@@ -0,0 +1,29 @@
+{
+ "bf16": {
+ "enabled": true
+ },
+ "zero_optimization": {
+ "stage": 3,
+ "offload_optimizer": {
+ "device": "cpu",
+ "pin_memory": true
+ },
+ "offload_param": {
+ "device": "none"
+ },
+ "overlap_comm": true,
+ "contiguous_gradients": true,
+ "sub_group_size": 1e9,
+ "reduce_bucket_size": 2e8,
+ "stage3_prefetch_bucket_size": 2e8,
+ "stage3_param_persistence_threshold": 1e5,
+ "stage3_max_live_parameters": 2e9,
+ "stage3_max_reuse_distance": 2e9,
+ "stage3_gather_16bit_weights_on_model_save": true
+ },
+ "gradient_accumulation_steps": "auto",
+ "gradient_clipping": "auto",
+ "train_batch_size": "auto",
+ "train_micro_batch_size_per_gpu": "auto",
+ "wall_clock_breakdown": false
+}
diff --git a/example/ds_config_z2.json b/example/ds_config_z2.json
new file mode 100644
index 0000000..3f005fc
--- /dev/null
+++ b/example/ds_config_z2.json
@@ -0,0 +1,22 @@
+{
+ "bf16": {
+ "enabled": true
+ },
+ "zero_optimization": {
+ "stage": 2,
+ "offload_optimizer": {
+ "device": "none"
+ },
+ "allgather_partitions": true,
+ "allgather_bucket_size": 2e8,
+ "overlap_comm": true,
+ "reduce_scatter": true,
+ "reduce_bucket_size": 2e8,
+ "contiguous_gradients": true
+ },
+ "gradient_accumulation_steps": "auto",
+ "gradient_clipping": "auto",
+ "train_batch_size": "auto",
+ "train_micro_batch_size_per_gpu": "auto",
+ "wall_clock_breakdown": false
+}
diff --git a/example/gpu_pretrain.csv b/example/gpu_pretrain.csv
new file mode 100644
index 0000000..006c171
--- /dev/null
+++ b/example/gpu_pretrain.csv
@@ -0,0 +1,51 @@
+step,train/loss,train/grad_norm,train/learning_rate,train/epoch,train/train_runtime,train/train_samples_per_second,train/train_steps_per_second,train/total_flos,train/train_loss
+2,2.7920000553131104,0.03527498617768288,7.999999979801942e-06,0.010457516647875309,,,,,
+4,2.8011999130249023,0.03495891019701958,1.5999999959603883e-05,0.020915033295750618,,,,,
+6,2.7964000701904297,0.03271934762597084,2.4000000848900527e-05,0.0313725508749485,,,,,
+8,2.763700008392334,0.024968057870864868,3.199999991920777e-05,0.041830066591501236,,,,,
+10,3.281599998474121,0.31758183240890503,3.9999998989515007e-05,0.05228758230805397,,,,,
+12,2.941200017929077,0.044055406004190445,3.995128281530924e-05,0.062745101749897,,,,,
+14,2.851799964904785,0.03649706766009331,3.9805359847377986e-05,0.07320261746644974,,,,,
+16,2.7869999408721924,0.022624235600233078,3.9562950405525044e-05,0.08366013318300247,,,,,
+18,2.7825000286102295,0.021830420941114426,3.922523319488391e-05,0.0941176488995552,,,,,
+20,2.7857000827789307,0.01685911975800991,3.87938525818754e-05,0.10457516461610794,,,,,
+22,2.7571001052856445,0.01572061888873577,3.827090768027119e-05,0.11503268033266068,,,,,
+24,2.762399911880493,0.016891509294509888,3.7658952351193875e-05,0.125490203499794,,,,,
+26,2.7411000728607178,0.015683824196457863,3.6960962461307645e-05,0.13594771921634674,,,,,
+28,2.733099937438965,0.012847283855080605,3.6180339520797133e-05,0.14640523493289948,,,,,
+30,2.723400115966797,0.015209181234240532,3.532088885549456e-05,0.1568627506494522,,,,,
+32,2.7342000007629395,0.01241038367152214,3.4386797779006884e-05,0.16732026636600494,,,,,
+34,2.7321999073028564,0.012879018671810627,3.338261376484297e-05,0.17777778208255768,,,,,
+36,2.7314000129699707,0.013242729939520359,3.231322989449836e-05,0.1882352977991104,,,,,
+38,2.7065999507904053,0.01113435160368681,3.118385939160362e-05,0.19869281351566315,,,,,
+40,2.6958999633789062,0.012413726188242435,2.9999999242136255e-05,0.20915032923221588,,,,,
+42,2.7516000270843506,0.011661508120596409,2.8767422918463126e-05,0.21960784494876862,,,,,
+44,2.713099956512451,0.012248368933796883,2.749213126662653e-05,0.23006536066532135,,,,,
+46,2.7102999687194824,0.011450185440480709,2.6180339773418382e-05,0.24052287638187408,,,,,
+48,2.7021000385284424,0.011155751533806324,2.483843854861334e-05,0.250980406999588,,,,,
+50,2.680500030517578,0.010021247901022434,2.3472963221138343e-05,0.26143792271614075,,,,,
+52,2.699199914932251,0.010751751251518726,2.2090569473220967e-05,0.2718954384326935,,,,,
+54,2.694200038909912,0.010503941215574741,2.0697989384643734e-05,0.2823529541492462,,,,,
+56,2.7091000080108643,0.010059370659291744,1.9302009604871273e-05,0.29281046986579895,,,,,
+58,2.699399948120117,0.012161476537585258,1.7909431335283443e-05,0.3032679855823517,,,,,
+60,2.7216999530792236,0.010671027936041355,1.6527035768376663e-05,0.3137255012989044,,,,,
+62,2.7158000469207764,0.010463157668709755,1.516156225989107e-05,0.32418301701545715,,,,,
+64,2.7214999198913574,0.010665320791304111,1.3819660125591327e-05,0.3346405327320099,,,,,
+66,2.7116000652313232,0.01046629250049591,1.2507867722888477e-05,0.3450980484485626,,,,,
+68,2.6923000812530518,0.010609752498567104,1.1232576980546582e-05,0.35555556416511536,,,,,
+70,2.6830999851226807,0.009290814399719238,9.999999747378752e-06,0.3660130798816681,,,,,
+72,2.7093000411987305,0.010727670043706894,8.816142326395493e-06,0.3764705955982208,,,,,
+74,2.698699951171875,0.0109737953171134,7.686770914006047e-06,0.38692811131477356,,,,,
+76,2.712599992752075,0.010320967063307762,6.61738795315614e-06,0.3973856270313263,,,,,
+78,2.6993000507354736,0.009841523133218288,5.613203938992228e-06,0.40784314274787903,,,,,
+80,2.6861000061035156,0.010179675184190273,4.6791110435151495e-06,0.41830065846443176,,,,,
+82,2.6828999519348145,0.009790077805519104,3.819659923465224e-06,0.4287581741809845,,,,,
+84,2.699199914932251,0.010508442297577858,3.03903811982309e-06,0.43921568989753723,,,,,
+86,2.6988000869750977,0.009589221328496933,2.3410482299368596e-06,0.44967320561408997,,,,,
+88,2.688499927520752,0.010065913200378418,1.7290908544964623e-06,0.4601307213306427,,,,,
+90,2.6928999423980713,0.010363687761127949,1.206147544507985e-06,0.47058823704719543,,,,,
+92,2.714200019836426,0.010142815299332142,7.74766078848188e-07,0.48104575276374817,,,,,
+94,2.672300100326538,0.009833029471337795,4.370479871340649e-07,0.4915032684803009,,,,,
+96,2.7018001079559326,0.009937037713825703,1.9463863054625108e-07,0.501960813999176,,,,,
+98,2.7121999263763428,0.009417451918125153,4.8718995060426096e-08,0.5124183297157288,,,,,
+100,2.7028000354766846,0.009256146848201752,0.0,0.5228758454322815,365.8839111328125,139.93499755859375,0.27300000190734863,4.629706395531346e+17,2.7395541667938232
diff --git a/example/gpu_pretrain_loss.png b/example/gpu_pretrain_loss.png
new file mode 100644
index 0000000..764acfa
Binary files /dev/null and b/example/gpu_pretrain_loss.png differ
diff --git a/example/gpu_sft.csv b/example/gpu_sft.csv
new file mode 100644
index 0000000..bd8f2b5
--- /dev/null
+++ b/example/gpu_sft.csv
@@ -0,0 +1,51 @@
+step,train/loss,train/grad_norm,train/learning_rate,train/epoch,train/train_runtime,train/train_samples_per_second,train/train_steps_per_second,train/total_flos,train/train_loss
+2,1.1492999792099,0.6216375231742859,1.9999999949504854e-06,0.0004617871018126607,,,,,
+4,1.0979000329971313,0.681877851486206,3.999999989900971e-06,0.0009235742036253214,,,,,
+6,1.1269999742507935,0.784303605556488,6.000000212225132e-06,0.001385361305437982,,,,,
+8,1.0542000532150269,0.8737029433250427,7.999999979801942e-06,0.0018471484072506428,,,,,
+10,1.2440999746322632,0.7068291902542114,9.999999747378752e-06,0.0023089356254786253,,,,,
+12,1.2925000190734863,0.6821666955947876,1.2000000424450263e-05,0.002770722610875964,,,,,
+14,1.0843000411987305,0.525643527507782,1.4000000192027073e-05,0.0032325098291039467,,,,,
+16,1.0961999893188477,0.43757057189941406,1.5999999959603883e-05,0.0036942968145012856,,,,,
+18,1.0614999532699585,0.46141618490219116,1.8000000636675395e-05,0.004156084265559912,,,,,
+20,1.332900047302246,0.715879499912262,1.9999999494757503e-05,0.004617871250957251,,,,,
+22,1.2070000171661377,0.5926885008811951,1.996917308133561e-05,0.0050796582363545895,,,,,
+24,1.2043999433517456,0.5833240747451782,1.9876883015967906e-05,0.005541445221751928,,,,,
+26,1.0740000009536743,0.44734400510787964,1.9723698642337695e-05,0.0060032326728105545,,,,,
+28,1.1162999868392944,0.3701137900352478,1.9510565834934823e-05,0.006465019658207893,,,,,
+30,1.0454000234603882,0.43832680583000183,1.9238796085119247e-05,0.006926806643605232,,,,,
+32,1.124899983406067,0.4591037631034851,1.8910064682131633e-05,0.007388593629002571,,,,,
+34,1.0686999559402466,0.3873400390148163,1.8526401618146338e-05,0.00785038061439991,,,,,
+36,1.0291999578475952,0.40313437581062317,1.8090169760398567e-05,0.008312168531119823,,,,,
+38,1.1052000522613525,0.3735405504703522,1.7604059394216165e-05,0.008773955516517162,,,,,
+40,1.1555999517440796,0.3818407654762268,1.7071068214136176e-05,0.009235742501914501,,,,,
+42,1.0235999822616577,0.4255191683769226,1.6494481315021403e-05,0.00969752948731184,,,,,
+44,1.0364999771118164,0.4794503152370453,1.5877853002166376e-05,0.010159316472709179,,,,,
+46,1.1344000101089478,0.37273937463760376,1.5224985872919206e-05,0.010621103458106518,,,,,
+48,1.0866999626159668,0.417492538690567,1.453990535082994e-05,0.011082890443503857,,,,,
+50,1.1038000583648682,0.35408055782318115,1.3826834219798911e-05,0.01154467836022377,,,,,
+52,1.1478999853134155,0.3930828273296356,1.3090169886709191e-05,0.012006465345621109,,,,,
+54,1.1858999729156494,0.3965947926044464,1.2334453458606731e-05,0.012468252331018448,,,,,
+56,1.0096999406814575,0.3860221207141876,1.1564344276848715e-05,0.012930039316415787,,,,,
+58,1.114799976348877,0.44393691420555115,1.0784590813273098e-05,0.013391826301813126,,,,,
+60,1.079300045967102,0.3605058789253235,9.999999747378752e-06,0.013853613287210464,,,,,
+62,1.1766999959945679,0.40689122676849365,9.215408681484405e-06,0.014315400272607803,,,,,
+64,1.1075999736785889,0.4002344310283661,8.435655217908788e-06,0.014777187258005142,,,,,
+66,1.1866999864578247,0.46947163343429565,7.665546036150772e-06,0.015238975174725056,,,,,
+68,1.0311000347137451,0.3296957314014435,6.909830062795663e-06,0.01570076122879982,,,,,
+70,1.1088999509811401,0.33858785033226013,6.173165729705943e-06,0.01616254821419716,,,,,
+72,1.0720000267028809,0.3967427909374237,5.460095053422265e-06,0.016624337062239647,,,,,
+74,1.1460000276565552,0.41202062368392944,4.7750145313329995e-06,0.017086124047636986,,,,,
+76,1.0425000190734863,0.38334518671035767,4.1221474020858295e-06,0.017547911033034325,,,,,
+78,0.9154000282287598,0.40649303793907166,3.505519543978153e-06,0.018009698018431664,,,,,
+80,1.1110999584197998,0.35371580719947815,2.9289321901160292e-06,0.018471485003829002,,,,,
+82,1.1672999858856201,0.3381657302379608,2.3959403279150138e-06,0.01893327198922634,,,,,
+84,1.2374000549316406,0.3815234303474426,1.909829961732612e-06,0.01939505897462368,,,,,
+86,1.2151000499725342,0.38446080684661865,1.4735983313585166e-06,0.01985684596002102,,,,,
+88,1.163100004196167,0.40419140458106995,1.0899348126258701e-06,0.020318632945418358,,,,,
+90,1.1883000135421753,0.4011874198913574,7.612046601934708e-07,0.020780419930815697,,,,,
+92,1.1526999473571777,0.3836020231246948,4.894348535344761e-07,0.021242206916213036,,,,,
+94,1.15339994430542,0.452364057302475,2.7630079557638965e-07,0.021703993901610374,,,,,
+96,1.062000036239624,0.3502688705921173,1.2311659247643547e-07,0.022165780887007713,,,,,
+98,1.0271999835968018,0.4022065997123718,3.0826662111849146e-08,0.022627567872405052,,,,,
+100,1.0283000469207764,0.38241174817085266,0.0,0.02308935672044754,183.9481964111328,8.697999954223633,0.5440000295639038,1862467846144.0,1.1177252531051636
diff --git a/example/gpu_sft_loss.png b/example/gpu_sft_loss.png
new file mode 100644
index 0000000..23adde8
Binary files /dev/null and b/example/gpu_sft_loss.png differ
diff --git a/example/npu_pretrain.csv b/example/npu_pretrain.csv
new file mode 100644
index 0000000..8d66ff1
--- /dev/null
+++ b/example/npu_pretrain.csv
@@ -0,0 +1,51 @@
+step,train/loss,train/grad_norm,train/learning_rate,train/epoch,train/train_runtime,train/train_samples_per_second,train/train_steps_per_second,train/total_flos,train/train_loss
+2,2.7920000553131104,0.035306449979543686,7.999999979801942e-06,0.010457516647875309,,,,,
+4,2.8011999130249023,0.03491510450839996,1.5999999959603883e-05,0.020915033295750618,,,,,
+6,2.7964000701904297,0.032717395573854446,2.4000000848900527e-05,0.0313725508749485,,,,,
+8,2.763700008392334,0.024953875690698624,3.199999991920777e-05,0.041830066591501236,,,,,
+10,3.2811999320983887,0.3170815408229828,3.9999998989515007e-05,0.05228758230805397,,,,,
+12,2.9409000873565674,0.04423849284648895,3.995128281530924e-05,0.062745101749897,,,,,
+14,2.851900100708008,0.03667925298213959,3.9805359847377986e-05,0.07320261746644974,,,,,
+16,2.7869999408721924,0.022814607247710228,3.9562950405525044e-05,0.08366013318300247,,,,,
+18,2.782599925994873,0.021528413519263268,3.922523319488391e-05,0.0941176488995552,,,,,
+20,2.785599946975708,0.017014438286423683,3.87938525818754e-05,0.10457516461610794,,,,,
+22,2.7571001052856445,0.015719758346676826,3.827090768027119e-05,0.11503268033266068,,,,,
+24,2.762399911880493,0.016948623582720757,3.7658952351193875e-05,0.125490203499794,,,,,
+26,2.7411000728607178,0.015535997226834297,3.6960962461307645e-05,0.13594771921634674,,,,,
+28,2.7330000400543213,0.012748735956847668,3.6180339520797133e-05,0.14640523493289948,,,,,
+30,2.723299980163574,0.014809778891503811,3.532088885549456e-05,0.1568627506494522,,,,,
+32,2.7342000007629395,0.01219236571341753,3.4386797779006884e-05,0.16732026636600494,,,,,
+34,2.7321999073028564,0.012785322032868862,3.338261376484297e-05,0.17777778208255768,,,,,
+36,2.7314000129699707,0.012986919842660427,3.231322989449836e-05,0.1882352977991104,,,,,
+38,2.7065999507904053,0.01096824835985899,3.118385939160362e-05,0.19869281351566315,,,,,
+40,2.6958999633789062,0.012387535534799099,2.9999999242136255e-05,0.20915032923221588,,,,,
+42,2.751499891281128,0.011586200445890427,2.8767422918463126e-05,0.21960784494876862,,,,,
+44,2.713099956512451,0.011821281164884567,2.749213126662653e-05,0.23006536066532135,,,,,
+46,2.7102999687194824,0.01147585827857256,2.6180339773418382e-05,0.24052287638187408,,,,,
+48,2.7019999027252197,0.011368263512849808,2.483843854861334e-05,0.250980406999588,,,,,
+50,2.680500030517578,0.009935515932738781,2.3472963221138343e-05,0.26143792271614075,,,,,
+52,2.6993000507354736,0.0109846917912364,2.2090569473220967e-05,0.2718954384326935,,,,,
+54,2.6940999031066895,0.010465175844728947,2.0697989384643734e-05,0.2823529541492462,,,,,
+56,2.7091000080108643,0.01009758748114109,1.9302009604871273e-05,0.29281046986579895,,,,,
+58,2.69950008392334,0.01249368954449892,1.7909431335283443e-05,0.3032679855823517,,,,,
+60,2.7216999530792236,0.01051376760005951,1.6527035768376663e-05,0.3137255012989044,,,,,
+62,2.7158000469207764,0.01054943073540926,1.516156225989107e-05,0.32418301701545715,,,,,
+64,2.7214999198913574,0.01076149195432663,1.3819660125591327e-05,0.3346405327320099,,,,,
+66,2.7116000652313232,0.010380392894148827,1.2507867722888477e-05,0.3450980484485626,,,,,
+68,2.6923000812530518,0.010425001382827759,1.1232576980546582e-05,0.35555556416511536,,,,,
+70,2.683199882507324,0.00925016961991787,9.999999747378752e-06,0.3660130798816681,,,,,
+72,2.7093000411987305,0.01072422880679369,8.816142326395493e-06,0.3764705955982208,,,,,
+74,2.6988000869750977,0.011063243262469769,7.686770914006047e-06,0.38692811131477356,,,,,
+76,2.7125000953674316,0.01013101264834404,6.61738795315614e-06,0.3973856270313263,,,,,
+78,2.6993000507354736,0.009940676391124725,5.613203938992228e-06,0.40784314274787903,,,,,
+80,2.6861000061035156,0.01050259917974472,4.6791110435151495e-06,0.41830065846443176,,,,,
+82,2.6828999519348145,0.009912634268403053,3.819659923465224e-06,0.4287581741809845,,,,,
+84,2.699199914932251,0.010668900795280933,3.03903811982309e-06,0.43921568989753723,,,,,
+86,2.698899984359741,0.009650414809584618,2.3410482299368596e-06,0.44967320561408997,,,,,
+88,2.6884000301361084,0.01006452739238739,1.7290908544964623e-06,0.4601307213306427,,,,,
+90,2.6928999423980713,0.010409764014184475,1.206147544507985e-06,0.47058823704719543,,,,,
+92,2.714200019836426,0.009937116876244545,7.74766078848188e-07,0.48104575276374817,,,,,
+94,2.672300100326538,0.009728306904435158,4.370479871340649e-07,0.4915032684803009,,,,,
+96,2.7018001079559326,0.010098566301167011,1.9463863054625108e-07,0.501960813999176,,,,,
+98,2.7123000621795654,0.009524320252239704,4.8718995060426096e-08,0.5124183297157288,,,,,
+100,2.7028000354766846,0.009290286339819431,0.0,0.5228758454322815,788.0635986328125,64.96900177001953,0.12700000405311584,4.629706395531346e+17,2.739542245864868
diff --git a/example/npu_pretrain_loss.png b/example/npu_pretrain_loss.png
new file mode 100644
index 0000000..65e2d95
Binary files /dev/null and b/example/npu_pretrain_loss.png differ
diff --git a/example/npu_sft.csv b/example/npu_sft.csv
new file mode 100644
index 0000000..555f1e1
--- /dev/null
+++ b/example/npu_sft.csv
@@ -0,0 +1,51 @@
+step,train/loss,train/grad_norm,train/learning_rate,train/epoch,train/train_runtime,train/train_samples_per_second,train/train_steps_per_second,train/total_flos,train/train_loss
+2,1.1491999626159668,0.6218180060386658,1.9999999949504854e-06,0.0004617871018126607,,,,,
+4,1.0981999635696411,0.6825665235519409,3.999999989900971e-06,0.0009235742036253214,,,,,
+6,1.1269999742507935,0.7838642001152039,6.000000212225132e-06,0.001385361305437982,,,,,
+8,1.0542000532150269,0.8744276762008667,7.999999979801942e-06,0.0018471484072506428,,,,,
+10,1.2441999912261963,0.7064258456230164,9.999999747378752e-06,0.0023089356254786253,,,,,
+12,1.2927000522613525,0.6829814910888672,1.2000000424450263e-05,0.002770722610875964,,,,,
+14,1.0844999551773071,0.5265647172927856,1.4000000192027073e-05,0.0032325098291039467,,,,,
+16,1.0963000059127808,0.4373657703399658,1.5999999959603883e-05,0.0036942968145012856,,,,,
+18,1.0615999698638916,0.46220508217811584,1.8000000636675395e-05,0.004156084265559912,,,,,
+20,1.3325999975204468,0.7157824039459229,1.9999999494757503e-05,0.004617871250957251,,,,,
+22,1.2070000171661377,0.5933427214622498,1.996917308133561e-05,0.0050796582363545895,,,,,
+24,1.2044999599456787,0.5816172957420349,1.9876883015967906e-05,0.005541445221751928,,,,,
+26,1.0740000009536743,0.4489712119102478,1.9723698642337695e-05,0.0060032326728105545,,,,,
+28,1.1164000034332275,0.3696516752243042,1.9510565834934823e-05,0.006465019658207893,,,,,
+30,1.045199990272522,0.4376335144042969,1.9238796085119247e-05,0.006926806643605232,,,,,
+32,1.1247999668121338,0.4589230716228485,1.8910064682131633e-05,0.007388593629002571,,,,,
+34,1.0688999891281128,0.3879022002220154,1.8526401618146338e-05,0.00785038061439991,,,,,
+36,1.0292999744415283,0.4027869403362274,1.8090169760398567e-05,0.008312168531119823,,,,,
+38,1.1052000522613525,0.37394437193870544,1.7604059394216165e-05,0.008773955516517162,,,,,
+40,1.1557999849319458,0.3808683753013611,1.7071068214136176e-05,0.009235742501914501,,,,,
+42,1.0232000350952148,0.4252733886241913,1.6494481315021403e-05,0.00969752948731184,,,,,
+44,1.0364999771118164,0.48068660497665405,1.5877853002166376e-05,0.010159316472709179,,,,,
+46,1.1340999603271484,0.37313926219940186,1.5224985872919206e-05,0.010621103458106518,,,,,
+48,1.0866999626159668,0.4175492823123932,1.453990535082994e-05,0.011082890443503857,,,,,
+50,1.1039999723434448,0.35443660616874695,1.3826834219798911e-05,0.01154467836022377,,,,,
+52,1.1480000019073486,0.39232146739959717,1.3090169886709191e-05,0.012006465345621109,,,,,
+54,1.1861000061035156,0.396918922662735,1.2334453458606731e-05,0.012468252331018448,,,,,
+56,1.0096999406814575,0.3885609209537506,1.1564344276848715e-05,0.012930039316415787,,,,,
+58,1.114799976348877,0.4421806335449219,1.0784590813273098e-05,0.013391826301813126,,,,,
+60,1.0795999765396118,0.36081990599632263,9.999999747378752e-06,0.013853613287210464,,,,,
+62,1.1764999628067017,0.4062329828739166,9.215408681484405e-06,0.014315400272607803,,,,,
+64,1.107200026512146,0.39982733130455017,8.435655217908788e-06,0.014777187258005142,,,,,
+66,1.1868000030517578,0.4688170254230499,7.665546036150772e-06,0.015238975174725056,,,,,
+68,1.0312999486923218,0.3301626741886139,6.909830062795663e-06,0.01570076122879982,,,,,
+70,1.1089999675750732,0.3377252221107483,6.173165729705943e-06,0.01616254821419716,,,,,
+72,1.0716999769210815,0.39666977524757385,5.460095053422265e-06,0.016624337062239647,,,,,
+74,1.1461999416351318,0.4125552177429199,4.7750145313329995e-06,0.017086124047636986,,,,,
+76,1.042199969291687,0.3825180232524872,4.1221474020858295e-06,0.017547911033034325,,,,,
+78,0.9157000184059143,0.4063441753387451,3.505519543978153e-06,0.018009698018431664,,,,,
+80,1.1110999584197998,0.35289037227630615,2.9289321901160292e-06,0.018471485003829002,,,,,
+82,1.167199969291687,0.33720290660858154,2.3959403279150138e-06,0.01893327198922634,,,,,
+84,1.2375999689102173,0.38099613785743713,1.909829961732612e-06,0.01939505897462368,,,,,
+86,1.2151999473571777,0.3848689794540405,1.4735983313585166e-06,0.01985684596002102,,,,,
+88,1.1628999710083008,0.40408074855804443,1.0899348126258701e-06,0.020318632945418358,,,,,
+90,1.1884000301361084,0.4015007019042969,7.612046601934708e-07,0.020780419930815697,,,,,
+92,1.152500033378601,0.38306349515914917,4.894348535344761e-07,0.021242206916213036,,,,,
+94,1.154099941253662,0.45273807644844055,2.7630079557638965e-07,0.021703993901610374,,,,,
+96,1.0618000030517578,0.35036078095436096,1.2311659247643547e-07,0.022165780887007713,,,,,
+98,1.0270999670028687,0.40208569169044495,3.0826662111849146e-08,0.022627567872405052,,,,,
+100,1.0285999774932861,0.38247284293174744,0.0,0.02308935672044754,728.7083129882812,2.196000099182129,0.13699999451637268,1862467846144.0,1.117748498916626
diff --git a/example/npu_sft_loss.png b/example/npu_sft_loss.png
new file mode 100644
index 0000000..ab80fb3
Binary files /dev/null and b/example/npu_sft_loss.png differ
diff --git a/example/requirements.txt b/example/requirements.txt
new file mode 100644
index 0000000..aef37e1
--- /dev/null
+++ b/example/requirements.txt
@@ -0,0 +1,8 @@
+transformers==4.46.3
+tokenizers==0.20.3
+accelerate==1.1.1
+deepspeed==0.16.2
+datasets==3.1.0
+safetensors==0.4.5
+pyarrow==17.0.0
+tensorboard==2.18.0
diff --git a/example/run.sh b/example/run.sh
new file mode 100644
index 0000000..d8287db
--- /dev/null
+++ b/example/run.sh
@@ -0,0 +1,38 @@
+#!/bin/bash
+
+MODEL_PATH="/model/BitCPM-CANN-1B-unquantized"
+DATA_PATH="/dataset/c4-pro/data/000_1_7.parquet"
+OUTPUT_DIR="./output"
+DS_CONFIG="./ds_config_z2.json"
+
+NUM_GPUS=8
+BATCH_SIZE_PER_GPU=8
+GRAD_ACCUM_STEPS=8
+MAX_SEQ_LENGTH=1024
+
+export ASCEND_RT_VISIBLE_DEVICES=8,9,10,11,12,13,14,15
+export CUDA_VISIBLE_DEVICES=0,1,2,3,4,5,6,7
+export DS_SKIP_CUDA_CHECK=1
+torchrun --nproc_per_node=$NUM_GPUS train.py \
+ --model_name_or_path $MODEL_PATH \
+ --data_path $DATA_PATH \
+ --max_seq_length $MAX_SEQ_LENGTH \
+ --output_dir $OUTPUT_DIR \
+ --per_device_train_batch_size $BATCH_SIZE_PER_GPU \
+ --gradient_accumulation_steps $GRAD_ACCUM_STEPS \
+ --max_steps 100 \
+ --learning_rate 4e-5 \
+ --lr_scheduler_type cosine \
+ --warmup_ratio 0.1 \
+ --weight_decay 1e-2 \
+ --logging_steps 2 \
+ --save_steps 500 \
+ --save_total_limit 3 \
+ --bf16 \
+ --deepspeed $DS_CONFIG \
+ --gradient_checkpointing \
+ --seed 42 \
+ --dataloader_num_workers 4 \
+ --report_to tensorboard \
+ --logging_dir /data/tensorboard/pretrain \
+ --gradient_checkpointing_kwargs '{"use_reentrant": false}'
diff --git a/example/run_sft.sh b/example/run_sft.sh
new file mode 100644
index 0000000..597180d
--- /dev/null
+++ b/example/run_sft.sh
@@ -0,0 +1,40 @@
+#!/bin/bash
+
+MODEL_PATH="/model/BitCPM-CANN-1B-unquantized"
+DATA_PATH="/dataset/HuggingFaceH4_ultrachat_200k/data/train_sft-00000-of-00003-a3ecf92756993583.parquet"
+OUTPUT_DIR="./output_sft"
+DS_CONFIG="./ds_config.json"
+
+NUM_GPUS=8
+BATCH_SIZE_PER_GPU=2
+GRAD_ACCUM_STEPS=1
+MAX_SEQ_LENGTH=8192
+
+export ASCEND_RT_VISIBLE_DEVICES=0,1,2,3,4,5,6,7
+export CUDA_VISIBLE_DEVICES=0,1,2,3,4,5,6,7
+export DS_SKIP_CUDA_CHECK=1
+
+torchrun --nproc_per_node=$NUM_GPUS train_sft.py \
+ --model_name_or_path $MODEL_PATH \
+ --data_path $DATA_PATH \
+ --max_seq_length $MAX_SEQ_LENGTH \
+ --output_dir $OUTPUT_DIR \
+ --per_device_train_batch_size $BATCH_SIZE_PER_GPU \
+ --gradient_accumulation_steps $GRAD_ACCUM_STEPS \
+ --max_steps 100 \
+ --learning_rate 2e-5 \
+ --lr_scheduler_type cosine \
+ --warmup_ratio 0.2 \
+ --weight_decay 0.0 \
+ --logging_steps 2 \
+ --save_steps 500 \
+ --save_total_limit 3 \
+ --bf16 \
+ --deepspeed $DS_CONFIG \
+ --gradient_checkpointing \
+ --seed 42 \
+ --dataloader_num_workers 4 \
+ --report_to tensorboard \
+ --logging_dir /data/tensorboard/sft \
+ --train_on_prompt false \
+ --gradient_checkpointing_kwargs '{"use_reentrant": false}'
diff --git a/example/train.py b/example/train.py
new file mode 100644
index 0000000..842a39b
--- /dev/null
+++ b/example/train.py
@@ -0,0 +1,203 @@
+"""
+Continual pretraining script for CPM-2B model using DeepSpeed + HuggingFace Trainer.
+"""
+
+import os
+import json
+import math
+import logging
+from dataclasses import dataclass, field
+from typing import Optional
+
+import contextlib
+
+import torch
+from datasets import load_dataset
+from transformers import (
+ AutoModelForCausalLM,
+ AutoTokenizer,
+ AutoConfig,
+ Trainer,
+ TrainingArguments,
+ HfArgumentParser,
+ DataCollatorForLanguageModeling,
+ set_seed,
+)
+
+import deepspeed
+_orig_no_sync = deepspeed.DeepSpeedEngine.no_sync
+
+@contextlib.contextmanager
+def _patched_no_sync(self):
+ try:
+ with _orig_no_sync(self):
+ yield
+ except AssertionError:
+ yield
+
+deepspeed.DeepSpeedEngine.no_sync = _patched_no_sync
+
+logger = logging.getLogger(__name__)
+
+
+@dataclass
+class ModelArguments:
+ model_name_or_path: str = field(
+ metadata={"help": "Path to pretrained model or model identifier"}
+ )
+ torch_dtype: Optional[str] = field(
+ default="bfloat16",
+ metadata={"help": "torch dtype for model weights (float16, bfloat16, float32)"},
+ )
+
+
+@dataclass
+class DataArguments:
+ data_path: str = field(
+ metadata={"help": "Path to training data (parquet file or directory)"}
+ )
+ max_seq_length: int = field(
+ default=4096,
+ metadata={"help": "Maximum sequence length for training"},
+ )
+ text_column: str = field(
+ default="text",
+ metadata={"help": "Name of the text column in the dataset"},
+ )
+ preprocessing_num_workers: int = field(
+ default=8,
+ metadata={"help": "Number of workers for data preprocessing"},
+ )
+
+
+def tokenize_and_group(dataset, tokenizer, data_args):
+ """Tokenize texts and group into chunks of max_seq_length."""
+
+ column_names = dataset.column_names
+ text_column = data_args.text_column
+ if text_column not in column_names:
+ candidates = [c for c in column_names if "text" in c.lower()]
+ if candidates:
+ text_column = candidates[0]
+ else:
+ text_column = column_names[0]
+ logger.warning(f"Column '{data_args.text_column}' not found, using '{text_column}'")
+
+ def tokenize_function(examples):
+ return tokenizer(examples[text_column], add_special_tokens=False)
+
+ tokenized_dataset = dataset.map(
+ tokenize_function,
+ batched=True,
+ num_proc=data_args.preprocessing_num_workers,
+ remove_columns=column_names,
+ desc="Tokenizing",
+ )
+
+ block_size = data_args.max_seq_length
+
+ def group_texts(examples):
+ concatenated = {k: sum(examples[k], []) for k in examples.keys()}
+ total_length = len(concatenated["input_ids"])
+ total_length = (total_length // block_size) * block_size
+
+ result = {
+ k: [t[i : i + block_size] for i in range(0, total_length, block_size)]
+ for k, t in concatenated.items()
+ }
+ result["labels"] = result["input_ids"].copy()
+ return result
+
+ grouped_dataset = tokenized_dataset.map(
+ group_texts,
+ batched=True,
+ num_proc=data_args.preprocessing_num_workers,
+ desc="Grouping texts",
+ )
+
+ return grouped_dataset
+
+
+def main():
+ parser = HfArgumentParser((ModelArguments, DataArguments, TrainingArguments))
+ model_args, data_args, training_args = parser.parse_args_into_dataclasses()
+
+ logging.basicConfig(
+ format="%(asctime)s - %(levelname)s - %(name)s - %(message)s",
+ datefmt="%Y-%m-%d %H:%M:%S",
+ level=logging.INFO if training_args.local_rank in [-1, 0] else logging.WARN,
+ )
+ logger.info(f"Training args: {training_args}")
+
+ set_seed(training_args.seed)
+
+ dtype_map = {
+ "float16": torch.float16,
+ "bfloat16": torch.bfloat16,
+ "float32": torch.float32,
+ }
+ torch_dtype = dtype_map.get(model_args.torch_dtype, torch.bfloat16)
+
+ logger.info(f"Loading tokenizer from {model_args.model_name_or_path}")
+ tokenizer = AutoTokenizer.from_pretrained(
+ model_args.model_name_or_path,
+ trust_remote_code=True,
+ )
+ if tokenizer.pad_token is None:
+ tokenizer.pad_token = tokenizer.eos_token
+
+ logger.info(f"Loading model from {model_args.model_name_or_path}")
+ model = AutoModelForCausalLM.from_pretrained(
+ model_args.model_name_or_path,
+ torch_dtype=torch_dtype,
+ trust_remote_code=True,
+ attn_implementation="sdpa",
+ )
+ model.config.use_cache = False
+
+ logger.info(f"Loading dataset from {data_args.data_path}")
+ if os.path.isfile(data_args.data_path):
+ raw_dataset = load_dataset("parquet", data_files=data_args.data_path, split="train")
+ elif os.path.isdir(data_args.data_path):
+ parquet_files = [
+ os.path.join(data_args.data_path, f)
+ for f in os.listdir(data_args.data_path)
+ if f.endswith(".parquet")
+ ]
+ raw_dataset = load_dataset("parquet", data_files=parquet_files, split="train")
+ else:
+ raise ValueError(f"Data path not found: {data_args.data_path}")
+
+ logger.info(f"Dataset loaded: {len(raw_dataset)} samples, columns: {raw_dataset.column_names}")
+
+ train_dataset = tokenize_and_group(raw_dataset, tokenizer, data_args)
+ logger.info(f"Processed dataset: {len(train_dataset)} samples of length {data_args.max_seq_length}")
+
+ data_collator = DataCollatorForLanguageModeling(
+ tokenizer=tokenizer,
+ mlm=False,
+ )
+
+ trainer = Trainer(
+ model=model,
+ args=training_args,
+ train_dataset=train_dataset,
+ data_collator=data_collator,
+ )
+
+ logger.info("Starting training...")
+ train_result = trainer.train(
+ resume_from_checkpoint=training_args.resume_from_checkpoint
+ )
+
+ trainer.save_model()
+ trainer.save_state()
+
+ metrics = train_result.metrics
+ metrics["train_samples"] = len(train_dataset)
+ trainer.log_metrics("train", metrics)
+ trainer.save_metrics("train", metrics)
+
+
+if __name__ == "__main__":
+ main()
diff --git a/example/train_sft.py b/example/train_sft.py
new file mode 100644
index 0000000..e672481
--- /dev/null
+++ b/example/train_sft.py
@@ -0,0 +1,424 @@
+"""
+Supervised fine-tuning script using DeepSpeed + HuggingFace Trainer.
+"""
+
+import json
+import logging
+import os
+from dataclasses import dataclass, field
+from typing import Any, Dict, List, Optional, Tuple
+
+import contextlib
+
+import torch
+from datasets import load_dataset
+from transformers import (
+ AutoModelForCausalLM,
+ AutoTokenizer,
+ HfArgumentParser,
+ Trainer,
+ TrainingArguments,
+ set_seed,
+)
+
+import deepspeed
+_orig_no_sync = deepspeed.DeepSpeedEngine.no_sync
+
+@contextlib.contextmanager
+def _patched_no_sync(self):
+ try:
+ with _orig_no_sync(self):
+ yield
+ except AssertionError:
+ yield
+
+deepspeed.DeepSpeedEngine.no_sync = _patched_no_sync
+
+logger = logging.getLogger(__name__)
+
+IGNORE_INDEX = -100
+
+
+@dataclass
+class ModelArguments:
+ model_name_or_path: str = field(
+ metadata={"help": "Path to pretrained model or model identifier"}
+ )
+ torch_dtype: Optional[str] = field(
+ default="bfloat16",
+ metadata={"help": "torch dtype for model weights (float16, bfloat16, float32)"},
+ )
+
+
+@dataclass
+class DataArguments:
+ data_path: str = field(metadata={"help": "Path to SFT data file or directory"})
+ max_seq_length: int = field(
+ default=4096,
+ metadata={"help": "Maximum sequence length for training"},
+ )
+ prompt_column: Optional[str] = field(
+ default=None,
+ metadata={"help": "Prompt/instruction column name. Auto-detected if omitted."},
+ )
+ input_column: Optional[str] = field(
+ default=None,
+ metadata={"help": "Optional extra input/context column name"},
+ )
+ response_column: Optional[str] = field(
+ default=None,
+ metadata={"help": "Response/output column name. Auto-detected if omitted."},
+ )
+ messages_column: Optional[str] = field(
+ default=None,
+ metadata={"help": "Chat messages column name. Auto-detected if omitted."},
+ )
+ system_column: Optional[str] = field(
+ default=None,
+ metadata={"help": "Optional system prompt column name"},
+ )
+ train_on_prompt: bool = field(
+ default=False,
+ metadata={"help": "Whether to compute loss on prompt/user tokens"},
+ )
+ add_eos_token: bool = field(
+ default=True,
+ metadata={"help": "Append eos_token to plain prompt/response examples"},
+ )
+ preprocessing_num_workers: int = field(
+ default=8,
+ metadata={"help": "Number of workers for data preprocessing"},
+ )
+
+
+class SFTDataCollator:
+ def __init__(self, tokenizer, pad_to_multiple_of: Optional[int] = 8):
+ self.tokenizer = tokenizer
+ self.pad_to_multiple_of = pad_to_multiple_of
+
+ def __call__(self, features: List[Dict[str, List[int]]]) -> Dict[str, torch.Tensor]:
+ max_length = max(len(feature["input_ids"]) for feature in features)
+ if self.pad_to_multiple_of:
+ multiple = self.pad_to_multiple_of
+ max_length = ((max_length + multiple - 1) // multiple) * multiple
+
+ input_ids = []
+ attention_mask = []
+ labels = []
+ pad_token_id = self.tokenizer.pad_token_id
+
+ for feature in features:
+ length = len(feature["input_ids"])
+ pad_length = max_length - length
+ input_ids.append(feature["input_ids"] + [pad_token_id] * pad_length)
+ attention_mask.append([1] * length + [0] * pad_length)
+ labels.append(feature["labels"] + [IGNORE_INDEX] * pad_length)
+
+ return {
+ "input_ids": torch.tensor(input_ids, dtype=torch.long),
+ "attention_mask": torch.tensor(attention_mask, dtype=torch.long),
+ "labels": torch.tensor(labels, dtype=torch.long),
+ }
+
+
+def load_sft_dataset(data_path: str):
+ if os.path.isfile(data_path):
+ extension = os.path.splitext(data_path)[1].lstrip(".").lower()
+ if extension == "jsonl":
+ extension = "json"
+ if extension not in {"parquet", "json", "csv", "txt"}:
+ raise ValueError(f"Unsupported data file extension: {extension}")
+ return load_dataset(extension, data_files=data_path, split="train")
+
+ if os.path.isdir(data_path):
+ data_files = []
+ extension = None
+ for name in os.listdir(data_path):
+ current_extension = os.path.splitext(name)[1].lstrip(".").lower()
+ if current_extension == "jsonl":
+ current_extension = "json"
+ if current_extension in {"parquet", "json", "csv", "txt"}:
+ extension = extension or current_extension
+ if current_extension == extension:
+ data_files.append(os.path.join(data_path, name))
+ if not data_files or extension is None:
+ raise ValueError(f"No supported data files found in: {data_path}")
+ return load_dataset(extension, data_files=sorted(data_files), split="train")
+
+ raise ValueError(f"Data path not found: {data_path}")
+
+
+def choose_column(
+ column_names: List[str], explicit: Optional[str], candidates: List[str]
+) -> Optional[str]:
+ if explicit:
+ if explicit not in column_names:
+ raise ValueError(f"Column '{explicit}' not found. Available columns: {column_names}")
+ return explicit
+ for name in candidates:
+ if name in column_names:
+ return name
+ return None
+
+
+def parse_messages(value: Any) -> List[Dict[str, str]]:
+ if isinstance(value, str):
+ value = json.loads(value)
+ if not isinstance(value, list):
+ raise ValueError("messages/conversations column must be a list or JSON string")
+
+ messages = []
+ for item in value:
+ if not isinstance(item, dict):
+ raise ValueError("Each message must be a dict")
+
+ role = item.get("role", item.get("from"))
+ content = item.get("content", item.get("value"))
+ if role == "human":
+ role = "user"
+ elif role == "gpt":
+ role = "assistant"
+
+ if role is None or content is None:
+ raise ValueError("Each message must contain role/from and content/value")
+ messages.append({"role": str(role), "content": str(content)})
+
+ return messages
+
+
+def tokenize_text(tokenizer, text: str) -> List[int]:
+ return tokenizer(text, add_special_tokens=False)["input_ids"]
+
+
+def apply_chat_template(tokenizer, messages: List[Dict[str, str]], add_generation_prompt: bool) -> str:
+ if tokenizer.chat_template is None:
+ raise ValueError(
+ "The tokenizer has no chat_template. Use prompt/response columns or set a chat_template."
+ )
+ return tokenizer.apply_chat_template(
+ messages,
+ tokenize=False,
+ add_generation_prompt=add_generation_prompt,
+ )
+
+
+def encode_prompt_response(
+ example: Dict[str, Any],
+ tokenizer,
+ data_args: DataArguments,
+ prompt_column: str,
+ input_column: Optional[str],
+ response_column: str,
+) -> Tuple[List[int], List[int]]:
+ prompt = str(example[prompt_column])
+ if input_column and example.get(input_column):
+ prompt = prompt + "\n" + str(example[input_column])
+ response = str(example[response_column])
+
+ messages = []
+ if data_args.system_column and example.get(data_args.system_column):
+ messages.append({"role": "system", "content": str(example[data_args.system_column])})
+ messages.append({"role": "user", "content": prompt})
+ messages.append({"role": "assistant", "content": response})
+
+ if tokenizer.chat_template is not None:
+ full_text = apply_chat_template(tokenizer, messages, add_generation_prompt=False)
+ prompt_text = apply_chat_template(tokenizer, messages[:-1], add_generation_prompt=True)
+ input_ids = tokenize_text(tokenizer, full_text)
+ prompt_length = len(tokenize_text(tokenizer, prompt_text))
+ else:
+ response_text = response
+ if data_args.add_eos_token and tokenizer.eos_token:
+ response_text += tokenizer.eos_token
+ full_text = prompt + "\n" + response_text
+ input_ids = tokenize_text(tokenizer, full_text)
+ prompt_length = len(tokenize_text(tokenizer, prompt + "\n"))
+
+ labels = input_ids.copy()
+ if not data_args.train_on_prompt:
+ labels[:prompt_length] = [IGNORE_INDEX] * min(prompt_length, len(labels))
+ return input_ids, labels
+
+
+def encode_messages(
+ example: Dict[str, Any],
+ tokenizer,
+ data_args: DataArguments,
+ messages_column: str,
+) -> Tuple[List[int], List[int]]:
+ messages = parse_messages(example[messages_column])
+
+ if tokenizer.chat_template is not None:
+ full_text = apply_chat_template(tokenizer, messages, add_generation_prompt=False)
+ input_ids = tokenize_text(tokenizer, full_text)
+ labels = [IGNORE_INDEX] * len(input_ids)
+
+ if data_args.train_on_prompt:
+ labels = input_ids.copy()
+ else:
+ for index, message in enumerate(messages):
+ if message["role"] != "assistant":
+ continue
+ before_text = apply_chat_template(
+ tokenizer, messages[:index], add_generation_prompt=True
+ )
+ after_text = apply_chat_template(
+ tokenizer, messages[: index + 1], add_generation_prompt=False
+ )
+ start = len(tokenize_text(tokenizer, before_text))
+ end = len(tokenize_text(tokenizer, after_text))
+ labels[start:end] = input_ids[start:end]
+ else:
+ labels = []
+ input_ids = []
+ for message in messages:
+ part = f"{message['role']}: {message['content']}\n"
+ if data_args.add_eos_token and message["role"] == "assistant" and tokenizer.eos_token:
+ part += tokenizer.eos_token
+ part_ids = tokenize_text(tokenizer, part)
+ input_ids.extend(part_ids)
+ if data_args.train_on_prompt or message["role"] == "assistant":
+ labels.extend(part_ids)
+ else:
+ labels.extend([IGNORE_INDEX] * len(part_ids))
+
+ return input_ids, labels
+
+
+def preprocess_sft_dataset(raw_dataset, tokenizer, data_args: DataArguments):
+ column_names = raw_dataset.column_names
+ messages_column = choose_column(
+ column_names, data_args.messages_column, ["messages", "conversations"]
+ )
+ prompt_column = choose_column(
+ column_names,
+ data_args.prompt_column,
+ ["prompt", "instruction", "question"],
+ )
+ input_column = choose_column(
+ column_names,
+ data_args.input_column,
+ ["input", "context"],
+ )
+ response_column = choose_column(
+ column_names,
+ data_args.response_column,
+ ["response", "output", "answer", "chosen"],
+ )
+
+ if messages_column:
+ logger.info(f"Using chat messages column: {messages_column}")
+ elif prompt_column and response_column:
+ logger.info(f"Using prompt column '{prompt_column}' and response column '{response_column}'")
+ else:
+ raise ValueError(
+ "Cannot infer SFT data format. Provide either messages/conversations or "
+ "prompt/instruction plus response/output columns."
+ )
+
+ def encode_batch(examples):
+ batch_input_ids = []
+ batch_labels = []
+ batch_attention_mask = []
+
+ batch_size = len(next(iter(examples.values())))
+ for i in range(batch_size):
+ example = {name: values[i] for name, values in examples.items()}
+ if messages_column:
+ input_ids, labels = encode_messages(example, tokenizer, data_args, messages_column)
+ else:
+ input_ids, labels = encode_prompt_response(
+ example, tokenizer, data_args, prompt_column, input_column, response_column
+ )
+
+ input_ids = input_ids[: data_args.max_seq_length]
+ labels = labels[: data_args.max_seq_length]
+ if not input_ids or all(label == IGNORE_INDEX for label in labels):
+ continue
+
+ batch_input_ids.append(input_ids)
+ batch_labels.append(labels)
+ batch_attention_mask.append([1] * len(input_ids))
+
+ return {
+ "input_ids": batch_input_ids,
+ "attention_mask": batch_attention_mask,
+ "labels": batch_labels,
+ }
+
+ return raw_dataset.map(
+ encode_batch,
+ batched=True,
+ num_proc=data_args.preprocessing_num_workers,
+ remove_columns=column_names,
+ desc="Tokenizing SFT data",
+ )
+
+
+def main():
+ parser = HfArgumentParser((ModelArguments, DataArguments, TrainingArguments))
+ model_args, data_args, training_args = parser.parse_args_into_dataclasses()
+
+ logging.basicConfig(
+ format="%(asctime)s - %(levelname)s - %(name)s - %(message)s",
+ datefmt="%Y-%m-%d %H:%M:%S",
+ level=logging.INFO if training_args.local_rank in [-1, 0] else logging.WARN,
+ )
+ logger.info(f"Training args: {training_args}")
+
+ set_seed(training_args.seed)
+
+ dtype_map = {
+ "float16": torch.float16,
+ "bfloat16": torch.bfloat16,
+ "float32": torch.float32,
+ }
+ torch_dtype = dtype_map.get(model_args.torch_dtype, torch.bfloat16)
+
+ logger.info(f"Loading tokenizer from {model_args.model_name_or_path}")
+ tokenizer = AutoTokenizer.from_pretrained(
+ model_args.model_name_or_path,
+ trust_remote_code=True,
+ )
+ if tokenizer.pad_token is None:
+ tokenizer.pad_token = tokenizer.eos_token
+
+ logger.info(f"Loading model from {model_args.model_name_or_path}")
+ model = AutoModelForCausalLM.from_pretrained(
+ model_args.model_name_or_path,
+ torch_dtype=torch_dtype,
+ trust_remote_code=True,
+ attn_implementation="sdpa",
+ )
+ model.config.use_cache = False
+
+ logger.info(f"Loading SFT dataset from {data_args.data_path}")
+ raw_dataset = load_sft_dataset(data_args.data_path)
+ logger.info(f"Dataset loaded: {len(raw_dataset)} samples, columns: {raw_dataset.column_names}")
+
+ train_dataset = preprocess_sft_dataset(raw_dataset, tokenizer, data_args)
+ logger.info(f"Processed dataset: {len(train_dataset)} samples")
+
+ trainer = Trainer(
+ model=model,
+ args=training_args,
+ train_dataset=train_dataset,
+ data_collator=SFTDataCollator(tokenizer),
+ )
+
+ logger.info("Starting SFT training...")
+ train_result = trainer.train(
+ resume_from_checkpoint=training_args.resume_from_checkpoint
+ )
+
+ trainer.save_model()
+ trainer.save_state()
+
+ metrics = train_result.metrics
+ metrics["train_samples"] = len(train_dataset)
+ trainer.log_metrics("train", metrics)
+ trainer.save_metrics("train", metrics)
+
+
+if __name__ == "__main__":
+ main()
diff --git a/generation_config.json b/generation_config.json
new file mode 100644
index 0000000..cf2547d
--- /dev/null
+++ b/generation_config.json
@@ -0,0 +1,12 @@
+{
+ "bos_token_id": 1,
+ "do_sample": true,
+ "eos_token_id": [
+ 2,
+ 73440
+ ],
+ "pad_token_id": 2,
+ "temperature": 0.8,
+ "top_p": 0.8,
+ "transformers_version": "4.46.1"
+}
diff --git a/modeling_minicpm.py b/modeling_minicpm.py
new file mode 100644
index 0000000..c1de2b8
--- /dev/null
+++ b/modeling_minicpm.py
@@ -0,0 +1,1615 @@
+# coding=utf-8
+# Copyright 2025 The OpenBMB Team. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+""" PyTorch MiniCPM model."""
+import math
+import re
+import warnings
+from typing import Any, Dict, List, Optional, Tuple, Union
+
+import torch
+import torch.nn.functional as F
+import torch.utils.checkpoint
+from torch import nn
+from torch.nn import BCEWithLogitsLoss, CrossEntropyLoss, MSELoss
+from transformers.activations import ACT2FN
+from transformers.cache_utils import Cache, DynamicCache
+from transformers.modeling_attn_mask_utils import (
+ AttentionMaskConverter,
+ _prepare_4d_attention_mask,
+ _prepare_4d_causal_attention_mask,
+ _prepare_4d_causal_attention_mask_for_sdpa,
+)
+from transformers.modeling_outputs import (
+ BaseModelOutputWithPast,
+ CausalLMOutputWithPast,
+ SequenceClassifierOutputWithPast,
+)
+from transformers.modeling_utils import PreTrainedModel
+from transformers.pytorch_utils import ALL_LAYERNORM_LAYERS, is_torch_greater_or_equal_than_1_13
+from transformers.utils import (
+ add_start_docstrings,
+ add_start_docstrings_to_model_forward,
+ is_flash_attn_greater_or_equal_2_10,
+ logging,
+ replace_return_docstrings,
+)
+from transformers.utils.import_utils import is_torch_fx_available
+
+from .configuration_minicpm import MiniCPMConfig
+
+try:
+ from flash_attn import flash_attn_func, flash_attn_varlen_func
+ from flash_attn.bert_padding import index_first_axis, pad_input, unpad_input # noqa
+except:
+ pass
+
+
+
+# This makes `_prepare_4d_causal_attention_mask` a leaf function in the FX graph.
+# It means that the function will not be traced through and simply appear as a node in the graph.
+if is_torch_fx_available():
+ if not is_torch_greater_or_equal_than_1_13:
+ import torch.fx
+
+ _prepare_4d_causal_attention_mask = torch.fx.wrap(_prepare_4d_causal_attention_mask)
+
+
+logger = logging.get_logger(__name__)
+
+_CONFIG_FOR_DOC = 'MiniCPMConfig'
+
+
+
+def get_quantizer(quant_type="none", bit=4, group_size=128):
+ if quant_type == "intsym":
+ return SteIntSymQuantizerGPTQ(bit, group_size)
+ elif quant_type == "ternary":
+ return SteTernaryQuantizer(group_size)
+ elif quant_type == "none":
+ return NoQuantizer()
+ else:
+ raise ValueError(f"Unsupported quantization type: {quant_type}")
+
+class SteIntSymQuantizerGPTQ(nn.Module):
+ def __init__(self, bit=4, group_size=-1):
+ super().__init__()
+ self.bit = bit
+ self.group_size = group_size
+
+ def forward(self, x):
+ org_w_shape = x.shape
+
+ if self.group_size > 0:
+ assert org_w_shape[-1] % self.group_size == 0
+ x = x.reshape(-1, self.group_size)
+ elif self.group_size == -1:
+ assert org_w_shape[-1] % self.group_size == 0
+ x = x.reshape(-1, x.shape[-1])
+ elif self.group_size == 0:
+ x = x.reshape(1, -1)
+
+ assert x.dim() == 2
+
+ xmax = x.max(dim=1, keepdim=True)[0]
+ xmin = x.min(dim=1, keepdim=True)[0]
+ abs_max_val = torch.maximum(torch.abs(xmin), xmax) # 与Quantizer的xmax计算一致
+ scales = abs_max_val * 2 / (2 ** self.bit - 1) # 分子分母都对齐
+
+ max_int = 2 ** (self.bit - 1) - 1
+ min_int = - (2 ** (self.bit - 1))
+
+ assert torch.isnan(scales).sum() == 0
+
+ x_q = (torch.clamp(torch.round(x / scales), min_int, max_int)) * scales
+
+ assert torch.isnan(x_q).sum() == 0
+
+ x = x.reshape(org_w_shape)
+ x_q = x_q.reshape(org_w_shape)
+
+ return x + (x_q - x).detach()
+
+class SteTernaryQuantizer(nn.Module):
+ def __init__(self, group_size):
+ super().__init__()
+ self.group_size = group_size
+
+ def forward(self, x):
+ org_w_shape = x.shape
+ if self.group_size > 0:
+ assert x.shape[-1] % self.group_size == 0
+ x = x.reshape(-1, self.group_size)
+ elif self.group_size == -1:
+ x = x.reshape(-1, x.shape[-1])
+
+ assert x.dim() == 2
+
+ scales = 1.0 / (x.abs().mean(dim=1, keepdim=True).clamp_(min=1e-5))
+ x_q = (torch.clamp(torch.round(x * scales),-1,1) / scales)
+
+ assert torch.isnan(x_q).sum() == 0
+
+ x = x.reshape(org_w_shape)
+ x_q = x_q.reshape(org_w_shape)
+
+ return x + (x_q - x).detach()
+
+class NoQuantizer(nn.Module):
+ def __init__(self):
+ super().__init__()
+
+ def forward(self, x):
+ return x
+
+class LinearQuantizer(nn.Linear):
+ def __init__(self, in_features, out_features, bias=False, quant_type="ternary", bit=4, group_size=-1):
+ super().__init__(in_features, out_features, bias)
+ self.quantizer = get_quantizer(quant_type, bit, group_size)
+
+ def forward(self, x):
+ weight_tensor = self.quantizer(self.weight)
+ x = torch.nn.functional.linear(x, weight_tensor)
+ if self.bias is not None:
+ x = x + self.bias
+ return x
+
+def _get_unpad_data(attention_mask):
+ seqlens_in_batch = attention_mask.sum(dim=-1, dtype=torch.int32)
+ indices = torch.nonzero(attention_mask.flatten(), as_tuple=False).flatten()
+ max_seqlen_in_batch = seqlens_in_batch.max().item()
+ cu_seqlens = F.pad(torch.cumsum(seqlens_in_batch, dim=0, dtype=torch.torch.int32), (1, 0))
+ return (
+ indices,
+ cu_seqlens,
+ max_seqlen_in_batch,
+ )
+
+
+
+
+# @torch.jit.script # type: ignore
+def rms_layernorm(hidden: torch.Tensor, weight: torch.Tensor, eps: float):
+ old_dtype = hidden.dtype
+ variance = hidden.to(torch.float32).pow(2).mean(dim=-1, keepdim=True)
+ hidden = (hidden * torch.rsqrt(variance + eps)).to(old_dtype)
+ return hidden * weight
+
+
+class MiniCPMRMSNorm(nn.Module):
+ def __init__(self, hidden_size, eps=1e-6):
+ """
+ MiniCPMRMSNorm is equivalent to T5LayerNorm
+ """
+ super().__init__()
+ self.weight = nn.Parameter(torch.ones(hidden_size))
+ self.variance_epsilon = eps
+
+ def forward(self, hidden_states):
+ return rms_layernorm(hidden_states, self.weight, self.variance_epsilon)
+
+
+ALL_LAYERNORM_LAYERS.append(MiniCPMRMSNorm)
+
+
+class MiniCPMRotaryEmbedding(nn.Module):
+ def __init__(self, dim, max_position_embeddings=2048, base=10000, device=None):
+ super().__init__()
+
+ self.dim = dim
+ self.max_position_embeddings = max_position_embeddings
+ self.base = base
+ inv_freq = 1.0 / (self.base ** (torch.arange(0, self.dim, 2).float().to(device) / self.dim))
+ self.register_buffer('inv_freq', inv_freq, persistent=False)
+
+ # Build here to make `torch.jit.trace` work.
+ self._set_cos_sin_cache(
+ # seq_len=max_position_embeddings, device=self.inv_freq.device, dtype=torch.get_default_dtype()
+ seq_len=max_position_embeddings, device=self.inv_freq.device, dtype=torch.float32
+ )
+
+ def _set_cos_sin_cache(self, seq_len, device, dtype):
+ self.max_seq_len_cached = seq_len
+ t = torch.arange(self.max_seq_len_cached, device=device, dtype=self.inv_freq.dtype)
+ freqs = torch.outer(t, self.inv_freq)
+ # Different from paper, but it uses a different permutation in order to obtain the same calculation
+ emb = torch.cat((freqs, freqs), dim=-1)
+
+ self.register_buffer('cos_cached', emb.cos().to(dtype), persistent=False)
+ self.register_buffer('sin_cached', emb.sin().to(dtype), persistent=False)
+
+ def forward(self, x, seq_len=None):
+ # x: [bs, num_attention_heads, seq_len, head_size]
+ if seq_len > self.max_seq_len_cached:
+ self._set_cos_sin_cache(seq_len=seq_len, device=x.device, dtype=x.dtype)
+
+ return (
+ self.cos_cached[:seq_len].to(dtype=x.dtype),
+ self.sin_cached[:seq_len].to(dtype=x.dtype),
+ )
+
+
+class MiniCPMLongRoPE(MiniCPMRotaryEmbedding):
+ """MiniCPMRotaryEmbedding extended with Dynamic NTK scaling. Credits to the Reddit users /u/bloc97 and /u/emozilla"""
+
+ def __init__(self, dim, max_position_embeddings=2048, base=10000, device=None, short_factor=None, long_factor=None, original_max_position_embeddings=None):
+ self.short_factor = short_factor
+ self.long_factor = long_factor
+ self.original_max_position_embeddings = original_max_position_embeddings
+ scale = (max_position_embeddings / self.original_max_position_embeddings)
+ self.scaling_factor = math.sqrt(1 + math.log(scale) / math.log(self.original_max_position_embeddings))
+ super().__init__(dim, max_position_embeddings, base, device)
+
+ def _set_cos_sin_cache(self, seq_len, device, dtype):
+ self.max_seq_len_cached = seq_len
+ t = torch.arange(self.max_seq_len_cached, device=device, dtype=self.inv_freq.dtype)
+ if seq_len > self.original_max_position_embeddings:
+ ext_factors = torch.tensor(self.long_factor, dtype=torch.float32, device=device)
+ else:
+ ext_factors = torch.tensor(self.short_factor, dtype=torch.float32, device=device)
+
+ freqs = torch.mul(
+ torch.outer(t, 1.0 / ext_factors).to(device=device),
+ self.inv_freq.to(device=device).to(dtype)
+ )
+ # Different from paper, but it uses a different permutation in order to obtain the same calculation
+ emb = torch.cat((freqs, freqs), dim=-1)
+ self.register_buffer('cos_cached', emb.cos().to(dtype) * self.scaling_factor, persistent=False)
+ self.register_buffer('sin_cached', emb.sin().to(dtype) * self.scaling_factor, persistent=False)
+
+
+class MiniCPMLinearScalingRotaryEmbedding(MiniCPMRotaryEmbedding):
+ """MiniCPMRotaryEmbedding extended with linear scaling. Credits to the Reddit user /u/kaiokendev"""
+
+ def __init__(self, dim, max_position_embeddings=2048, base=10000, device=None, scaling_factor=1.0):
+ self.scaling_factor = scaling_factor
+ super().__init__(dim, max_position_embeddings, base, device)
+
+ def _set_cos_sin_cache(self, seq_len, device, dtype):
+ self.max_seq_len_cached = seq_len
+ t = torch.arange(self.max_seq_len_cached, device=device, dtype=self.inv_freq.dtype)
+ t = t / self.scaling_factor
+
+ freqs = torch.outer(t, self.inv_freq)
+ # Different from paper, but it uses a different permutation in order to obtain the same calculation
+ emb = torch.cat((freqs, freqs), dim=-1)
+ self.register_buffer('cos_cached', emb.cos().to(dtype), persistent=False)
+ self.register_buffer('sin_cached', emb.sin().to(dtype), persistent=False)
+
+
+class MiniCPMDynamicNTKScalingRotaryEmbedding(MiniCPMRotaryEmbedding):
+ """MiniCPMRotaryEmbedding extended with Dynamic NTK scaling. Credits to the Reddit users /u/bloc97 and /u/emozilla"""
+
+ def __init__(self, dim, max_position_embeddings=2048, base=10000, device=None, scaling_factor=1.0):
+ self.scaling_factor = scaling_factor
+ super().__init__(dim, max_position_embeddings, base, device)
+
+ def _set_cos_sin_cache(self, seq_len, device, dtype):
+ self.max_seq_len_cached = seq_len
+
+ if seq_len > self.max_position_embeddings:
+ base = self.base * (
+ (self.scaling_factor * seq_len / self.max_position_embeddings) - (self.scaling_factor - 1)
+ ) ** (self.dim / (self.dim - 2))
+ inv_freq = 1.0 / (base ** (torch.arange(0, self.dim, 2).float().to(device) / self.dim))
+ self.register_buffer('inv_freq', inv_freq, persistent=False)
+
+ t = torch.arange(self.max_seq_len_cached, device=device, dtype=self.inv_freq.dtype)
+
+ freqs = torch.outer(t, self.inv_freq)
+ # Different from paper, but it uses a different permutation in order to obtain the same calculation
+ emb = torch.cat((freqs, freqs), dim=-1)
+
+ self.register_buffer('cos_cached', emb.cos().to(dtype), persistent=False)
+ self.register_buffer('sin_cached', emb.sin().to(dtype), persistent=False)
+
+
+def rotate_half(x):
+ """Rotates half the hidden dims of the input."""
+ x1 = x[..., : x.shape[-1] // 2]
+ x2 = x[..., x.shape[-1] // 2:]
+ return torch.cat((-x2, x1), dim=-1)
+
+
+def apply_rotary_pos_emb(q, k, cos, sin, position_ids, unsqueeze_dim=1):
+ """Applies Rotary Position Embedding to the query and key tensors.
+
+ Args:
+ q (`torch.Tensor`): The query tensor.
+ k (`torch.Tensor`): The key tensor.
+ cos (`torch.Tensor`): The cosine part of the rotary embedding.
+ sin (`torch.Tensor`): The sine part of the rotary embedding.
+ position_ids (`torch.Tensor`):
+ The position indices of the tokens corresponding to the query and key tensors. For example, this can be
+ used to pass offsetted position ids when working with a KV-cache.
+ unsqueeze_dim (`int`, *optional*, defaults to 1):
+ The 'unsqueeze_dim' argument specifies the dimension along which to unsqueeze cos[position_ids] and
+ sin[position_ids] so that they can be properly broadcasted to the dimensions of q and k. For example, note
+ that cos[position_ids] and sin[position_ids] have the shape [batch_size, seq_len, head_dim]. Then, if q and
+ k have the shape [batch_size, heads, seq_len, head_dim], then setting unsqueeze_dim=1 makes
+ cos[position_ids] and sin[position_ids] broadcastable to the shapes of q and k. Similarly, if q and k have
+ the shape [batch_size, seq_len, heads, head_dim], then set unsqueeze_dim=2.
+ Returns:
+ `tuple(torch.Tensor)` comprising of the query and key tensors rotated using the Rotary Position Embedding.
+ """
+ # cos = cos[position_ids].unsqueeze(unsqueeze_dim)
+ # sin = sin[position_ids].unsqueeze(unsqueeze_dim)
+ # q_embed = (q * cos) + (rotate_half(q) * sin)
+ # k_embed = (k * cos) + (rotate_half(k) * sin)
+ orig_dtype = k.dtype
+ cos = cos[position_ids].unsqueeze(unsqueeze_dim) # [bs, 1, seq_len, dim]
+ sin = sin[position_ids].unsqueeze(unsqueeze_dim) # [bs, 1, seq_len, dim]
+ q_fp32 = q.to(dtype=torch.float32, device=q.device)
+ k_fp32 = k.to(dtype=torch.float32, device=k.device)
+ q_embed = (q_fp32 * cos) + (rotate_half(q_fp32) * sin)
+ k_embed = (k_fp32 * cos) + (rotate_half(k_fp32) * sin)
+ return q_embed.to(dtype=orig_dtype), k_embed.to(dtype=orig_dtype)
+
+
+class MiniCPMMLP(nn.Module):
+ def __init__(self, config):
+ super().__init__()
+ self.config = config
+ self.hidden_size = config.hidden_size
+ self.intermediate_size = config.intermediate_size
+ # self.gate_proj = nn.Linear(self.hidden_size, self.intermediate_size, bias=False)
+ # self.up_proj = nn.Linear(self.hidden_size, self.intermediate_size, bias=False)
+ # self.down_proj = nn.Linear(self.intermediate_size, self.hidden_size, bias=False)
+ self.gate_proj = LinearQuantizer(self.hidden_size, self.intermediate_size, bias=False, quant_type="ternary", bit=4, group_size=-1)
+ self.up_proj = LinearQuantizer(self.hidden_size, self.intermediate_size, bias=False, quant_type="ternary", bit=4, group_size=-1)
+ self.down_proj = LinearQuantizer(self.intermediate_size, self.hidden_size, bias=False, quant_type="ternary", bit=4, group_size=-1)
+ self.act_fn = ACT2FN[config.hidden_act]
+
+ def forward(self, x):
+ if self.config.pretraining_tp > 1:
+ slice = self.intermediate_size // self.config.pretraining_tp
+ gate_proj_slices = self.gate_proj.weight.split(slice, dim=0)
+ up_proj_slices = self.up_proj.weight.split(slice, dim=0)
+ down_proj_slices = self.down_proj.weight.split(slice, dim=1)
+
+ gate_proj = torch.cat(
+ [F.linear(x, gate_proj_slices[i]) for i in range(self.config.pretraining_tp)], dim=-1
+ )
+ up_proj = torch.cat([F.linear(x, up_proj_slices[i]) for i in range(self.config.pretraining_tp)], dim=-1)
+
+ intermediate_states = (self.act_fn(gate_proj) * up_proj).split(slice, dim=2)
+ down_proj = [
+ F.linear(intermediate_states[i], down_proj_slices[i]) for i in range(self.config.pretraining_tp)
+ ]
+ down_proj = sum(down_proj)
+ else:
+ down_proj = self.down_proj(self.act_fn(self.gate_proj(x)) * self.up_proj(x))
+
+ return down_proj
+
+def _unpad_one_tensor(hidden_states, attention_mask):
+ # Unpad the hidden states using the indices
+ indices, cu_seqlens, max_seqlen_in_batch = _get_unpad_data(attention_mask)
+ batch_size, seq_len = hidden_states.shape[:2]
+
+ # Get the remaining dimensions
+ remaining_dims = hidden_states.shape[2:]
+
+ # Reshape to (batch_size * seq_len, *remaining_dims)
+ reshaped_states = hidden_states.reshape(batch_size * seq_len, *remaining_dims)
+
+ # Apply unpadding using indices
+ unpadded_states = index_first_axis(reshaped_states, indices)
+
+ return unpadded_states, indices, cu_seqlens, max_seqlen_in_batch
+
+def repeat_kv(hidden_states: torch.Tensor, n_rep: int) -> torch.Tensor:
+ """
+ This is the equivalent of torch.repeat_interleave(x, dim=1, repeats=n_rep). The hidden states go from (batch,
+ num_key_value_heads, seqlen, head_dim) to (batch, num_attention_heads, seqlen, head_dim)
+ """
+ batch, num_key_value_heads, slen, head_dim = hidden_states.shape
+ if n_rep == 1:
+ return hidden_states
+ hidden_states = hidden_states[:, :, None, :, :].expand(batch, num_key_value_heads, n_rep, slen, head_dim)
+ return hidden_states.reshape(batch, num_key_value_heads * n_rep, slen, head_dim)
+
+
+class MiniCPMAttention(nn.Module):
+ """Multi-headed attention from 'Attention Is All You Need' paper"""
+
+ def __init__(self, config: MiniCPMConfig, layer_idx: Optional[int] = None):
+ super().__init__()
+ self.config = config
+ self.layer_idx = layer_idx
+ if layer_idx is None:
+ logger.warning_once(
+ f'Instantiating {self.__class__.__name__} without passing `layer_idx` is not recommended and will '
+ 'to errors during the forward call, if caching is used. Please make sure to provide a `layer_idx` '
+ 'when creating this class.'
+ )
+
+ self.attention_dropout = config.attention_dropout
+ self.hidden_size = config.hidden_size
+ self.num_heads = config.num_attention_heads
+ self.head_dim = self.hidden_size // self.num_heads
+ self.num_key_value_heads = config.num_key_value_heads
+ self.num_key_value_groups = self.num_heads // self.num_key_value_heads
+ self.max_position_embeddings = config.max_position_embeddings
+ self.rope_theta = config.rope_theta
+ self.is_causal = True
+
+ if (self.head_dim * self.num_heads) != self.hidden_size:
+ raise ValueError(
+ f'hidden_size must be divisible by num_heads (got `hidden_size`: {self.hidden_size}'
+ f' and `num_heads`: {self.num_heads}).'
+ )
+
+ # self.q_proj = nn.Linear(self.hidden_size, self.num_heads * self.head_dim, bias=config.attention_bias)
+ # self.k_proj = nn.Linear(self.hidden_size, self.num_key_value_heads * self.head_dim, bias=config.attention_bias)
+ # self.v_proj = nn.Linear(self.hidden_size, self.num_key_value_heads * self.head_dim, bias=config.attention_bias)
+ # self.o_proj = nn.Linear(self.num_heads * self.head_dim, self.hidden_size, bias=config.attention_bias)
+ self.q_proj = LinearQuantizer(self.hidden_size, self.num_heads * self.head_dim, bias=config.attention_bias, quant_type="ternary", bit=4, group_size=-1)
+ self.k_proj = LinearQuantizer(self.hidden_size, self.num_key_value_heads * self.head_dim, bias=config.attention_bias, quant_type="ternary", bit=4, group_size=-1)
+ self.v_proj = LinearQuantizer(self.hidden_size, self.num_key_value_heads * self.head_dim, bias=config.attention_bias, quant_type="ternary", bit=4, group_size=-1)
+ self.o_proj = LinearQuantizer(self.num_heads * self.head_dim, self.hidden_size, bias=config.attention_bias, quant_type="ternary", bit=4, group_size=-1)
+ self._init_rope()
+
+ def _init_rope(self):
+ if self.config.rope_scaling is None:
+ self.rotary_emb = MiniCPMRotaryEmbedding(
+ self.head_dim,
+ max_position_embeddings=self.max_position_embeddings,
+ base=self.rope_theta,
+ )
+ else:
+ scaling_type = self.config.rope_scaling['rope_type']
+ scaling_factor = self.config.rope_scaling.get('factor', None)
+ if scaling_type == 'linear':
+ self.rotary_emb = MiniCPMLinearScalingRotaryEmbedding(
+ self.head_dim,
+ max_position_embeddings=self.max_position_embeddings,
+ scaling_factor=scaling_factor,
+ base=self.rope_theta,
+ )
+ elif scaling_type == 'dynamic':
+ self.rotary_emb = MiniCPMDynamicNTKScalingRotaryEmbedding(
+ self.head_dim,
+ max_position_embeddings=self.max_position_embeddings,
+ scaling_factor=scaling_factor,
+ base=self.rope_theta,
+ )
+ elif scaling_type == 'longrope':
+ self.rotary_emb = MiniCPMLongRoPE(
+ self.head_dim,
+ max_position_embeddings=self.max_position_embeddings,
+ short_factor=self.config.rope_scaling['short_factor'],
+ long_factor=self.config.rope_scaling['long_factor'],
+ base=self.rope_theta,
+ original_max_position_embeddings=self.config.rope_scaling['original_max_position_embeddings']
+ )
+ else:
+ raise ValueError(f'Unknown RoPE scaling type {scaling_type}')
+
+ def _shape(self, tensor: torch.Tensor, seq_len: int, bsz: int):
+ return tensor.view(bsz, seq_len, self.num_heads, self.head_dim).transpose(1, 2).contiguous()
+
+ def forward(
+ self,
+ hidden_states: torch.Tensor,
+ attention_mask: Optional[torch.Tensor] = None,
+ position_ids: Optional[torch.LongTensor] = None,
+ past_key_value: Optional[Cache] = None,
+ output_attentions: bool = False,
+ use_cache: bool = False,
+ **kwargs,
+ ) -> Tuple[torch.Tensor, Optional[torch.Tensor], Optional[Tuple[torch.Tensor]]]:
+ if 'padding_mask' in kwargs:
+ warnings.warn(
+ 'Passing `padding_mask` is deprecated and will be removed in v4.37. Please make sure use `attention_mask` instead.`'
+ )
+
+ bsz, q_len, _ = hidden_states.size()
+
+ if self.config.pretraining_tp > 1:
+ key_value_slicing = (self.num_key_value_heads * self.head_dim) // self.config.pretraining_tp
+ query_slices = self.q_proj.weight.split(
+ (self.num_heads * self.head_dim) // self.config.pretraining_tp, dim=0
+ )
+ key_slices = self.k_proj.weight.split(key_value_slicing, dim=0)
+ value_slices = self.v_proj.weight.split(key_value_slicing, dim=0)
+
+ query_states = [F.linear(hidden_states, query_slices[i]) for i in range(self.config.pretraining_tp)]
+ query_states = torch.cat(query_states, dim=-1)
+
+ key_states = [F.linear(hidden_states, key_slices[i]) for i in range(self.config.pretraining_tp)]
+ key_states = torch.cat(key_states, dim=-1)
+
+ value_states = [F.linear(hidden_states, value_slices[i]) for i in range(self.config.pretraining_tp)]
+ value_states = torch.cat(value_states, dim=-1)
+
+ else:
+ query_states = self.q_proj(hidden_states)
+ key_states = self.k_proj(hidden_states)
+ value_states = self.v_proj(hidden_states)
+
+ query_states = query_states.view(bsz, q_len, self.num_heads, self.head_dim).transpose(1, 2)
+ key_states = key_states.view(bsz, q_len, self.num_key_value_heads, self.head_dim).transpose(1, 2)
+ value_states = value_states.view(bsz, q_len, self.num_key_value_heads, self.head_dim).transpose(1, 2)
+
+ kv_seq_len = position_ids.max().item() + 1
+ cos, sin = self.rotary_emb(value_states.to(torch.float32), seq_len=kv_seq_len)
+
+ query_states, key_states = apply_rotary_pos_emb(query_states, key_states, cos, sin, position_ids)
+
+ if past_key_value is not None:
+ cache_kwargs = {'sin': sin, 'cos': cos} # Specific to RoPE models
+ key_states, value_states = past_key_value.update(key_states, value_states, self.layer_idx, cache_kwargs)
+
+ key_states = repeat_kv(key_states, self.num_key_value_groups)
+ value_states = repeat_kv(value_states, self.num_key_value_groups)
+
+ attn_weights = torch.matmul(query_states, key_states.transpose(2, 3)) / math.sqrt(self.head_dim)
+ if attn_weights.size() != (bsz, self.num_heads, q_len, kv_seq_len):
+ raise ValueError(
+ f'Attention weights should be of size {(bsz, self.num_heads, q_len, kv_seq_len)}, but is'
+ f' {attn_weights.size()}'
+ )
+
+ if attention_mask is not None:
+ if attention_mask.size() != (bsz, 1, q_len, kv_seq_len):
+ raise ValueError(
+ f'Attention mask should be of size {(bsz, 1, q_len, kv_seq_len)}, but is {attention_mask.size()}'
+ )
+ attn_weights = attn_weights + attention_mask
+
+ # upcast attention to fp32
+ attn_weights = nn.functional.softmax(attn_weights, dim=-1, dtype=torch.float32).to(query_states.dtype)
+ attn_weights = nn.functional.dropout(attn_weights, p=self.attention_dropout, training=self.training)
+ attn_output = torch.matmul(attn_weights, value_states)
+
+ if attn_output.size() != (bsz, self.num_heads, q_len, self.head_dim):
+ raise ValueError(
+ f'`attn_output` should be of size {(bsz, self.num_heads, q_len, self.head_dim)}, but is'
+ f' {attn_output.size()}'
+ )
+
+ attn_output = attn_output.transpose(1, 2).contiguous()
+
+ attn_output = attn_output.reshape(bsz, q_len, self.hidden_size)
+
+ if self.config.pretraining_tp > 1:
+ attn_output = attn_output.split(self.hidden_size // self.config.pretraining_tp, dim=2)
+ o_proj_slices = self.o_proj.weight.split(self.hidden_size // self.config.pretraining_tp, dim=1)
+ attn_output = sum([F.linear(attn_output[i], o_proj_slices[i]) for i in range(self.config.pretraining_tp)])
+ else:
+ attn_output = self.o_proj(attn_output)
+
+ if not output_attentions:
+ attn_weights = None
+
+ return attn_output, attn_weights, past_key_value
+
+
+class MiniCPMFlashAttention2(MiniCPMAttention):
+ """
+ MiniCPM flash attention module. This module inherits from `MiniCPMAttention` as the weights of the module stays
+ untouched. The only required change would be on the forward pass where it needs to correctly call the public API of
+ flash attention and deal with padding tokens in case the input contains any of them.
+ """
+
+ def __init__(self, *args, **kwargs):
+ super().__init__(*args, **kwargs)
+ # TODO: Should be removed once Flash Attention for RoCm is bumped to 2.1.
+ # flash_attn<2.1 generates top-left aligned causal mask, while what is needed here is bottom-right alignment, that was made default for flash_attn>=2.1. This attribute is used to handle this difference. Reference: https://github.com/Dao-AILab/flash-attention/releases/tag/v2.1.0.
+ # Beware that with flash_attn<2.1, using q_seqlen != k_seqlen (except for the case q_seqlen == 1) produces a wrong mask (top-left).
+ self._flash_attn_uses_top_left_mask = not is_flash_attn_greater_or_equal_2_10()
+
+ def forward(
+ self,
+ hidden_states: torch.Tensor,
+ attention_mask: Optional[torch.LongTensor] = None,
+ position_ids: Optional[torch.LongTensor] = None,
+ past_key_value: Optional[Cache] = None,
+ output_attentions: bool = False,
+ use_cache: bool = False,
+ **kwargs,
+ ) -> Tuple[torch.Tensor, Optional[torch.Tensor], Optional[Tuple[torch.Tensor]]]:
+ # MiniCPMFlashAttention2 attention does not support output_attentions
+ if 'padding_mask' in kwargs:
+ warnings.warn(
+ 'Passing `padding_mask` is deprecated and will be removed in v4.37. Please make sure use `attention_mask` instead.`'
+ )
+
+ # overwrite attention_mask with padding_mask
+ attention_mask = kwargs.pop('padding_mask')
+
+ output_attentions = False
+
+ bsz, q_len, _ = hidden_states.size()
+
+ query_states = self.q_proj(hidden_states)
+ key_states = self.k_proj(hidden_states)
+ value_states = self.v_proj(hidden_states)
+
+ # Flash attention requires the input to have the shape
+ # batch_size x seq_length x head_dim x hidden_dim
+ # therefore we just need to keep the original shape
+ query_states = query_states.view(bsz, q_len, self.num_heads, self.head_dim).transpose(1, 2)
+ key_states = key_states.view(bsz, q_len, self.num_key_value_heads, self.head_dim).transpose(1, 2)
+ value_states = value_states.view(bsz, q_len, self.num_key_value_heads, self.head_dim).transpose(1, 2)
+
+ kv_seq_len = position_ids.max().item() + 1
+ cos, sin = self.rotary_emb(value_states.to(torch.float32), seq_len=kv_seq_len)
+ query_states, key_states = apply_rotary_pos_emb(query_states, key_states, cos, sin, position_ids)
+
+ if past_key_value is not None:
+ cache_kwargs = {'sin': sin, 'cos': cos} # Specific to RoPE models
+ key_states, value_states = past_key_value.update(key_states, value_states, self.layer_idx, cache_kwargs)
+
+ # TODO: These transpose are quite inefficient but Flash Attention requires the layout [batch_size, sequence_length, num_heads, head_dim]. We would need to refactor the KV cache
+ # to be able to avoid many of these transpose/reshape/view.
+ query_states = query_states.transpose(1, 2)
+ key_states = key_states.transpose(1, 2)
+ value_states = value_states.transpose(1, 2)
+
+ dropout_rate = self.attention_dropout if self.training else 0.0
+
+ # In PEFT, usually we cast the layer norms in float32 for training stability reasons
+ # therefore the input hidden states gets silently casted in float32. Hence, we need
+ # cast them back in the correct dtype just to be sure everything works as expected.
+ # This might slowdown training & inference so it is recommended to not cast the LayerNorms
+ # in fp32. (MiniCPMRMSNorm handles it correctly)
+
+ input_dtype = query_states.dtype
+ if input_dtype == torch.float32:
+ # Handle the case where the model is quantized
+ if hasattr(self.config, '_pre_quantization_dtype'):
+ target_dtype = self.config._pre_quantization_dtype
+ else:
+ target_dtype = self.q_proj.weight.dtype
+
+ logger.warning_once(
+ f'The input hidden states seems to be silently casted in float32, this might be related to'
+ f' the fact you have upcasted embedding or layer norm layers in float32. We will cast back the input in'
+ f' {target_dtype}.'
+ )
+
+ query_states = query_states.to(target_dtype)
+ key_states = key_states.to(target_dtype)
+ value_states = value_states.to(target_dtype)
+
+ attn_output = self._flash_attention_forward(
+ query_states, key_states, value_states, attention_mask, q_len, dropout=dropout_rate
+ )
+
+ attn_output = attn_output.reshape(bsz, q_len, self.hidden_size).contiguous()
+ attn_output = self.o_proj(attn_output)
+
+ if not output_attentions:
+ attn_weights = None
+
+ return attn_output, attn_weights, past_key_value
+
+ def _flash_attention_forward(
+ self, query_states, key_states, value_states, attention_mask, query_length, dropout=0.0, softmax_scale=None
+ ):
+ """
+ Calls the forward method of Flash Attention - if the input hidden states contain at least one padding token
+ first unpad the input, then computes the attention scores and pad the final attention scores.
+
+ Args:
+ query_states (`torch.Tensor`):
+ Input query states to be passed to Flash Attention API
+ key_states (`torch.Tensor`):
+ Input key states to be passed to Flash Attention API
+ value_states (`torch.Tensor`):
+ Input value states to be passed to Flash Attention API
+ attention_mask (`torch.Tensor`):
+ The padding mask - corresponds to a tensor of size `(batch_size, seq_len)` where 0 stands for the
+ position of padding tokens and 1 for the position of non-padding tokens.
+ dropout (`int`, *optional*):
+ Attention dropout
+ softmax_scale (`float`, *optional*):
+ The scaling of QK^T before applying softmax. Default to 1 / sqrt(head_dim)
+ """
+ if not self._flash_attn_uses_top_left_mask:
+ causal = self.is_causal
+ else:
+ # TODO: Remove the `query_length != 1` check once Flash Attention for RoCm is bumped to 2.1. For details, please see the comment in MiniCPMFlashAttention2 __init__.
+ causal = self.is_causal and query_length != 1
+ # Contains at least one padding token in the sequence
+ if attention_mask is not None:
+ batch_size = query_states.shape[0]
+ query_states, key_states, value_states, indices_q, cu_seq_lens, max_seq_lens = self._upad_input(
+ query_states, key_states, value_states, attention_mask, query_length
+ )
+
+ cu_seqlens_q, cu_seqlens_k = cu_seq_lens
+ max_seqlen_in_batch_q, max_seqlen_in_batch_k = max_seq_lens
+ attn_output_unpad = flash_attn_varlen_func(
+ query_states,
+ key_states,
+ value_states,
+ cu_seqlens_q=cu_seqlens_q,
+ cu_seqlens_k=cu_seqlens_k,
+ max_seqlen_q=max_seqlen_in_batch_q,
+ max_seqlen_k=max_seqlen_in_batch_k,
+ dropout_p=dropout,
+ softmax_scale=softmax_scale,
+ causal=causal,
+ )
+
+ attn_output = pad_input(attn_output_unpad, indices_q, batch_size, query_length)
+ else:
+ attn_output = flash_attn_func(
+ query_states, key_states, value_states, dropout, softmax_scale=softmax_scale, causal=causal
+ )
+
+ return attn_output
+
+ def _upad_input(self, query_layer, key_layer, value_layer, attention_mask, query_length):
+ indices_k, cu_seqlens_k, max_seqlen_in_batch_k = _get_unpad_data(attention_mask)
+ batch_size, kv_seq_len, num_key_value_heads, head_dim = key_layer.shape
+
+ key_layer = index_first_axis(
+ key_layer.reshape(batch_size * kv_seq_len, num_key_value_heads, head_dim), indices_k
+ )
+ value_layer = index_first_axis(
+ value_layer.reshape(batch_size * kv_seq_len, num_key_value_heads, head_dim), indices_k
+ )
+ if query_length == kv_seq_len:
+ query_layer = index_first_axis(
+ query_layer.reshape(batch_size * kv_seq_len, self.num_heads, head_dim), indices_k
+ )
+ cu_seqlens_q = cu_seqlens_k
+ max_seqlen_in_batch_q = max_seqlen_in_batch_k
+ indices_q = indices_k
+ elif query_length == 1:
+ max_seqlen_in_batch_q = 1
+ cu_seqlens_q = torch.arange(
+ batch_size + 1, dtype=torch.int32, device=query_layer.device
+ ) # There is a memcpy here, that is very bad.
+ indices_q = cu_seqlens_q[:-1]
+ query_layer = query_layer.squeeze(1)
+ else:
+ # The -q_len: slice assumes left padding.
+ attention_mask = attention_mask[:, -query_length:]
+ query_layer, indices_q, cu_seqlens_q, max_seqlen_in_batch_q = unpad_input(query_layer, attention_mask)
+
+ return (
+ query_layer,
+ key_layer,
+ value_layer,
+ indices_q,
+ (cu_seqlens_q, cu_seqlens_k),
+ (max_seqlen_in_batch_q, max_seqlen_in_batch_k),
+ )
+
+
+class MiniCPMSdpaAttention(MiniCPMAttention):
+ """
+ MiniCPM attention module using torch.nn.functional.scaled_dot_product_attention. This module inherits from
+ `MiniCPMAttention` as the weights of the module stays untouched. The only changes are on the forward pass to adapt to
+ SDPA API.
+ """
+
+ # Adapted from MiniCPMAttention.forward
+ def forward(
+ self,
+ hidden_states: torch.Tensor,
+ attention_mask: Optional[torch.Tensor] = None,
+ position_ids: Optional[torch.LongTensor] = None,
+ past_key_value: Optional[Cache] = None,
+ output_attentions: bool = False,
+ use_cache: bool = False,
+ ) -> Tuple[torch.Tensor, Optional[torch.Tensor], Optional[Tuple[torch.Tensor]]]:
+ if output_attentions:
+ # TODO: Improve this warning with e.g. `model.config.attn_implementation = "manual"` once this is implemented.
+ logger.warning_once(
+ 'MiniCPMModel is using MiniCPMSdpaAttention, but `torch.nn.functional.scaled_dot_product_attention` does not support `output_attentions=True`. Falling back to the manual attention implementation, '
+ 'but specifying the manual implementation will be required from Transformers version v5.0.0 onwards. This warning can be removed using the argument `attn_implementation="eager"` when loading the model.'
+ )
+ return super().forward(
+ hidden_states=hidden_states,
+ attention_mask=attention_mask,
+ position_ids=position_ids,
+ past_key_value=past_key_value,
+ output_attentions=output_attentions,
+ use_cache=use_cache,
+ )
+
+ bsz, q_len, _ = hidden_states.size()
+
+ query_states = self.q_proj(hidden_states)
+ key_states = self.k_proj(hidden_states)
+ value_states = self.v_proj(hidden_states)
+
+ query_states = query_states.view(bsz, q_len, self.num_heads, self.head_dim).transpose(1, 2)
+ key_states = key_states.view(bsz, q_len, self.num_key_value_heads, self.head_dim).transpose(1, 2)
+ value_states = value_states.view(bsz, q_len, self.num_key_value_heads, self.head_dim).transpose(1, 2)
+
+ kv_seq_len = position_ids.max().item() + 1
+ cos, sin = self.rotary_emb(value_states, seq_len=kv_seq_len)
+
+ query_states, key_states = apply_rotary_pos_emb(query_states, key_states, cos, sin, position_ids)
+
+ if past_key_value is not None:
+ cache_kwargs = {'sin': sin, 'cos': cos} # Specific to RoPE models
+ key_states, value_states = past_key_value.update(key_states, value_states, self.layer_idx, cache_kwargs)
+
+ key_states = repeat_kv(key_states, self.num_key_value_groups)
+ value_states = repeat_kv(value_states, self.num_key_value_groups)
+
+ if attention_mask is not None:
+ if attention_mask.size() != (bsz, 1, q_len, kv_seq_len):
+ raise ValueError(
+ f'Attention mask should be of size {(bsz, 1, q_len, kv_seq_len)}, but is {attention_mask.size()}'
+ )
+
+ # SDPA with memory-efficient backend is currently (torch==2.1.2) bugged with non-contiguous inputs with custom attn_mask,
+ # Reference: https://github.com/pytorch/pytorch/issues/112577.
+ if query_states.device.type == 'cuda' and attention_mask is not None:
+ query_states = query_states.contiguous()
+ key_states = key_states.contiguous()
+ value_states = value_states.contiguous()
+
+ attn_output = torch.nn.functional.scaled_dot_product_attention(
+ query_states,
+ key_states,
+ value_states,
+ attn_mask=attention_mask,
+ dropout_p=self.attention_dropout if self.training else 0.0,
+ # The q_len > 1 is necessary to match with AttentionMaskConverter.to_causal_4d that does not create a causal mask in case q_len == 1.
+ is_causal=self.is_causal and attention_mask is None and q_len > 1,
+ )
+
+ attn_output = attn_output.transpose(1, 2).contiguous()
+ attn_output = attn_output.reshape(bsz, q_len, self.hidden_size)
+
+ attn_output = self.o_proj(attn_output)
+
+ return attn_output, None, past_key_value
+
+
+MINICPM_ATTENTION_CLASSES = {
+ 'eager': MiniCPMAttention,
+ 'flash_attention_2': MiniCPMFlashAttention2,
+ 'sdpa': MiniCPMSdpaAttention,
+}
+
+
+class MiniCPMDecoderLayer(nn.Module):
+ def __init__(self, config: MiniCPMConfig, layer_idx: int):
+ super().__init__()
+ self.hidden_size = config.hidden_size
+ self.self_attn = MINICPM_ATTENTION_CLASSES[config._attn_implementation](config=config, layer_idx=layer_idx)
+
+ self.mlp = MiniCPMMLP(config)
+ self.input_layernorm = MiniCPMRMSNorm(config.hidden_size, eps=config.rms_norm_eps)
+ self.post_attention_layernorm = MiniCPMRMSNorm(config.hidden_size, eps=config.rms_norm_eps)
+
+ self.scale_depth = config.scale_depth
+ self.num_hidden_layers = config.num_hidden_layers
+
+ def forward(
+ self,
+ hidden_states: torch.Tensor,
+ attention_mask: Optional[torch.Tensor] = None,
+ position_ids: Optional[torch.LongTensor] = None,
+ past_key_value: Optional[Tuple[torch.Tensor]] = None,
+ output_attentions: Optional[bool] = False,
+ use_cache: Optional[bool] = False,
+ **kwargs,
+ ) -> Tuple[torch.FloatTensor, Optional[Tuple[torch.FloatTensor, torch.FloatTensor]]]:
+ """
+ Args:
+ hidden_states (`torch.FloatTensor`): input to the layer of shape `(batch, seq_len, embed_dim)`
+ attention_mask (`torch.FloatTensor`, *optional*):
+ attention mask of size `(batch_size, sequence_length)` if flash attention is used or `(batch_size, 1,
+ query_sequence_length, key_sequence_length)` if default attention is used.
+ output_attentions (`bool`, *optional*):
+ Whether or not to return the attentions tensors of all attention layers. See `attentions` under
+ returned tensors for more detail.
+ use_cache (`bool`, *optional*):
+ If set to `True`, `past_key_values` key value states are returned and can be used to speed up decoding
+ (see `past_key_values`).
+ past_key_value (`Tuple(torch.FloatTensor)`, *optional*): cached past key and value projection states
+ """
+ if 'padding_mask' in kwargs:
+ warnings.warn(
+ 'Passing `padding_mask` is deprecated and will be removed in v4.37. Please make sure use `attention_mask` instead.`'
+ )
+
+ residual = hidden_states
+ hidden_states = self.input_layernorm(hidden_states)
+ # Self Attention
+ hidden_states, self_attn_weights, present_key_value = self.self_attn(
+ hidden_states=hidden_states,
+ attention_mask=attention_mask,
+ position_ids=position_ids,
+ past_key_value=past_key_value,
+ output_attentions=output_attentions,
+ use_cache=use_cache,
+ **kwargs,
+ )
+
+ hidden_states = residual + hidden_states * (self.scale_depth / math.sqrt(self.num_hidden_layers))
+
+ # Fully Connected
+ residual = hidden_states
+ hidden_states = self.post_attention_layernorm(hidden_states)
+
+ hidden_states = self.mlp(hidden_states)
+ hidden_states = residual + hidden_states * (self.scale_depth / math.sqrt(self.num_hidden_layers))
+
+ outputs = (hidden_states,)
+
+ if output_attentions:
+ outputs += (self_attn_weights,)
+
+ if use_cache:
+ outputs += (present_key_value,)
+
+ return outputs
+
+
+MINICPM_START_DOCSTRING = r"""
+ This model inherits from [`PreTrainedModel`]. Check the superclass documentation for the generic methods the
+ library implements for all its model (such as downloading or saving, resizing the input embeddings, pruning heads
+ etc.)
+
+ This model is also a PyTorch [torch.nn.Module](https://pytorch.org/docs/stable/nn.html#torch.nn.Module) subclass.
+ Use it as a regular PyTorch Module and refer to the PyTorch documentation for all matter related to general usage
+ and behavior.
+
+ Parameters:
+ config ([`MiniCPMConfig`]):
+ Model configuration class with all the parameters of the model. Initializing with a config file does not
+ load the weights associated with the model, only the configuration. Check out the
+ [`~PreTrainedModel.from_pretrained`] method to load the model weights.
+"""
+
+
+@add_start_docstrings(
+ 'The bare MiniCPM Model outputting raw hidden-states without any specific head on top.',
+ MINICPM_START_DOCSTRING,
+)
+class MiniCPMPreTrainedModel(PreTrainedModel):
+ config_class = MiniCPMConfig
+ base_model_prefix = 'model'
+ supports_gradient_checkpointing = True
+ _no_split_modules = ['MiniCPMDecoderLayer']
+ _skip_keys_device_placement = 'past_key_values'
+ _supports_flash_attn_2 = True
+ _supports_sdpa = True
+ _supports_cache_class = True
+
+ def _init_weights(self, module):
+ std = self.config.initializer_range
+ if isinstance(module, nn.Linear):
+ module.weight.data.normal_(mean=0.0, std=std)
+ if module.bias is not None:
+ module.bias.data.zero_()
+ elif isinstance(module, nn.Embedding):
+ module.weight.data.normal_(mean=0.0, std=std)
+ if module.padding_idx is not None:
+ module.weight.data[module.padding_idx].zero_()
+
+
+MINICPM_INPUTS_DOCSTRING = r"""
+ Args:
+ input_ids (`torch.LongTensor` of shape `(batch_size, sequence_length)`):
+ Indices of input sequence tokens in the vocabulary. Padding will be ignored by default should you provide
+ it.
+
+ Indices can be obtained using [`AutoTokenizer`]. See [`PreTrainedTokenizer.encode`] and
+ [`PreTrainedTokenizer.__call__`] for details.
+
+ [What are input IDs?](../glossary#input-ids)
+ attention_mask (`torch.Tensor` of shape `(batch_size, sequence_length)`, *optional*):
+ Mask to avoid performing attention on padding token indices. Mask values selected in `[0, 1]`:
+
+ - 1 for tokens that are **not masked**,
+ - 0 for tokens that are **masked**.
+
+ [What are attention masks?](../glossary#attention-mask)
+
+ Indices can be obtained using [`AutoTokenizer`]. See [`PreTrainedTokenizer.encode`] and
+ [`PreTrainedTokenizer.__call__`] for details.
+
+ If `past_key_values` is used, optionally only the last `input_ids` have to be input (see
+ `past_key_values`).
+
+ If you want to change padding behavior, you should read [`modeling_opt._prepare_decoder_attention_mask`]
+ and modify to your needs. See diagram 1 in [the paper](https://arxiv.org/abs/1910.13461) for more
+ information on the default strategy.
+
+ - 1 indicates the head is **not masked**,
+ - 0 indicates the head is **masked**.
+ position_ids (`torch.LongTensor` of shape `(batch_size, sequence_length)`, *optional*):
+ Indices of positions of each input sequence tokens in the position embeddings. Selected in the range `[0,
+ config.n_positions - 1]`.
+
+ [What are position IDs?](../glossary#position-ids)
+ past_key_values (`Cache` or `tuple(tuple(torch.FloatTensor))`, *optional*):
+ Pre-computed hidden-states (key and values in the self-attention blocks and in the cross-attention
+ blocks) that can be used to speed up sequential decoding. This typically consists in the `past_key_values`
+ returned by the model at a previous stage of decoding, when `use_cache=True` or `config.use_cache=True`.
+
+ Two formats are allowed:
+ - a [`~cache_utils.Cache`] instance;
+ - Tuple of `tuple(torch.FloatTensor)` of length `config.n_layers`, with each tuple having 2 tensors of
+ shape `(batch_size, num_heads, sequence_length, embed_size_per_head)`). This is also known as the legacy
+ cache format.
+
+ The model will output the same cache format that is fed as input. If no `past_key_values` are passed, the
+ legacy cache format will be returned.
+
+ If `past_key_values` are used, the user can optionally input only the last `input_ids` (those that don't
+ have their past key value states given to this model) of shape `(batch_size, 1)` instead of all `input_ids`
+ of shape `(batch_size, sequence_length)`.
+ inputs_embeds (`torch.FloatTensor` of shape `(batch_size, sequence_length, hidden_size)`, *optional*):
+ Optionally, instead of passing `input_ids` you can choose to directly pass an embedded representation. This
+ is useful if you want more control over how to convert `input_ids` indices into associated vectors than the
+ model's internal embedding lookup matrix.
+ use_cache (`bool`, *optional*):
+ If set to `True`, `past_key_values` key value states are returned and can be used to speed up decoding (see
+ `past_key_values`).
+ output_attentions (`bool`, *optional*):
+ Whether or not to return the attentions tensors of all attention layers. See `attentions` under returned
+ tensors for more detail.
+ output_hidden_states (`bool`, *optional*):
+ Whether or not to return the hidden states of all layers. See `hidden_states` under returned tensors for
+ more detail.
+ return_dict (`bool`, *optional*):
+ Whether or not to return a [`~utils.ModelOutput`] instead of a plain tuple.
+"""
+
+
+@add_start_docstrings(
+ 'The bare MiniCPM Model outputting raw hidden-states without any specific head on top.',
+ MINICPM_START_DOCSTRING,
+)
+class MiniCPMModel(MiniCPMPreTrainedModel):
+ """
+ Transformer decoder consisting of *config.num_hidden_layers* layers. Each layer is a [`MiniCPMDecoderLayer`]
+
+ Args:
+ config: MiniCPMConfig
+ """
+
+ def __init__(self, config: MiniCPMConfig):
+ super().__init__(config)
+ self.padding_idx = config.pad_token_id
+ self.vocab_size = config.vocab_size
+
+ self.embed_tokens = nn.Embedding(config.vocab_size, config.hidden_size, self.padding_idx)
+ self.layers = nn.ModuleList(
+ [MiniCPMDecoderLayer(config, layer_idx) for layer_idx in range(config.num_hidden_layers)]
+ )
+ self._use_sdpa = config._attn_implementation == 'sdpa'
+ self._use_flash_attention_2 = config._attn_implementation == 'flash_attention_2'
+
+ self.norm = MiniCPMRMSNorm(config.hidden_size, eps=config.rms_norm_eps)
+
+ self.gradient_checkpointing = False
+ # Initialize weights and apply final processing
+ self.post_init()
+
+ def get_input_embeddings(self):
+ return self.embed_tokens
+
+ def set_input_embeddings(self, value):
+ self.embed_tokens = value
+
+ @add_start_docstrings_to_model_forward(MINICPM_INPUTS_DOCSTRING)
+ def forward(
+ self,
+ input_ids: torch.LongTensor = None,
+ attention_mask: Optional[torch.Tensor] = None,
+ position_ids: Optional[torch.LongTensor] = None,
+ past_key_values: Optional[List[torch.FloatTensor]] = None,
+ inputs_embeds: Optional[torch.FloatTensor] = None,
+ use_cache: Optional[bool] = None,
+ output_attentions: Optional[bool] = None,
+ output_hidden_states: Optional[bool] = None,
+ return_dict: Optional[bool] = None,
+ ) -> Union[Tuple, BaseModelOutputWithPast]:
+ output_attentions = output_attentions if output_attentions is not None else self.config.output_attentions
+ output_hidden_states = (
+ output_hidden_states if output_hidden_states is not None else self.config.output_hidden_states
+ )
+ use_cache = use_cache if use_cache is not None else self.config.use_cache
+
+ return_dict = return_dict if return_dict is not None else self.config.use_return_dict
+
+ # retrieve input_ids and inputs_embeds
+ if input_ids is not None and inputs_embeds is not None:
+ raise ValueError('You cannot specify both input_ids and inputs_embeds at the same time')
+ elif input_ids is not None:
+ batch_size, seq_length = input_ids.shape[:2]
+ elif inputs_embeds is not None:
+ batch_size, seq_length = inputs_embeds.shape[:2]
+ else:
+ raise ValueError('You have to specify either input_ids or inputs_embeds')
+
+ if self.gradient_checkpointing and self.training:
+ if use_cache:
+ logger.warning_once(
+ '`use_cache=True` is incompatible with gradient checkpointing. Setting `use_cache=False`...'
+ )
+ use_cache = False
+
+ past_key_values_length = 0
+
+ if use_cache:
+ use_legacy_cache = not isinstance(past_key_values, Cache)
+ if use_legacy_cache:
+ raise ValueError(
+ 'You must use the new past_key_values format, such as the Cache class, instead of the old tuple format.'
+ )
+
+ # Calculate the usable length of past key values
+ past_key_values_length = past_key_values.get_seq_length() if isinstance(past_key_values, Cache) else 0
+
+
+ if position_ids is None:
+ device = input_ids.device if input_ids is not None else inputs_embeds.device
+ position_ids = torch.arange(
+ past_key_values_length, seq_length + past_key_values_length, dtype=torch.long, device=device
+ )
+ position_ids = position_ids.unsqueeze(0)
+
+ if inputs_embeds is None:
+ inputs_embeds = self.embed_tokens(input_ids) * self.config.scale_emb
+
+ if self._use_flash_attention_2:
+ # 2d mask is passed through the layers
+ # attention_mask = attention_mask if (attention_mask is not None and 0 in attention_mask) else None
+ if attention_mask is None:
+ raise ValueError(
+ f'need attention_mask for flash attention, but got {attention_mask}.'
+ )
+ elif self._use_sdpa and not output_attentions:
+ # output_attentions=True can not be supported when using SDPA, and we fall back on
+ # the manual implementation that requires a 4D causal mask in all cases.
+ attention_mask = _prepare_4d_causal_attention_mask_for_sdpa(
+ attention_mask,
+ (batch_size, seq_length),
+ inputs_embeds,
+ past_key_values_length,
+ )
+ else:
+ # 4d mask is passed through the layers
+ attention_mask = _prepare_4d_causal_attention_mask(
+ attention_mask, (batch_size, seq_length), inputs_embeds, past_key_values_length
+ )
+
+ # embed positions
+ hidden_states = inputs_embeds
+
+ # decoder layers
+ all_hidden_states = () if output_hidden_states else None
+ all_self_attns = () if output_attentions else None
+ next_decoder_cache = None
+
+ for decoder_layer in self.layers:
+ if output_hidden_states:
+ all_hidden_states += (hidden_states,)
+
+ if self.gradient_checkpointing and self.training:
+ layer_outputs = self._gradient_checkpointing_func(
+ decoder_layer.__call__,
+ hidden_states,
+ attention_mask,
+ position_ids,
+ past_key_values,
+ output_attentions,
+ use_cache,
+ )
+ else:
+ layer_outputs = decoder_layer(
+ hidden_states,
+ attention_mask=attention_mask,
+ position_ids=position_ids,
+ past_key_value=past_key_values,
+ output_attentions=output_attentions,
+ use_cache=use_cache,
+ )
+
+ hidden_states = layer_outputs[0]
+
+ if use_cache:
+ next_decoder_cache = layer_outputs[2 if output_attentions else 1]
+
+ if output_attentions:
+ all_self_attns += (layer_outputs[1],)
+
+ hidden_states = self.norm(hidden_states)
+
+ # add hidden states from the last decoder layer
+ if output_hidden_states:
+ all_hidden_states += (hidden_states,)
+
+ next_cache = None
+ if use_cache:
+ next_cache = next_decoder_cache.to_legacy_cache() if use_legacy_cache else next_decoder_cache
+ if not return_dict:
+ return tuple(v for v in [hidden_states, next_cache, all_hidden_states, all_self_attns] if v is not None)
+ return BaseModelOutputWithPast(
+ last_hidden_state=hidden_states,
+ past_key_values=next_cache,
+ hidden_states=all_hidden_states,
+ attentions=all_self_attns,
+ )
+
+
+class MiniCPMForCausalLM(MiniCPMPreTrainedModel):
+ _tied_weights_keys = ['lm_head.weight']
+
+ def __init__(self, config):
+ super().__init__(config)
+ self.model = MiniCPMModel(config)
+ self.vocab_size = config.vocab_size
+ self.lm_head = nn.Linear(config.hidden_size, config.vocab_size, bias=False)
+
+ # Initialize weights and apply final processing
+ self.post_init()
+
+ def get_input_embeddings(self):
+ return self.model.embed_tokens
+
+ def set_input_embeddings(self, value):
+ self.model.embed_tokens = value
+
+ def get_output_embeddings(self):
+ return self.lm_head
+
+ def set_output_embeddings(self, new_embeddings):
+ self.lm_head = new_embeddings
+
+ def set_decoder(self, decoder):
+ self.model = decoder
+
+ def get_decoder(self):
+ return self.model
+
+ @add_start_docstrings_to_model_forward(MINICPM_INPUTS_DOCSTRING)
+ @replace_return_docstrings(output_type=CausalLMOutputWithPast, config_class=_CONFIG_FOR_DOC)
+ def forward(
+ self,
+ input_ids: torch.LongTensor = None,
+ attention_mask: Optional[torch.Tensor] = None,
+ position_ids: Optional[torch.LongTensor] = None,
+ past_key_values: Optional[List[torch.FloatTensor]] = None,
+ inputs_embeds: Optional[torch.FloatTensor] = None,
+ labels: Optional[torch.LongTensor] = None,
+ use_cache: Optional[bool] = None,
+ output_attentions: Optional[bool] = None,
+ output_hidden_states: Optional[bool] = None,
+ return_dict: Optional[bool] = None,
+ logits_to_keep: Union[int, torch.Tensor] = 0,
+ **kwargs,
+ ) -> Union[Tuple, CausalLMOutputWithPast]:
+ r"""
+ Args:
+ labels (`torch.LongTensor` of shape `(batch_size, sequence_length)`, *optional*):
+ Labels for computing the masked language modeling loss. Indices should either be in `[0, ...,
+ config.vocab_size]` or -100 (see `input_ids` docstring). Tokens with indices set to `-100` are ignored
+ (masked), the loss is only computed for the tokens with labels in `[0, ..., config.vocab_size]`.
+
+ Returns:
+
+ Example:
+
+ ```python
+ >>> from transformers import AutoTokenizer, MiniCPMForCausalLM
+
+ >>> model = MiniCPMForCausalLM.from_pretrained(PATH_TO_CONVERTED_WEIGHTS)
+ >>> tokenizer = AutoTokenizer.from_pretrained(PATH_TO_CONVERTED_TOKENIZER)
+
+ >>> prompt = "Hey, are you conscious? Can you talk to me?"
+ >>> inputs = tokenizer(prompt, return_tensors="pt")
+
+ >>> # Generate
+ >>> generate_ids = model.generate(inputs.input_ids, max_length=30)
+ >>> tokenizer.batch_decode(generate_ids, skip_special_tokens=True, clean_up_tokenization_spaces=False)[0]
+ "Hey, are you conscious? Can you talk to me?\nI'm not conscious, but I can talk to you."
+ ```"""
+ output_attentions = output_attentions if output_attentions is not None else self.config.output_attentions
+ output_hidden_states = (
+ output_hidden_states if output_hidden_states is not None else self.config.output_hidden_states
+ )
+ return_dict = return_dict if return_dict is not None else self.config.use_return_dict
+
+ # decoder outputs consists of (dec_features, layer_state, dec_hidden, dec_attn)
+ outputs = self.model(
+ input_ids=input_ids,
+ attention_mask=attention_mask,
+ position_ids=position_ids,
+ past_key_values=past_key_values,
+ inputs_embeds=inputs_embeds,
+ use_cache=use_cache,
+ output_attentions=output_attentions,
+ output_hidden_states=output_hidden_states,
+ return_dict=return_dict,
+ )
+
+ hidden_states = outputs[0]
+ # Only compute necessary logits, and do not upcast them to float if we are not computing the loss
+ slice_indices = slice(-logits_to_keep, None) if isinstance(logits_to_keep, int) else logits_to_keep
+ hidden_states = hidden_states[:, slice_indices, :].contiguous()
+ if self.config.pretraining_tp > 1:
+ lm_head_slices = self.lm_head.weight.split(self.vocab_size // self.config.pretraining_tp, dim=0)
+ logits = [F.linear(hidden_states, lm_head_slices[i]) for i in range(self.config.pretraining_tp)]
+ logits = torch.cat(logits, dim=-1)
+ else:
+ logits = self.lm_head(hidden_states / (self.config.hidden_size / self.config.dim_model_base))
+ logits = logits.float()
+
+ loss = None
+ if labels is not None:
+ # Shift so that tokens < n predict n
+ shift_logits = logits[..., :-1, :].contiguous()
+ shift_labels = labels[..., 1:].contiguous()
+ # Flatten the tokens
+ loss_fct = CrossEntropyLoss()
+ shift_logits = shift_logits.view(-1, self.config.vocab_size)
+ shift_labels = shift_labels.view(-1)
+ # Enable model parallelism
+ shift_labels = shift_labels.to(shift_logits.device)
+ loss = loss_fct(shift_logits, shift_labels)
+
+ if not return_dict:
+ output = (logits,) + outputs[1:]
+ return (loss,) + output if loss is not None else output
+
+ return CausalLMOutputWithPast(
+ loss=loss,
+ logits=logits,
+ past_key_values=outputs.past_key_values,
+ hidden_states=outputs.hidden_states,
+ attentions=outputs.attentions,
+ )
+
+ def prepare_inputs_for_generation(
+ self, input_ids, past_key_values=None, attention_mask=None, inputs_embeds=None, **kwargs
+ ):
+ if past_key_values is not None:
+ if isinstance(past_key_values, Cache):
+ # Use the new Cache class methods
+ cache_length = past_key_values.get_seq_length()
+
+
+ past_length = cache_length
+ max_cache_length = None
+ else:
+ raise ValueError(
+ 'You must use the new past_key_values format, such as the Cache class, instead of the old tuple format.'
+ )
+
+ # Keep only the unprocessed tokens:
+ # 1 - If the length of the attention_mask exceeds the length of input_ids, then we are in a setting where
+ # some of the inputs are exclusively passed as part of the cache (e.g. when passing input_embeds as
+ # input)
+ if attention_mask is not None and attention_mask.shape[1] > input_ids.shape[1]:
+ input_ids = input_ids[:, -(attention_mask.shape[1] - past_length):]
+ # 2 - If the past_length is smaller than input_ids', then input_ids holds all input tokens. We can discard
+ # input_ids based on the past_length.
+ elif past_length < input_ids.shape[1]:
+ input_ids = input_ids[:, past_length:]
+ # 3 - Otherwise (past_length >= input_ids.shape[1]), let's assume input_ids only has unprocessed tokens.
+
+ # If we are about to go beyond the maximum cache length, we need to crop the input attention mask.
+ if (
+ max_cache_length is not None
+ and attention_mask is not None
+ and cache_length + input_ids.shape[1] > max_cache_length
+ ):
+ attention_mask = attention_mask[:, -max_cache_length:]
+
+ position_ids = kwargs.get('position_ids', None)
+ if attention_mask is not None and position_ids is None:
+ # create position_ids on the fly for batch generation
+ position_ids = attention_mask.long().cumsum(-1) - 1
+ position_ids.masked_fill_(attention_mask == 0, 1)
+ if past_key_values:
+ position_ids = position_ids[:, -input_ids.shape[1]:]
+
+ # if `inputs_embeds` are passed, we only want to use them in the 1st generation step
+ if inputs_embeds is not None and past_key_values is None:
+ model_inputs = {'inputs_embeds': inputs_embeds}
+ else:
+ model_inputs = {'input_ids': input_ids}
+
+ model_inputs.update(
+ {
+ 'position_ids': position_ids,
+ 'past_key_values': past_key_values,
+ 'use_cache': kwargs.get('use_cache'),
+ 'attention_mask': attention_mask,
+ }
+ )
+ # Forward ALL kwargs that are uninitialized (e.g. `use_cache`).
+ for key, value in kwargs.items():
+ if key not in model_inputs:
+ model_inputs[key] = value
+ return model_inputs
+
+ @staticmethod
+ def _reorder_cache(past_key_values, beam_idx):
+ reordered_past = ()
+ for layer_past in past_key_values:
+ reordered_past += (
+ tuple(past_state.index_select(0, beam_idx.to(past_state.device)) for past_state in layer_past),
+ )
+ return reordered_past
+
+ @torch.inference_mode()
+ def chat(self, tokenizer, query: str, history: List[Dict] = None, role: str = 'user',
+ max_length: int = 4096, num_beams=1, do_sample=True, top_p=0.8, temperature=0.3, logits_processor=None,
+ **kwargs):
+ if history is None:
+ history = []
+ if logits_processor:
+ gen_kwargs = {
+ 'max_length': max_length,
+ 'num_beams': num_beams,
+ 'do_sample': do_sample,
+ 'top_p': top_p,
+ 'temperature': temperature,
+ 'logits_processor': logits_processor,
+ **kwargs
+ }
+ else:
+ gen_kwargs = {
+ 'max_length': max_length,
+ 'num_beams': num_beams,
+ 'do_sample': do_sample,
+ 'top_p': top_p,
+ 'temperature': temperature,
+ 'logits_processor': logits_processor,
+ **kwargs
+ }
+
+ history.append({'role': role, 'content': query})
+ history_str = tokenizer.apply_chat_template(history, tokenize=False, add_generation_prompt=False)
+ inputs = tokenizer(history_str, return_tensors='pt').to(self.device)
+ outputs = self.generate(**inputs, **gen_kwargs)
+ outputs = outputs.tolist()[0][len(inputs['input_ids'][0]):-1]
+ response = tokenizer.decode(outputs)
+ pattern = re.compile(r'.*?(?=|<用户>)', re.DOTALL)
+ matches = pattern.findall(response)
+ if len(matches) > 0:
+ response = matches[0]
+ history.append({'role': 'assistant', 'content': response})
+ return response, history
+
+
+@add_start_docstrings(
+ """
+ The MiniCPM Model transformer with a sequence classification head on top (linear layer).
+
+ [`MiniCPMForSequenceClassification`] uses the last token in order to do the classification, as other causal models
+ (e.g. GPT-2) do.
+
+ Since it does classification on the last token, it requires to know the position of the last token. If a
+ `pad_token_id` is defined in the configuration, it finds the last token that is not a padding token in each row. If
+ no `pad_token_id` is defined, it simply takes the last value in each row of the batch. Since it cannot guess the
+ padding tokens when `inputs_embeds` are passed instead of `input_ids`, it does the same (take the last value in
+ each row of the batch).
+ """,
+ MINICPM_START_DOCSTRING,
+)
+class MiniCPMForSequenceClassification(MiniCPMPreTrainedModel):
+ def __init__(self, config):
+ super().__init__(config)
+ self.num_labels = config.num_labels
+ self.model = MiniCPMModel(config)
+ self.score = nn.Linear(config.hidden_size, self.num_labels, bias=False)
+
+ # Initialize weights and apply final processing
+ self.post_init()
+
+ def get_input_embeddings(self):
+ return self.model.embed_tokens
+
+ def set_input_embeddings(self, value):
+ self.model.embed_tokens = value
+
+ @add_start_docstrings_to_model_forward(MINICPM_INPUTS_DOCSTRING)
+ def forward(
+ self,
+ input_ids: torch.LongTensor = None,
+ attention_mask: Optional[torch.Tensor] = None,
+ position_ids: Optional[torch.LongTensor] = None,
+ past_key_values: Optional[List[torch.FloatTensor]] = None,
+ inputs_embeds: Optional[torch.FloatTensor] = None,
+ labels: Optional[torch.LongTensor] = None,
+ use_cache: Optional[bool] = None,
+ output_attentions: Optional[bool] = None,
+ output_hidden_states: Optional[bool] = None,
+ return_dict: Optional[bool] = None,
+ ) -> Union[Tuple, SequenceClassifierOutputWithPast]:
+ r"""
+ labels (`torch.LongTensor` of shape `(batch_size,)`, *optional*):
+ Labels for computing the sequence classification/regression loss. Indices should be in `[0, ...,
+ config.num_labels - 1]`. If `config.num_labels == 1` a regression loss is computed (Mean-Square loss), If
+ `config.num_labels > 1` a classification loss is computed (Cross-Entropy).
+ """
+ return_dict = return_dict if return_dict is not None else self.config.use_return_dict
+
+ transformer_outputs = self.model(
+ input_ids,
+ attention_mask=attention_mask,
+ position_ids=position_ids,
+ past_key_values=past_key_values,
+ inputs_embeds=inputs_embeds,
+ use_cache=use_cache,
+ output_attentions=output_attentions,
+ output_hidden_states=output_hidden_states,
+ return_dict=return_dict,
+ )
+ hidden_states = transformer_outputs[0]
+ logits = self.score(hidden_states)
+
+ if input_ids is not None:
+ batch_size = input_ids.shape[0]
+ else:
+ batch_size = inputs_embeds.shape[0]
+
+ if self.config.pad_token_id is None and batch_size != 1:
+ raise ValueError('Cannot handle batch sizes > 1 if no padding token is defined.')
+ if self.config.pad_token_id is None:
+ sequence_lengths = -1
+ else:
+ if input_ids is not None:
+ sequence_lengths = (torch.eq(input_ids, self.config.pad_token_id).int().argmax(-1) - 1).to(
+ logits.device
+ )
+ else:
+ sequence_lengths = -1
+
+ pooled_logits = logits[torch.arange(batch_size, device=logits.device), sequence_lengths]
+
+ loss = None
+ if labels is not None:
+ labels = labels.to(logits.device)
+ if self.config.problem_type is None:
+ if self.num_labels == 1:
+ self.config.problem_type = 'regression'
+ elif self.num_labels > 1 and (labels.dtype == torch.long or labels.dtype == torch.int):
+ self.config.problem_type = 'single_label_classification'
+ else:
+ self.config.problem_type = 'multi_label_classification'
+
+ if self.config.problem_type == 'regression':
+ loss_fct = MSELoss()
+ if self.num_labels == 1:
+ loss = loss_fct(pooled_logits.squeeze(), labels.squeeze())
+ else:
+ loss = loss_fct(pooled_logits, labels)
+ elif self.config.problem_type == 'single_label_classification':
+ loss_fct = CrossEntropyLoss()
+ loss = loss_fct(pooled_logits.view(-1, self.num_labels), labels.view(-1))
+ elif self.config.problem_type == 'multi_label_classification':
+ loss_fct = BCEWithLogitsLoss()
+ loss = loss_fct(pooled_logits, labels)
+ if not return_dict:
+ output = (pooled_logits,) + transformer_outputs[1:]
+ return ((loss,) + output) if loss is not None else output
+
+ return SequenceClassifierOutputWithPast(
+ loss=loss,
+ logits=pooled_logits,
+ past_key_values=transformer_outputs.past_key_values,
+ hidden_states=transformer_outputs.hidden_states,
+ attentions=transformer_outputs.attentions,
+ )
diff --git a/pytorch_model.bin b/pytorch_model.bin
new file mode 100644
index 0000000..9c1d426
--- /dev/null
+++ b/pytorch_model.bin
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:fe236eb8d3fd7e6bea58f8e44529318687d6be0921df0c1e9cfd8050d01e6808
+size 867818482
diff --git a/qat-convert.py b/qat-convert.py
new file mode 100644
index 0000000..a23cca6
--- /dev/null
+++ b/qat-convert.py
@@ -0,0 +1,176 @@
+import torch
+import torch.nn as nn
+from tqdm import tqdm
+import os
+import safetensors
+
+class SteTernaryQuantizer(nn.Module):
+ def __init__(self, group_size):
+ super().__init__()
+ self.group_size = group_size
+
+ def forward(self, x):
+ org_w_shape = x.shape
+ if self.group_size > 0:
+ assert x.shape[-1] % self.group_size == 0
+ x = x.reshape(-1, self.group_size)
+ elif self.group_size == -1:
+ x = x.reshape(-1, x.shape[-1])
+ assert x.dim() == 2
+ scales = 1.0 / (x.abs().mean(dim=1, keepdim=True).clamp_(min=1e-5))
+ x_q = (torch.clamp(torch.round(x * scales),-1,1) / scales)
+ assert torch.isnan(x_q).sum() == 0
+ x = x.reshape(org_w_shape)
+ x_q = x_q.reshape(org_w_shape)
+ return x_q
+
+class SteIntQuantizer(nn.Module):
+ def __init__(self, bit, group_size):
+ super().__init__()
+ self.bit = bit
+ self.group_size = group_size
+
+ def forward(self, x):
+ org_w_shape = x.shape
+ if self.group_size > 0:
+ assert org_w_shape[-1] % self.group_size == 0
+ x = x.reshape(-1, self.group_size)
+ elif self.group_size == -1:
+ x = x.reshape(-1, x.shape[-1])
+
+ assert x.dim() == 2
+
+ abs_max_val = x.abs().amax(dim=1, keepdim=True)
+ max_int = 2 ** (self.bit - 1) - 1
+ min_int = - (2 ** (self.bit - 1))
+ scales = abs_max_val.clamp(min=1e-5) / max_int
+
+ assert torch.isnan(scales).sum() == 0
+
+ x_q = (torch.clamp(torch.round(x / scales), min_int, max_int)) * scales
+
+ assert torch.isnan(x_q).sum() == 0
+
+ x = x.reshape(org_w_shape)
+ x_q = x_q.reshape(org_w_shape)
+
+ return x_q
+
+class SteInt2Quantizer(nn.Module):
+ def __init__(self, group_size):
+ super().__init__()
+ self.group_size = group_size
+
+ def forward(self, x):
+ org_w_shape = x.shape
+ if self.group_size > 0:
+ assert x.shape[-1] % self.group_size == 0
+ x = x.reshape(-1, self.group_size)
+ elif self.group_size == -1:
+ x = x.reshape(-1, x.shape[-1])
+
+ assert x.dim() == 2
+
+ scales = 1.0 / (x.abs().mean(dim=1, keepdim=True).clamp_(min=1e-5) * 1)
+ x_q = (torch.clamp(torch.round(x * scales),-2,1) / scales)
+
+ assert torch.isnan(x_q).sum() == 0
+
+ x = x.reshape(org_w_shape)
+ x_q = x_q.reshape(org_w_shape)
+
+ return x_q
+
+def quantize_model_bin(input_bin_path, output_bin_path, quant_type="ternary", bit=2, group_size=128, device="cuda" if torch.cuda.is_available() else "cpu"):
+ """
+ 直接对PyTorch模型bin文件进行量化。
+
+ Args:
+ input_bin_path: 输入模型bin文件路径
+ output_bin_path: 输出量化后的模型bin文件路径
+ quant_type: 量化类型 ("ternary" 或 "int")
+ bit: 整数量化的位数 (仅在 quant_type="int" 时使用)
+ group_size: 量化分组大小
+ device: 运行设备
+ """
+ print(f"加载模型文件: {input_bin_path}...")
+ if input_bin_path.endswith(".bin"):
+ state_dict = torch.load(input_bin_path, map_location=device)
+ elif input_bin_path.endswith(".safetensors"):
+ state_dict = safetensors.load_file(input_bin_path)
+ elif os.path.isdir(input_bin_path) and os.path.exists(os.path.join(input_bin_path, "pytorch_model.bin")):
+ state_dict = torch.load(os.path.join(input_bin_path, "pytorch_model.bin"), map_location=device)
+ elif os.path.isdir(input_bin_path) and os.path.exists(os.path.join(input_bin_path, "model.safetensors")):
+ state_dict = safetensors.load_file(os.path.join(input_bin_path, "model.safetensors"))
+ else:
+ raise ValueError(f"不支持的模型文件类型: {input_bin_path}")
+
+ print(f"应用 {quant_type} 量化...")
+ if quant_type == "ternary":
+ quantizer = SteTernaryQuantizer(group_size=group_size)
+ elif quant_type == "int":
+ quantizer = SteIntQuantizer(bit=bit, group_size=group_size)
+ elif quant_type == "int2":
+ quantizer = SteInt2Quantizer(group_size=group_size)
+ else:
+ raise ValueError(f"不支持的量化类型: {quant_type}")
+
+ # 统计需要量化的参数数量
+ total_params = sum(1 for k, v in state_dict.items() if ("weight" in k and "layer" in k) or ("fc" in k))
+
+ # 应用量化
+ with torch.no_grad():
+ for name, param in tqdm(state_dict.items(), total=total_params, desc="量化中"):
+ if (("weight" in name and "layer" in name and param.dim() == 2) or ("fc" in name and param.dim() == 2)):
+ # 对权重进行量化
+ original_weight = param.data.clone()
+ quantized_weight = quantizer(original_weight)
+ state_dict[name] = quantized_weight
+
+ # 打印前几个层的统计信息
+ if total_params > 0:
+ total_params -= 1
+ if total_params > total_params - 5:
+ print(f"层: {name}")
+ print(f" 原始范围: {original_weight.min():.4f} 到 {original_weight.max():.4f}")
+ print(f" 量化后范围: {quantized_weight.min():.4f} 到 {quantized_weight.max():.4f}")
+ print(f" 均方误差: {((original_weight - quantized_weight)**2).mean():.8f}")
+
+ # 保存量化后的模型
+ print(f"保存量化后的模型到: {output_bin_path}...")
+ if output_bin_path.endswith(".bin"):
+ torch.save(state_dict, output_bin_path)
+ elif output_bin_path.endswith(".safetensors"):
+ safetensors.save_file(state_dict, output_bin_path)
+ else:
+ os.makedirs(os.path.dirname(output_bin_path), exist_ok=True)
+ output_bin_path = os.path.join(output_bin_path, "pytorch_model.bin")
+ torch.save(state_dict, output_bin_path)
+ print("完成!")
+
+def main():
+ import argparse
+ parser = argparse.ArgumentParser(description="量化PyTorch模型bin文件")
+ parser.add_argument("--input_bin", type=str, required=True, help="输入模型bin文件路径")
+ parser.add_argument("--output", type=str, required=True, help="输出量化后的模型bin文件路径")
+ parser.add_argument("--quant_type", type=str, default="ternary", choices=["ternary", "int", "int2"], help="量化类型")
+ parser.add_argument("--bit", type=int, default=2, help="整数量化的位数")
+ parser.add_argument("--group_size", type=int, default=-1, help="量化分组大小")
+ parser.add_argument("--device", type=str, default="cuda" if torch.cuda.is_available() else "cpu", help="运行设备")
+ parser.add_argument("--config", type=str, default="", help="model config file")
+
+ args = parser.parse_args()
+ os.makedirs(args.output, exist_ok=True)
+ quantize_model_bin(
+ input_bin_path=args.input_bin,
+ output_bin_path=os.path.join(args.output, "pytorch_model.bin"),
+ quant_type=args.quant_type,
+ bit=args.bit,
+ group_size=args.group_size,
+ device=args.device
+ )
+ if args.config:
+ os.system(f"cp {args.config}/* {args.output}")
+ print(f"复制{args.config}文件到{args.output}")
+if __name__ == "__main__":
+ main()
\ No newline at end of file
diff --git a/special_tokens_map.json b/special_tokens_map.json
new file mode 100644
index 0000000..2fcea2d
--- /dev/null
+++ b/special_tokens_map.json
@@ -0,0 +1,33 @@
+{
+ "additional_special_tokens": [
+ "<|im_end|>",
+ "<|im_start|>",
+ "<|tool_call|>",
+ "<|execute_start|>",
+ "<|execute_end|>",
+ "<|fim_prefix|>",
+ "<|fim_middle|>",
+ "<|fim_suffix|>"
+ ],
+ "bos_token": {
+ "content": "",
+ "lstrip": false,
+ "normalized": false,
+ "rstrip": false,
+ "single_word": false
+ },
+ "eos_token": {
+ "content": "<|im_end|>",
+ "lstrip": false,
+ "normalized": false,
+ "rstrip": false,
+ "single_word": false
+ },
+ "unk_token": {
+ "content": "",
+ "lstrip": false,
+ "normalized": false,
+ "rstrip": false,
+ "single_word": false
+ }
+}
diff --git a/tokenizer.json b/tokenizer.json
new file mode 100644
index 0000000..15a2f9b
--- /dev/null
+++ b/tokenizer.json
@@ -0,0 +1,490843 @@
+{
+ "version": "1.0",
+ "truncation": null,
+ "padding": null,
+ "added_tokens": [
+ {
+ "id": 0,
+ "content": "",
+ "single_word": false,
+ "lstrip": false,
+ "rstrip": false,
+ "normalized": false,
+ "special": true
+ },
+ {
+ "id": 1,
+ "content": "",
+ "single_word": false,
+ "lstrip": false,
+ "rstrip": false,
+ "normalized": false,
+ "special": true
+ },
+ {
+ "id": 2,
+ "content": "",
+ "single_word": false,
+ "lstrip": false,
+ "rstrip": false,
+ "normalized": false,
+ "special": true
+ },
+ {
+ "id": 73440,
+ "content": "<|im_end|>",
+ "single_word": false,
+ "lstrip": false,
+ "rstrip": false,
+ "normalized": false,
+ "special": true
+ },
+ {
+ "id": 73441,
+ "content": "<|im_start|>",
+ "single_word": false,
+ "lstrip": false,
+ "rstrip": false,
+ "normalized": false,
+ "special": true
+ },
+ {
+ "id": 73442,
+ "content": "<|tool_call|>",
+ "single_word": false,
+ "lstrip": false,
+ "rstrip": false,
+ "normalized": false,
+ "special": true
+ },
+ {
+ "id": 73443,
+ "content": "<|execute_start|>",
+ "single_word": false,
+ "lstrip": false,
+ "rstrip": false,
+ "normalized": false,
+ "special": true
+ },
+ {
+ "id": 73444,
+ "content": "<|execute_end|>",
+ "single_word": false,
+ "lstrip": false,
+ "rstrip": false,
+ "normalized": false,
+ "special": true
+ },
+ {
+ "id": 73445,
+ "content": "<|fim_prefix|>",
+ "single_word": false,
+ "lstrip": false,
+ "rstrip": false,
+ "normalized": false,
+ "special": true
+ },
+ {
+ "id": 73446,
+ "content": "<|fim_middle|>",
+ "single_word": false,
+ "lstrip": false,
+ "rstrip": false,
+ "normalized": false,
+ "special": true
+ },
+ {
+ "id": 73447,
+ "content": "<|fim_suffix|>",
+ "single_word": false,
+ "lstrip": false,
+ "rstrip": false,
+ "normalized": false,
+ "special": true
+ }
+ ],
+ "normalizer": {
+ "type": "Sequence",
+ "normalizers": [
+ {
+ "type": "Prepend",
+ "prepend": "▁"
+ },
+ {
+ "type": "Replace",
+ "pattern": {
+ "String": " "
+ },
+ "content": "▁"
+ }
+ ]
+ },
+ "pre_tokenizer": null,
+ "post_processor": {
+ "type": "TemplateProcessing",
+ "single": [
+ {
+ "SpecialToken": {
+ "id": "",
+ "type_id": 0
+ }
+ },
+ {
+ "Sequence": {
+ "id": "A",
+ "type_id": 0
+ }
+ }
+ ],
+ "pair": [
+ {
+ "SpecialToken": {
+ "id": "",
+ "type_id": 0
+ }
+ },
+ {
+ "Sequence": {
+ "id": "A",
+ "type_id": 0
+ }
+ },
+ {
+ "SpecialToken": {
+ "id": "",
+ "type_id": 1
+ }
+ },
+ {
+ "Sequence": {
+ "id": "B",
+ "type_id": 1
+ }
+ }
+ ],
+ "special_tokens": {
+ "": {
+ "id": "",
+ "ids": [
+ 1
+ ],
+ "tokens": [
+ ""
+ ]
+ }
+ }
+ },
+ "decoder": {
+ "type": "Sequence",
+ "decoders": [
+ {
+ "type": "Replace",
+ "pattern": {
+ "String": "▁"
+ },
+ "content": " "
+ },
+ {
+ "type": "ByteFallback"
+ },
+ {
+ "type": "Fuse"
+ },
+ {
+ "type": "Strip",
+ "content": " ",
+ "start": 1,
+ "stop": 0
+ }
+ ]
+ },
+ "model": {
+ "type": "BPE",
+ "dropout": null,
+ "unk_token": "",
+ "continuing_subword_prefix": null,
+ "end_of_word_suffix": null,
+ "fuse_unk": true,
+ "byte_fallback": true,
+ "ignore_merges": false,
+ "vocab": {
+ "": 0,
+ "": 1,
+ "": 2,
+ "": 3,
+ "": 4,
+ "\n": 5,
+ "\t": 6,
+ "
": 7,
+ "
": 8,
+ "": 9,
+ "": 10,
+ "": 11,
+ "
": 12,
+ "": 13,
+ " | | ": 14,
+ "": 15,
+ "": 16,
+ "": 17,
+ "": 18,
+ "": 21,
+ "": 22,
+ "
": 23,
+ "": 24,
+ "": 25,
+ "": 26,
+ "": 27,
+ "": 28,
+ "": 29,
+ "": 30,
+ "": 31,
+ "": 32,
+ "
": 33,
+ "
": 34,
+ "
": 35,
+ "": 36,
+ "": 37,
+ "": 38,
+ "
": 39,
+ "": 40,
+ "": 41,
+ "
": 42,
+ "": 43,
+ "
": 44,
+ "
": 45,
+ "": 46,
+ "": 47,
+ "
": 48,
+ "": 49,
+ "": 50,
+ "": 51,
+ "0": 52,
+ "1": 53,
+ "2": 54,
+ "3": 55,
+ "4": 56,
+ "5": 57,
+ "6": 58,
+ "7": 59,
+ "8": 60,
+ "9": 61,
+ "+": 62,
+ "-": 63,
+ "=": 64,
+ ",": 65,
+ "。": 66,
+ "!": 67,
+ "?": 68,
+ "、": 69,
+ ":": 70,
+ "¥": 71,
+ ".": 72,
+ "!": 73,
+ "?": 74,
+ "...": 75,
+ "。。。": 76,
+ "。。。。。。": 77,
+ "《": 78,
+ "》": 79,
+ "【": 80,
+ "】": 81,
+ "『": 82,
+ "』": 83,
+ "```": 84,
+ "": 86,
+ "---": 87,
+ "": 88,
+ ";": 89,
+ ".": 90,
+ "=": 91,
+ "<": 92,
+ ">": 93,
+ "-": 94,
+ "+": 95,
+ "%": 96,
+ "‼": 97,
+ "㊣": 98,
+ "/": 99,
+ "|": 100,
+ "": 101,
+ "": 102,
+ "": 103,
+ "": 104,
+ "": 105,
+ "": 106,
+ "": 107,
+ "": 108,
+ "": 109,
+ "": 110,
+ "": 111,
+ "": 112,
+ "": 113,
+ "": 114,
+ "": 115,
+ "": 116,
+ "": 117,
+ "": 118,
+ "": 119,
+ "": 120,
+ "": 121,
+ "": 122,
+ "": 123,
+ "": 124,
+ "": 125,
+ "": 126,
+ "": 127,
+ "": 128,
+ "": 129,
+ "": 130,
+ "": 131,
+ "": 132,
+ "": 133,
+ "": 134,
+ "": 135,
+ "": 136,
+ "": 137,
+ "": 138,
+ "": 139,
+ "": 140,
+ "": 141,
+ "": 142,
+ "": 143,
+ "": 144,
+ "": 145,
+ "": 146,
+ "": 147,
+ "": 148,
+ "": 149,
+ "": 150,
+ "": 151,
+ "": 152,
+ "": 153,
+ "": 154,
+ "": 155,
+ "": 156,
+ "": 157,
+ "": 158,
+ "": 159,
+ "": 160,
+ "": 161,
+ "": 162,
+ "": 163,
+ "": 164,
+ "": 165,
+ "": 166,
+ "": 167,
+ "": 168,
+ "": 169,
+ "": 170,
+ "": 171,
+ "": 172,
+ "": 173,
+ "": 174,
+ "": 175,
+ "": 176,
+ "": 177,
+ "": 178,
+ "": 179,
+ "": 180,
+ "": 181,
+ "": 182,
+ "": 183,
+ "": 184,
+ "": 185,
+ "": 186,
+ "": 187,
+ "": 188,
+ "": 189,
+ "": 190,
+ "": 191,
+ "": 192,
+ "": 193,
+ "": 194,
+ "": 195,
+ "": 196,
+ "": 197,
+ "": 198,
+ "": 199,
+ "": 200,
+ "": 201,
+ "": 202,
+ "": 203,
+ "": 204,
+ "": 205,
+ "": 206,
+ "": 207,
+ "": 208,
+ "": 209,
+ "": 210,
+ "": 211,
+ "": 212,
+ "": 213,
+ "": 214,
+ "": 215,
+ "": 216,
+ "": 217,
+ "": 218,
+ "": 219,
+ "": 220,
+ "": 221,
+ "": 222,
+ "": 223,
+ "": 224,
+ "": 225,
+ "": 226,
+ "": 227,
+ "": 228,
+ "": 229,
+ "": 230,
+ "": 231,
+ "": 232,
+ "": 233,
+ "": 234,
+ "": 235,
+ "": 236,
+ "": 237,
+ "": 238,
+ "": 239,
+ "": 240,
+ "": 241,
+ "": 242,
+ "": 243,
+ "": 244,
+ "": 245,
+ "": 246,
+ "": 247,
+ "": 248,
+ "": 249,
+ "": 250,
+ "": 251,
+ "": 252,
+ "": 253,
+ "": 254,
+ "": 255,
+ "": 256,
+ "": 257,
+ "": 258,
+ "": 259,
+ "": 260,
+ "": 261,
+ "": 262,
+ "": 263,
+ "": 264,
+ "": 265,
+ "": 266,
+ "": 267,
+ "": 268,
+ "": 269,
+ "": 270,
+ "": 271,
+ "": 272,
+ "": 273,
+ "": 274,
+ "": 275,
+ "": 276,
+ "": 277,
+ "": 278,
+ "": 279,
+ "": 280,
+ "": 281,
+ "": 282,
+ "": 283,
+ "": 284,
+ "": 285,
+ "": 286,
+ "": 287,
+ "": 288,
+ "": 289,
+ "": 290,
+ "": 291,
+ "": 292,
+ "": 293,
+ "": 294,
+ "": 295,
+ "": 296,
+ "": 297,
+ "": 298,
+ "": 299,
+ "": 300,
+ "": 301,
+ "": 302,
+ "": 303,
+ "": 304,
+ "": 305,
+ "": 306,
+ "": 307,
+ "": 308,
+ "": 309,
+ "": 310,
+ "": 311,
+ "": 312,
+ "": 313,
+ "": 314,
+ "": 315,
+ "": 316,
+ "": 317,
+ "": 318,
+ "": 319,
+ "": 320,
+ "": 321,
+ "": 322,
+ "": 323,
+ "": 324,
+ "": 325,
+ "": 326,
+ "": 327,
+ "": 328,
+ "": 329,
+ "": 330,
+ "": 331,
+ "": 332,
+ "": 333,
+ "": 334,
+ "": 335,
+ "": 336,
+ "": 337,
+ "": 338,
+ "": 339,
+ "": 340,
+ "": 341,
+ "": 342,
+ "": 343,
+ "": 344,
+ "": 345,
+ "": 346,
+ "": 347,
+ "": 348,
+ "": 349,
+ "": 350,
+ "": 351,
+ "": 352,
+ "": 353,
+ "