Upload BaichuanForCausalLM

README.md

@@ -1,11 +1,12 @@
 ---
-license: gpl-3.0
 language:
 - zh
-metrics:
-- bleu
+license: gpl-3.0
 tags:
 - art
 - marketing
+- llama-factory
 base_model: baichuan-inc/Baichuan2-7B-Chat
----
+metrics:
+- bleu
+---

config.json

@@ -0,0 +1,32 @@
+{
+  "_from_model_config": true,
+  "_name_or_path": "baichuan-inc/Baichuan2-7B-Chat",
+  "architectures": [
+    "BaichuanForCausalLM"
+  ],
+  "auto_map": {
+    "AutoConfig": "configuration_baichuan.BaichuanConfig",
+    "AutoModel": "modeling_baichuan.BaichuanForCausalLM",
+    "AutoModelForCausalLM": "baichuan-inc/Baichuan2-7B-Chat--modeling_baichuan.BaichuanForCausalLM"
+  },
+  "bos_token_id": 1,
+  "eos_token_id": 2,
+  "hidden_act": "silu",
+  "hidden_size": 4096,
+  "initializer_range": 0.02,
+  "intermediate_size": 11008,
+  "max_position_embeddings": 4096,
+  "model_max_length": 4096,
+  "model_type": "baichuan",
+  "num_attention_heads": 32,
+  "num_hidden_layers": 32,
+  "pad_token_id": 0,
+  "rms_norm_eps": 1e-06,
+  "tie_word_embeddings": false,
+  "tokenizer_class": "BaichuanTokenizer",
+  "torch_dtype": "bfloat16",
+  "transformers_version": "4.40.1",
+  "use_cache": true,
+  "vocab_size": 125696,
+  "z_loss_weight": 0
+}

configuration_baichuan.py

@@ -0,0 +1,69 @@
+# Copyright 2023 Baichuan Inc. All Rights Reserved.
+
+# Copyright 2022 EleutherAI and the HuggingFace Inc. team. All rights reserved.
+#
+# This code is based on EleutherAI's GPT-NeoX library and the GPT-NeoX
+# and OPT implementations in this library. It has been modified from its
+# original forms to accommodate minor architectural differences compared
+# to GPT-NeoX and OPT used by the Meta AI team that trained the model.
+#
+# 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.
+
+from transformers.configuration_utils import PretrainedConfig
+from transformers.utils import logging
+
+
+logger = logging.get_logger(__name__)
+
+
+class BaichuanConfig(PretrainedConfig):
+    model_type = "baichuan"
+    keys_to_ignore_at_inference = ["past_key_values"]
+
+    def __init__(
+        self,
+        vocab_size=125696,
+        hidden_size=4096,
+        intermediate_size=11008,
+        num_hidden_layers=32,
+        num_attention_heads=32,
+        hidden_act="silu",
+        max_position_embeddings=4096,
+        initializer_range=0.02,
+        rms_norm_eps=1e-6,
+        use_cache=True,
+        pad_token_id=0,
+        bos_token_id=1,
+        eos_token_id=2,
+        tie_word_embeddings=False,
+        z_loss_weight=0,
+        **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
+        self.hidden_act = hidden_act
+        self.initializer_range = initializer_range
+        self.rms_norm_eps = rms_norm_eps
+        self.use_cache = use_cache
+        self.z_loss_weight = z_loss_weight
+        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,
+        )

generation_config.json

@@ -0,0 +1,14 @@
+{
+  "assistant_token_id": 196,
+  "bos_token_id": 1,
+  "do_sample": true,
+  "eos_token_id": 2,
+  "max_new_tokens": 2048,
+  "pad_token_id": 0,
+  "repetition_penalty": 1.05,
+  "temperature": 0.3,
+  "top_k": 5,
+  "top_p": 0.85,
+  "transformers_version": "4.40.1",
+  "user_token_id": 195
+}

generation_utils.py

@@ -0,0 +1,83 @@
+from typing import List
+from queue import Queue
+
+import torch
+
+
+def build_chat_input(model, tokenizer, messages: List[dict], max_new_tokens: int=0):
+    def _parse_messages(messages, split_role="user"):
+        system, rounds = "", []
+        round = []
+        for i, message in enumerate(messages):
+            if message["role"] == "system":
+                assert i == 0
+                system = message["content"]
+                continue
+            if message["role"] == split_role and round:
+                rounds.append(round)
+                round = []
+            round.append(message)
+        if round:
+            rounds.append(round)
+        return system, rounds
+
+    max_new_tokens = max_new_tokens or model.generation_config.max_new_tokens
+    max_input_tokens = model.config.model_max_length - max_new_tokens
+    system, rounds = _parse_messages(messages, split_role="user")
+    system_tokens = tokenizer.encode(system)
+    max_history_tokens = max_input_tokens - len(system_tokens)
+
+    history_tokens = []
+    for round in rounds[::-1]:
+        round_tokens = []
+        for message in round:
+            if message["role"] == "user":
+                round_tokens.append(model.generation_config.user_token_id)
+            else:
+                round_tokens.append(model.generation_config.assistant_token_id)
+            round_tokens.extend(tokenizer.encode(message["content"]))
+        if len(history_tokens) == 0 or len(history_tokens) + len(round_tokens) <= max_history_tokens:
+            history_tokens = round_tokens + history_tokens  # concat left
+            if len(history_tokens) < max_history_tokens:
+                continue
+        break
+
+    input_tokens = system_tokens + history_tokens
+    if messages[-1]["role"] != "assistant":
+        input_tokens.append(model.generation_config.assistant_token_id)
+    input_tokens = input_tokens[-max_input_tokens:]  # truncate left
+    return torch.LongTensor([input_tokens]).to(model.device)
+
+
+class TextIterStreamer:
+    def __init__(self, tokenizer, skip_prompt=False, skip_special_tokens=False):
+        self.tokenizer = tokenizer
+        self.skip_prompt = skip_prompt
+        self.skip_special_tokens = skip_special_tokens
+        self.tokens = []
+        self.text_queue = Queue()
+        self.next_tokens_are_prompt = True
+
+    def put(self, value):
+        if self.skip_prompt and self.next_tokens_are_prompt:
+            self.next_tokens_are_prompt = False
+        else:
+            if len(value.shape) > 1:
+                value = value[0]
+            self.tokens.extend(value.tolist())
+            self.text_queue.put(
+                self.tokenizer.decode(self.tokens, skip_special_tokens=self.skip_special_tokens))
+
+    def end(self):
+        self.text_queue.put(None)
+
+    def __iter__(self):
+        return self
+
+    def __next__(self):
+        value = self.text_queue.get()
+        if value is None:
+            raise StopIteration()
+        else:
+            return value
+

model-00001-of-00016.safetensors

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:dd27463177f75e6e2829d05c24575cc92de5a551d43781ac7a47583dd706ca5e
+size 1029701776

model-00002-of-00016.safetensors

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:efd027fcba86e3bec2f00f3eb093aa53aea7328dae9fffe4025b3d8f6883cc6e
+size 943753016

model-00003-of-00016.safetensors

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:42cd8f2ffba5cd15f02f39509755bd6caf495660a23499f2e6f24d23122ee18c
+size 989890352

model-00004-of-00016.safetensors

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:90687c8b7f26361ecde0d2155b5939e02fb503da465f35fff41473c71bf4f7bd
+size 899729304

model-00005-of-00016.safetensors

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:a004b8921c27b68ef6a77b756969b948f69dee7c1d07ba5c8e8005d93186e43f
+size 943753016

model-00006-of-00016.safetensors

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:d82d49805a0efcb0978b1edc2884c137fc952383e4daf608c5c691123b225222
+size 989890360

model-00007-of-00016.safetensors

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:21a43ac212d24dfb8f2e54380b6ade38ac1bdbf32728b066a5a63418e9da3cd3
+size 899729328

model-00008-of-00016.safetensors

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:5e49546fe941beea64185748c4d26ce9bed68c1f2213ca7a23eae03cc494e2ef
+size 943753032

model-00009-of-00016.safetensors

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:1878031375ef20ef0937c24b27c5d80449a41e109bea8eefeae4074a93f16cc8
+size 989890368

model-00010-of-00016.safetensors

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:4c7d4c0e8286c21a9725ea3d6ae3ab6a21d0242a1cabdcb2ba184531f5547204
+size 899729328

model-00011-of-00016.safetensors

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:1279b44345701e2efef54d925c95b9cb8c8999818f5fe159a9696b61c384582c
+size 943753032

model-00012-of-00016.safetensors

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:000b969fe6c6ca76748bc2dda682c7dfed8f9907b2e77d61d536a9fe1354978f
+size 989890368

model-00013-of-00016.safetensors

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:333705de0b0713aa00aeb9d3d029073d8cbe41c4f17a9db3c45cfab5f03aca0a
+size 899729328

model-00014-of-00016.safetensors

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:c08ee198cad6cf1688ddcd8c4871a53140e299f4f75529177967ae482cdb85b5
+size 943753032

model-00015-of-00016.safetensors

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:9785cb7e9485416d0a1db006bd0a0e3c683174aa117beac153e7fc0fddf67ff3
+size 675325384

model-00016-of-00016.safetensors

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:8f5fb54adaafd83f71008d96741393725d92a63b9443c860bc6484930c21fa33
+size 1029701760

model.safetensors.index.json

@@ -0,0 +1,234 @@
+{
+  "metadata": {
+    "total_size": 15011946496
+  },
+  "weight_map": {
+    "lm_head.weight": "model-00016-of-00016.safetensors",
+    "model.embed_tokens.weight": "model-00001-of-00016.safetensors",
+    "model.layers.0.input_layernorm.weight": "model-00002-of-00016.safetensors",
+    "model.layers.0.mlp.down_proj.weight": "model-00002-of-00016.safetensors",
+    "model.layers.0.mlp.gate_proj.weight": "model-00002-of-00016.safetensors",
+    "model.layers.0.mlp.up_proj.weight": "model-00002-of-00016.safetensors",
+    "model.layers.0.post_attention_layernorm.weight": "model-00002-of-00016.safetensors",
+    "model.layers.0.self_attn.W_pack.weight": "model-00002-of-00016.safetensors",
+    "model.layers.0.self_attn.o_proj.weight": "model-00002-of-00016.safetensors",
+    "model.layers.1.input_layernorm.weight": "model-00002-of-00016.safetensors",
+    "model.layers.1.mlp.down_proj.weight": "model-00002-of-00016.safetensors",
+    "model.layers.1.mlp.gate_proj.weight": "model-00002-of-00016.safetensors",
+    "model.layers.1.mlp.up_proj.weight": "model-00002-of-00016.safetensors",
+    "model.layers.1.post_attention_layernorm.weight": "model-00002-of-00016.safetensors",
+    "model.layers.1.self_attn.W_pack.weight": "model-00002-of-00016.safetensors",
+    "model.layers.1.self_attn.o_proj.weight": "model-00002-of-00016.safetensors",
+    "model.layers.10.input_layernorm.weight": "model-00006-of-00016.safetensors",
+    "model.layers.10.mlp.down_proj.weight": "model-00006-of-00016.safetensors",
+    "model.layers.10.mlp.gate_proj.weight": "model-00006-of-00016.safetensors",
+    "model.layers.10.mlp.up_proj.weight": "model-00006-of-00016.safetensors",
+    "model.layers.10.post_attention_layernorm.weight": "model-00006-of-00016.safetensors",
+    "model.layers.10.self_attn.W_pack.weight": "model-00006-of-00016.safetensors",
+    "model.layers.10.self_attn.o_proj.weight": "model-00006-of-00016.safetensors",
+    "model.layers.11.input_layernorm.weight": "model-00007-of-00016.safetensors",
+    "model.layers.11.mlp.down_proj.weight": "model-00006-of-00016.safetensors",
+    "model.layers.11.mlp.gate_proj.weight": "model-00006-of-00016.safetensors",
+    "model.layers.11.mlp.up_proj.weight": "model-00007-of-00016.safetensors",
+    "model.layers.11.post_attention_layernorm.weight": "model-00007-of-00016.safetensors",
+    "model.layers.11.self_attn.W_pack.weight": "model-00006-of-00016.safetensors",
+    "model.layers.11.self_attn.o_proj.weight": "model-00006-of-00016.safetensors",
+    "model.layers.12.input_layernorm.weight": "model-00007-of-00016.safetensors",
+    "model.layers.12.mlp.down_proj.weight": "model-00007-of-00016.safetensors",
+    "model.layers.12.mlp.gate_proj.weight": "model-00007-of-00016.safetensors",
+    "model.layers.12.mlp.up_proj.weight": "model-00007-of-00016.safetensors",
+    "model.layers.12.post_attention_layernorm.weight": "model-00007-of-00016.safetensors",
+    "model.layers.12.self_attn.W_pack.weight": "model-00007-of-00016.safetensors",
+    "model.layers.12.self_attn.o_proj.weight": "model-00007-of-00016.safetensors",
+    "model.layers.13.input_layernorm.weight": "model-00007-of-00016.safetensors",
+    "model.layers.13.mlp.down_proj.weight": "model-00007-of-00016.safetensors",
+    "model.layers.13.mlp.gate_proj.weight": "model-00007-of-00016.safetensors",
+    "model.layers.13.mlp.up_proj.weight": "model-00007-of-00016.safetensors",
+    "model.layers.13.post_attention_layernorm.weight": "model-00007-of-00016.safetensors",
+    "model.layers.13.self_attn.W_pack.weight": "model-00007-of-00016.safetensors",
+    "model.layers.13.self_attn.o_proj.weight": "model-00007-of-00016.safetensors",
+    "model.layers.14.input_layernorm.weight": "model-00008-of-00016.safetensors",
+    "model.layers.14.mlp.down_proj.weight": "model-00008-of-00016.safetensors",
+    "model.layers.14.mlp.gate_proj.weight": "model-00008-of-00016.safetensors",
+    "model.layers.14.mlp.up_proj.weight": "model-00008-of-00016.safetensors",
+    "model.layers.14.post_attention_layernorm.weight": "model-00008-of-00016.safetensors",
+    "model.layers.14.self_attn.W_pack.weight": "model-00008-of-00016.safetensors",
+    "model.layers.14.self_attn.o_proj.weight": "model-00008-of-00016.safetensors",
+    "model.layers.15.input_layernorm.weight": "model-00008-of-00016.safetensors",
+    "model.layers.15.mlp.down_proj.weight": "model-00008-of-00016.safetensors",
+    "model.layers.15.mlp.gate_proj.weight": "model-00008-of-00016.safetensors",
+    "model.layers.15.mlp.up_proj.weight": "model-00008-of-00016.safetensors",
+    "model.layers.15.post_attention_layernorm.weight": "model-00008-of-00016.safetensors",
+    "model.layers.15.self_attn.W_pack.weight": "model-00008-of-00016.safetensors",
+    "model.layers.15.self_attn.o_proj.weight": "model-00008-of-00016.safetensors",
+    "model.layers.16.input_layernorm.weight": "model-00009-of-00016.safetensors",
+    "model.layers.16.mlp.down_proj.weight": "model-00009-of-00016.safetensors",
+    "model.layers.16.mlp.gate_proj.weight": "model-00009-of-00016.safetensors",
+    "model.layers.16.mlp.up_proj.weight": "model-00009-of-00016.safetensors",
+    "model.layers.16.post_attention_layernorm.weight": "model-00009-of-00016.safetensors",
+    "model.layers.16.self_attn.W_pack.weight": "model-00008-of-00016.safetensors",
+    "model.layers.16.self_attn.o_proj.weight": "model-00008-of-00016.safetensors",
+    "model.layers.17.input_layernorm.weight": "model-00009-of-00016.safetensors",
+    "model.layers.17.mlp.down_proj.weight": "model-00009-of-00016.safetensors",
+    "model.layers.17.mlp.gate_proj.weight": "model-00009-of-00016.safetensors",
+    "model.layers.17.mlp.up_proj.weight": "model-00009-of-00016.safetensors",
+    "model.layers.17.post_attention_layernorm.weight": "model-00009-of-00016.safetensors",
+    "model.layers.17.self_attn.W_pack.weight": "model-00009-of-00016.safetensors",
+    "model.layers.17.self_attn.o_proj.weight": "model-00009-of-00016.safetensors",
+    "model.layers.18.input_layernorm.weight": "model-00010-of-00016.safetensors",
+    "model.layers.18.mlp.down_proj.weight": "model-00009-of-00016.safetensors",
+    "model.layers.18.mlp.gate_proj.weight": "model-00009-of-00016.safetensors",
+    "model.layers.18.mlp.up_proj.weight": "model-00010-of-00016.safetensors",
+    "model.layers.18.post_attention_layernorm.weight": "model-00010-of-00016.safetensors",
+    "model.layers.18.self_attn.W_pack.weight": "model-00009-of-00016.safetensors",
+    "model.layers.18.self_attn.o_proj.weight": "model-00009-of-00016.safetensors",
+    "model.layers.19.input_layernorm.weight": "model-00010-of-00016.safetensors",
+    "model.layers.19.mlp.down_proj.weight": "model-00010-of-00016.safetensors",
+    "model.layers.19.mlp.gate_proj.weight": "model-00010-of-00016.safetensors",
+    "model.layers.19.mlp.up_proj.weight": "model-00010-of-00016.safetensors",
+    "model.layers.19.post_attention_layernorm.weight": "model-00010-of-00016.safetensors",
+    "model.layers.19.self_attn.W_pack.weight": "model-00010-of-00016.safetensors",
+    "model.layers.19.self_attn.o_proj.weight": "model-00010-of-00016.safetensors",
+    "model.layers.2.input_layernorm.weight": "model-00003-of-00016.safetensors",
+    "model.layers.2.mlp.down_proj.weight": "model-00003-of-00016.safetensors",
+    "model.layers.2.mlp.gate_proj.weight": "model-00003-of-00016.safetensors",
+    "model.layers.2.mlp.up_proj.weight": "model-00003-of-00016.safetensors",
+    "model.layers.2.post_attention_layernorm.weight": "model-00003-of-00016.safetensors",
+    "model.layers.2.self_attn.W_pack.weight": "model-00002-of-00016.safetensors",
+    "model.layers.2.self_attn.o_proj.weight": "model-00002-of-00016.safetensors",
+    "model.layers.20.input_layernorm.weight": "model-00010-of-00016.safetensors",
+    "model.layers.20.mlp.down_proj.weight": "model-00010-of-00016.safetensors",
+    "model.layers.20.mlp.gate_proj.weight": "model-00010-of-00016.safetensors",
+    "model.layers.20.mlp.up_proj.weight": "model-00010-of-00016.safetensors",
+    "model.layers.20.post_attention_layernorm.weight": "model-00010-of-00016.safetensors",
+    "model.layers.20.self_attn.W_pack.weight": "model-00010-of-00016.safetensors",
+    "model.layers.20.self_attn.o_proj.weight": "model-00010-of-00016.safetensors",
+    "model.layers.21.input_layernorm.weight": "model-00011-of-00016.safetensors",
+    "model.layers.21.mlp.down_proj.weight": "model-00011-of-00016.safetensors",
+    "model.layers.21.mlp.gate_proj.weight": "model-00011-of-00016.safetensors",
+    "model.layers.21.mlp.up_proj.weight": "model-00011-of-00016.safetensors",
+    "model.layers.21.post_attention_layernorm.weight": "model-00011-of-00016.safetensors",
+    "model.layers.21.self_attn.W_pack.weight": "model-00011-of-00016.safetensors",
+    "model.layers.21.self_attn.o_proj.weight": "model-00011-of-00016.safetensors",
+    "model.layers.22.input_layernorm.weight": "model-00011-of-00016.safetensors",
+    "model.layers.22.mlp.down_proj.weight": "model-00011-of-00016.safetensors",
+    "model.layers.22.mlp.gate_proj.weight": "model-00011-of-00016.safetensors",
+    "model.layers.22.mlp.up_proj.weight": "model-00011-of-00016.safetensors",
+    "model.layers.22.post_attention_layernorm.weight": "model-00011-of-00016.safetensors",
+    "model.layers.22.self_attn.W_pack.weight": "model-00011-of-00016.safetensors",
+    "model.layers.22.self_attn.o_proj.weight": "model-00011-of-00016.safetensors",
+    "model.layers.23.input_layernorm.weight": "model-00012-of-00016.safetensors",
+    "model.layers.23.mlp.down_proj.weight": "model-00012-of-00016.safetensors",
+    "model.layers.23.mlp.gate_proj.weight": "model-00012-of-00016.safetensors",
+    "model.layers.23.mlp.up_proj.weight": "model-00012-of-00016.safetensors",
+    "model.layers.23.post_attention_layernorm.weight": "model-00012-of-00016.safetensors",
+    "model.layers.23.self_attn.W_pack.weight": "model-00011-of-00016.safetensors",
+    "model.layers.23.self_attn.o_proj.weight": "model-00011-of-00016.safetensors",
+    "model.layers.24.input_layernorm.weight": "model-00012-of-00016.safetensors",
+    "model.layers.24.mlp.down_proj.weight": "model-00012-of-00016.safetensors",
+    "model.layers.24.mlp.gate_proj.weight": "model-00012-of-00016.safetensors",
+    "model.layers.24.mlp.up_proj.weight": "model-00012-of-00016.safetensors",
+    "model.layers.24.post_attention_layernorm.weight": "model-00012-of-00016.safetensors",
+    "model.layers.24.self_attn.W_pack.weight": "model-00012-of-00016.safetensors",
+    "model.layers.24.self_attn.o_proj.weight": "model-00012-of-00016.safetensors",
+    "model.layers.25.input_layernorm.weight": "model-00013-of-00016.safetensors",
+    "model.layers.25.mlp.down_proj.weight": "model-00012-of-00016.safetensors",
+    "model.layers.25.mlp.gate_proj.weight": "model-00012-of-00016.safetensors",
+    "model.layers.25.mlp.up_proj.weight": "model-00013-of-00016.safetensors",
+    "model.layers.25.post_attention_layernorm.weight": "model-00013-of-00016.safetensors",
+    "model.layers.25.self_attn.W_pack.weight": "model-00012-of-00016.safetensors",
+    "model.layers.25.self_attn.o_proj.weight": "model-00012-of-00016.safetensors",
+    "model.layers.26.input_layernorm.weight": "model-00013-of-00016.safetensors",
+    "model.layers.26.mlp.down_proj.weight": "model-00013-of-00016.safetensors",
+    "model.layers.26.mlp.gate_proj.weight": "model-00013-of-00016.safetensors",
+    "model.layers.26.mlp.up_proj.weight": "model-00013-of-00016.safetensors",
+    "model.layers.26.post_attention_layernorm.weight": "model-00013-of-00016.safetensors",
+    "model.layers.26.self_attn.W_pack.weight": "model-00013-of-00016.safetensors",
+    "model.layers.26.self_attn.o_proj.weight": "model-00013-of-00016.safetensors",
+    "model.layers.27.input_layernorm.weight": "model-00013-of-00016.safetensors",
+    "model.layers.27.mlp.down_proj.weight": "model-00013-of-00016.safetensors",
+    "model.layers.27.mlp.gate_proj.weight": "model-00013-of-00016.safetensors",
+    "model.layers.27.mlp.up_proj.weight": "model-00013-of-00016.safetensors",
+    "model.layers.27.post_attention_layernorm.weight": "model-00013-of-00016.safetensors",
+    "model.layers.27.self_attn.W_pack.weight": "model-00013-of-00016.safetensors",
+    "model.layers.27.self_attn.o_proj.weight": "model-00013-of-00016.safetensors",
+    "model.layers.28.input_layernorm.weight": "model-00014-of-00016.safetensors",
+    "model.layers.28.mlp.down_proj.weight": "model-00014-of-00016.safetensors",
+    "model.layers.28.mlp.gate_proj.weight": "model-00014-of-00016.safetensors",
+    "model.layers.28.mlp.up_proj.weight": "model-00014-of-00016.safetensors",
+    "model.layers.28.post_attention_layernorm.weight": "model-00014-of-00016.safetensors",
+    "model.layers.28.self_attn.W_pack.weight": "model-00014-of-00016.safetensors",
+    "model.layers.28.self_attn.o_proj.weight": "model-00014-of-00016.safetensors",
+    "model.layers.29.input_layernorm.weight": "model-00014-of-00016.safetensors",
+    "model.layers.29.mlp.down_proj.weight": "model-00014-of-00016.safetensors",
+    "model.layers.29.mlp.gate_proj.weight": "model-00014-of-00016.safetensors",
+    "model.layers.29.mlp.up_proj.weight": "model-00014-of-00016.safetensors",
+    "model.layers.29.post_attention_layernorm.weight": "model-00014-of-00016.safetensors",
+    "model.layers.29.self_attn.W_pack.weight": "model-00014-of-00016.safetensors",
+    "model.layers.29.self_attn.o_proj.weight": "model-00014-of-00016.safetensors",
+    "model.layers.3.input_layernorm.weight": "model-00003-of-00016.safetensors",
+    "model.layers.3.mlp.down_proj.weight": "model-00003-of-00016.safetensors",
+    "model.layers.3.mlp.gate_proj.weight": "model-00003-of-00016.safetensors",
+    "model.layers.3.mlp.up_proj.weight": "model-00003-of-00016.safetensors",
+    "model.layers.3.post_attention_layernorm.weight": "model-00003-of-00016.safetensors",
+    "model.layers.3.self_attn.W_pack.weight": "model-00003-of-00016.safetensors",
+    "model.layers.3.self_attn.o_proj.weight": "model-00003-of-00016.safetensors",
+    "model.layers.30.input_layernorm.weight": "model-00015-of-00016.safetensors",
+    "model.layers.30.mlp.down_proj.weight": "model-00015-of-00016.safetensors",
+    "model.layers.30.mlp.gate_proj.weight": "model-00015-of-00016.safetensors",
+    "model.layers.30.mlp.up_proj.weight": "model-00015-of-00016.safetensors",
+    "model.layers.30.post_attention_layernorm.weight": "model-00015-of-00016.safetensors",
+    "model.layers.30.self_attn.W_pack.weight": "model-00014-of-00016.safetensors",
+    "model.layers.30.self_attn.o_proj.weight": "model-00014-of-00016.safetensors",
+    "model.layers.31.input_layernorm.weight": "model-00015-of-00016.safetensors",
+    "model.layers.31.mlp.down_proj.weight": "model-00015-of-00016.safetensors",
+    "model.layers.31.mlp.gate_proj.weight": "model-00015-of-00016.safetensors",
+    "model.layers.31.mlp.up_proj.weight": "model-00015-of-00016.safetensors",
+    "model.layers.31.post_attention_layernorm.weight": "model-00015-of-00016.safetensors",
+    "model.layers.31.self_attn.W_pack.weight": "model-00015-of-00016.safetensors",
+    "model.layers.31.self_attn.o_proj.weight": "model-00015-of-00016.safetensors",
+    "model.layers.4.input_layernorm.weight": "model-00004-of-00016.safetensors",
+    "model.layers.4.mlp.down_proj.weight": "model-00003-of-00016.safetensors",
+    "model.layers.4.mlp.gate_proj.weight": "model-00003-of-00016.safetensors",
+    "model.layers.4.mlp.up_proj.weight": "model-00004-of-00016.safetensors",
+    "model.layers.4.post_attention_layernorm.weight": "model-00004-of-00016.safetensors",
+    "model.layers.4.self_attn.W_pack.weight": "model-00003-of-00016.safetensors",
+    "model.layers.4.self_attn.o_proj.weight": "model-00003-of-00016.safetensors",
+    "model.layers.5.input_layernorm.weight": "model-00004-of-00016.safetensors",
+    "model.layers.5.mlp.down_proj.weight": "model-00004-of-00016.safetensors",
+    "model.layers.5.mlp.gate_proj.weight": "model-00004-of-00016.safetensors",
+    "model.layers.5.mlp.up_proj.weight": "model-00004-of-00016.safetensors",
+    "model.layers.5.post_attention_layernorm.weight": "model-00004-of-00016.safetensors",
+    "model.layers.5.self_attn.W_pack.weight": "model-00004-of-00016.safetensors",
+    "model.layers.5.self_attn.o_proj.weight": "model-00004-of-00016.safetensors",
+    "model.layers.6.input_layernorm.weight": "model-00004-of-00016.safetensors",
+    "model.layers.6.mlp.down_proj.weight": "model-00004-of-00016.safetensors",
+    "model.layers.6.mlp.gate_proj.weight": "model-00004-of-00016.safetensors",
+    "model.layers.6.mlp.up_proj.weight": "model-00004-of-00016.safetensors",
+    "model.layers.6.post_attention_layernorm.weight": "model-00004-of-00016.safetensors",
+    "model.layers.6.self_attn.W_pack.weight": "model-00004-of-00016.safetensors",
+    "model.layers.6.self_attn.o_proj.weight": "model-00004-of-00016.safetensors",
+    "model.layers.7.input_layernorm.weight": "model-00005-of-00016.safetensors",
+    "model.layers.7.mlp.down_proj.weight": "model-00005-of-00016.safetensors",
+    "model.layers.7.mlp.gate_proj.weight": "model-00005-of-00016.safetensors",
+    "model.layers.7.mlp.up_proj.weight": "model-00005-of-00016.safetensors",
+    "model.layers.7.post_attention_layernorm.weight": "model-00005-of-00016.safetensors",
+    "model.layers.7.self_attn.W_pack.weight": "model-00005-of-00016.safetensors",
+    "model.layers.7.self_attn.o_proj.weight": "model-00005-of-00016.safetensors",
+    "model.layers.8.input_layernorm.weight": "model-00005-of-00016.safetensors",
+    "model.layers.8.mlp.down_proj.weight": "model-00005-of-00016.safetensors",
+    "model.layers.8.mlp.gate_proj.weight": "model-00005-of-00016.safetensors",
+    "model.layers.8.mlp.up_proj.weight": "model-00005-of-00016.safetensors",
+    "model.layers.8.post_attention_layernorm.weight": "model-00005-of-00016.safetensors",
+    "model.layers.8.self_attn.W_pack.weight": "model-00005-of-00016.safetensors",
+    "model.layers.8.self_attn.o_proj.weight": "model-00005-of-00016.safetensors",
+    "model.layers.9.input_layernorm.weight": "model-00006-of-00016.safetensors",
+    "model.layers.9.mlp.down_proj.weight": "model-00006-of-00016.safetensors",
+    "model.layers.9.mlp.gate_proj.weight": "model-00006-of-00016.safetensors",
+    "model.layers.9.mlp.up_proj.weight": "model-00006-of-00016.safetensors",
+    "model.layers.9.post_attention_layernorm.weight": "model-00006-of-00016.safetensors",
+    "model.layers.9.self_attn.W_pack.weight": "model-00005-of-00016.safetensors",
+    "model.layers.9.self_attn.o_proj.weight": "model-00005-of-00016.safetensors",
+    "model.norm.weight": "model-00015-of-00016.safetensors"
+  }
+}

modeling_baichuan.py

@@ -0,0 +1,785 @@
+# Copyright 2023 Baichuan Inc. All Rights Reserved.
+
+# Copyright 2022 EleutherAI and the HuggingFace Inc. team. All rights reserved.
+#
+# This code is based on EleutherAI's GPT-NeoX library and the GPT-NeoX
+# and OPT implementations in this library. It has been modified from its
+# original forms to accommodate minor architectural differences compared
+# to GPT-NeoX and OPT used by the Meta AI team that trained the model.
+#
+# 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.
+
+
+from .configuration_baichuan import BaichuanConfig
+from .generation_utils import build_chat_input, TextIterStreamer
+
+import math
+from typing import List, Optional, Tuple, Union
+from threading import Thread
+
+import torch
+import torch.utils.checkpoint
+from torch import nn
+from torch.nn import BCEWithLogitsLoss, CrossEntropyLoss, MSELoss
+from torch.nn import functional as F
+from transformers import PreTrainedModel, PretrainedConfig
+from transformers.activations import ACT2FN
+from transformers.modeling_outputs import BaseModelOutputWithPast, CausalLMOutputWithPast
+from transformers.generation.utils import GenerationConfig
+from transformers.utils import logging, ContextManagers
+
+import os
+from contextlib import contextmanager
+logger = logging.get_logger(__name__)
+
+try:
+    from xformers import ops as xops
+except ImportError:
+    xops = None
+    logger.warning(
+        "Xformers is not installed correctly. If you want to use memory_efficient_attention to accelerate training use the following command to install Xformers\npip install xformers."
+    )
+
+
+# Copied from transformers.models.bart.modeling_bart._make_causal_mask
+def _make_causal_mask(
+        input_ids_shape: torch.Size, dtype: torch.dtype, device: torch.device, past_key_values_length: int = 0
+):
+    """
+    Make causal mask used for bi-directional self-attention.
+    """
+    bsz, tgt_len = input_ids_shape
+    mask = torch.full((tgt_len, tgt_len), torch.tensor(torch.finfo(dtype).min, device=device), device=device)
+    mask_cond = torch.arange(mask.size(-1), device=device)
+    mask.masked_fill_(mask_cond < (mask_cond + 1).view(mask.size(-1), 1), 0)
+    mask = mask.to(dtype)
+
+    if past_key_values_length > 0:
+        mask = torch.cat([torch.zeros(tgt_len, past_key_values_length, dtype=dtype, device=device), mask], dim=-1)
+    return mask[None, None, :, :].expand(bsz, 1, tgt_len, tgt_len + past_key_values_length)
+
+def _expand_mask(mask: torch.Tensor, dtype: torch.dtype, tgt_len: Optional[int] = None):
+    """
+    Expands attention_mask from `[bsz, seq_len]` to `[bsz, 1, tgt_seq_len, src_seq_len]`.
+    """
+    if len(mask.size()) == 3:
+        bsz, src_len, _ = mask.size()
+        tgt_len = tgt_len if tgt_len is not None else src_len
+        expanded_mask = mask[:,None,:,:].expand(bsz, 1, tgt_len, src_len).to(dtype)
+    else:
+        bsz, src_len = mask.size()
+        tgt_len = tgt_len if tgt_len is not None else src_len
+        expanded_mask = mask[:, None, None, :].expand(bsz, 1, tgt_len, src_len).to(dtype)
+
+    inverted_mask = 1.0 - expanded_mask
+
+    return inverted_mask.masked_fill(inverted_mask.to(torch.bool), torch.finfo(dtype).min)
+
+
+class RMSNorm(nn.Module):
+    def __init__(self, hidden_size, eps=1e-6):
+        """
+        RMSNorm is equivalent to T5LayerNorm
+        """
+        super().__init__()
+        self.weight = nn.Parameter(torch.ones(hidden_size))
+        self.variance_epsilon = eps
+
+    def forward(self, hidden_states):
+        variance = hidden_states.to(torch.float32).pow(2).mean(-1, keepdim=True)
+        hidden_states = hidden_states * torch.rsqrt(variance + self.variance_epsilon)
+
+        # convert into half-precision if necessary
+        if self.weight.dtype in [torch.float16, torch.bfloat16]:
+            hidden_states = hidden_states.to(self.weight.dtype)
+
+        return self.weight * hidden_states
+
+
+class RotaryEmbedding(torch.nn.Module):
+    def __init__(self, dim, max_position_embeddings=2048, base=10000, device=None):
+        super().__init__()
+        self.inv_freq = 1.0 / (base ** (torch.arange(0, dim, 2).float().to(device) / dim))
+        self.max_seq_len_cached = max_position_embeddings
+        t = torch.arange(self.max_seq_len_cached, device=self.inv_freq.device, dtype=torch.float32)
+        freqs = torch.outer(t, self.inv_freq)
+        emb = torch.cat((freqs, freqs), dim=-1)
+        self.cos_cached = emb.cos()[None, None, :, :].to(torch.float32)
+        self.sin_cached = emb.sin()[None, None, :, :].to(torch.float32)
+    def forward(self, x, seq_len=None):
+        # x: [bs, num_attention_heads, seq_len, head_size]
+        # This `if` block is unlikely to be run after we build sin/cos in `__init__`. Keep the logic here just in case.
+        if seq_len > self.max_seq_len_cached:
+            self.max_seq_len_cached = seq_len
+            t = torch.arange(self.max_seq_len_cached, device=self.inv_freq.device, dtype=torch.float32)
+            freqs = torch.outer(t, self.inv_freq)
+            emb = torch.cat((freqs, freqs), dim=-1)
+            self.cos_cached = emb.cos()[None, None, :, :].to(torch.float32).to(x.device)
+            self.sin_cached = emb.sin()[None, None, :, :].to(torch.float32).to(x.device)
+        elif self.cos_cached.device != x.device:
+            self.cos_cached = self.cos_cached.to(x.device)
+            self.sin_cached = self.sin_cached.to(x.device)  
+        return (
+            self.cos_cached[:, :, :seq_len, ...],
+            self.sin_cached[:, :, :seq_len, ...],
+        )
+
+
+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):
+    cos = cos_.squeeze(1).squeeze(0)  # [seq_len, dim]
+    sin = sin_.squeeze(1).squeeze(0)  # [seq_len, dim]
+    cos = cos[position_ids].unsqueeze(1)  # [bs, 1, seq_len, dim]
+    sin = sin[position_ids].unsqueeze(1)  # [bs, 1, seq_len, dim]
+    q_embed = (q.float() * cos) + (rotate_half(q.float()) * sin)
+    k_embed = (k.float() * cos) + (rotate_half(k.float()) * sin)
+    return q_embed.to(q.dtype), k_embed.to(k.dtype)
+
+
+class MLP(nn.Module):
+    def __init__(
+            self,
+            hidden_size: int,
+            intermediate_size: int,
+            hidden_act: str,
+    ):
+        super().__init__()
+        self.gate_proj = nn.Linear(hidden_size, intermediate_size, bias=False)
+        self.down_proj = nn.Linear(intermediate_size, hidden_size, bias=False)
+        self.up_proj = nn.Linear(hidden_size, intermediate_size, bias=False)
+        self.act_fn = ACT2FN[hidden_act]
+
+    def forward(self, x):
+        return self.down_proj(self.act_fn(self.gate_proj(x)) * self.up_proj(x))
+
+
+class Attention(nn.Module):
+    """Multi-headed attention from 'Attention Is All You Need' paper"""
+    def __init__(self, config: BaichuanConfig):
+        super().__init__()
+        self.config = config
+        self.hidden_size = config.hidden_size
+        self.num_heads = config.num_attention_heads
+        self.head_dim = self.hidden_size // self.num_heads
+        self.max_position_embeddings = config.max_position_embeddings
+
+        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.W_pack = nn.Linear(self.hidden_size, 3 * self.hidden_size, bias=False)
+        self.o_proj = nn.Linear(self.num_heads * self.head_dim, self.hidden_size, bias=False)
+        self.rotary_emb = RotaryEmbedding(self.head_dim, max_position_embeddings=self.max_position_embeddings)
+
+    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[Tuple[torch.Tensor]] = None,
+            output_attentions: bool = False,
+            use_cache: bool = False,
+    ) -> Tuple[torch.Tensor, Optional[torch.Tensor], Optional[Tuple[torch.Tensor]]]:
+        bsz, q_len, _ = hidden_states.size()
+
+        proj = self.W_pack(hidden_states)
+        proj = proj.unflatten(-1, (3, self.hidden_size)).unsqueeze(0).transpose(0, -2).squeeze(-2)
+        query_states = proj[0].view(bsz, q_len, self.num_heads, self.head_dim).transpose(1, 2)
+        key_states = proj[1].view(bsz, q_len, self.num_heads, self.head_dim).transpose(1, 2)
+        value_states = proj[2].view(bsz, q_len, self.num_heads, self.head_dim).transpose(1, 2)
+
+        kv_seq_len = key_states.shape[-2]
+        if past_key_value is not None:
+            kv_seq_len += past_key_value[0].shape[-2]
+        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)
+        # [bsz, nh, t, hd]
+
+        if past_key_value is not None:
+            # reuse k, v, self_attention
+            key_states = torch.cat([past_key_value[0], key_states], dim=2)
+            value_states = torch.cat([past_key_value[1], value_states], dim=2)
+
+        past_key_value = (key_states, value_states) if use_cache else None
+        if xops is not None and self.training:
+            attn_weights = None
+            query_states = query_states.transpose(1, 2)
+            key_states = key_states.transpose(1, 2)
+            value_states = value_states.transpose(1, 2)
+            attn_output = xops.memory_efficient_attention(
+                query_states, key_states, value_states, attn_bias=xops.LowerTriangularMask()
+            )
+        else:
+            with torch.backends.cuda.sdp_kernel(enable_flash=True, enable_math=True, enable_mem_efficient=True):
+                attn_output = F.scaled_dot_product_attention(query_states, key_states, value_states, attn_mask = attention_mask)
+            attn_output = attn_output.transpose(1, 2)
+        attn_output = attn_output.reshape(bsz, q_len, self.hidden_size)
+        attn_output = self.o_proj(attn_output)
+
+        if not output_attentions:
+            attn_weights = None
+
+        return attn_output, attn_weights, past_key_value
+
+
+class DecoderLayer(nn.Module):
+    def __init__(self, config: BaichuanConfig):
+        super().__init__()
+        self.hidden_size = config.hidden_size
+        self.self_attn = Attention(config=config)
+        self.mlp = MLP(
+            hidden_size=self.hidden_size,
+            intermediate_size=config.intermediate_size,
+            hidden_act=config.hidden_act,
+        )
+        self.input_layernorm = RMSNorm(config.hidden_size, eps=config.rms_norm_eps)
+        self.post_attention_layernorm = RMSNorm(config.hidden_size, eps=config.rms_norm_eps)
+
+    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,
+    ) -> Tuple[torch.FloatTensor, Optional[Tuple[torch.FloatTensor, torch.FloatTensor]]]:
+
+        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,
+        )
+        hidden_states = residual + hidden_states
+
+        # Fully Connected
+        residual = hidden_states
+        hidden_states = self.post_attention_layernorm(hidden_states)
+        hidden_states = self.mlp(hidden_states)
+        hidden_states = residual + hidden_states
+
+        outputs = (hidden_states,)
+
+        if output_attentions:
+            outputs += (self_attn_weights,)
+
+        if use_cache:
+            outputs += (present_key_value,)
+
+        return outputs
+
+
+class BaichuanPreTrainedModel(PreTrainedModel):
+    config_class = BaichuanConfig
+    base_model_prefix = "model"
+    supports_gradient_checkpointing = True
+    _no_split_modules = ["DecoderLayer"]
+    _keys_to_ignore_on_load_unexpected = [r"decoder\.version"]
+
+    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_()
+
+    def _set_gradient_checkpointing(self, module, value=False):
+        if isinstance(module, BaichuanModel):
+            module.gradient_checkpointing = value
+
+
+class BaichuanModel(BaichuanPreTrainedModel):
+    def __init__(self, config: BaichuanConfig):
+        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([DecoderLayer(config) for _ in range(config.num_hidden_layers)])
+        self.norm = RMSNorm(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
+
+    # Copied from transformers.models.bart.modeling_bart.BartDecoder._prepare_decoder_attention_mask
+    def _prepare_decoder_attention_mask(self, attention_mask, input_shape, inputs_embeds, past_key_values_length):
+        # create causal mask
+        # [bsz, seq_len] -> [bsz, 1, tgt_seq_len, src_seq_len]
+        combined_attention_mask = None
+        if input_shape[-1] > 1:
+            combined_attention_mask = _make_causal_mask(
+                input_shape,
+                inputs_embeds.dtype,
+                device=inputs_embeds.device,
+                past_key_values_length=past_key_values_length,
+            )
+
+        if attention_mask is not None:
+            # [bsz, seq_len] -> [bsz, 1, tgt_seq_len, src_seq_len]
+            expanded_attn_mask = _expand_mask(attention_mask, inputs_embeds.dtype, tgt_len=input_shape[-1]).to(
+                inputs_embeds.device
+            )
+            combined_attention_mask = (
+                expanded_attn_mask if combined_attention_mask is None else expanded_attn_mask + combined_attention_mask
+            )
+
+        return combined_attention_mask
+
+    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 decoder_input_ids and decoder_inputs_embeds at the same time")
+        elif input_ids is not None:
+            batch_size, seq_length = input_ids.shape
+        elif inputs_embeds is not None:
+            batch_size, seq_length, _ = inputs_embeds.shape
+        else:
+            raise ValueError("You have to specify either decoder_input_ids or decoder_inputs_embeds")
+
+        seq_length_with_past = seq_length
+        past_key_values_length = 0
+
+        if past_key_values is not None:
+            past_key_values_length = past_key_values[0][0].shape[2]
+            seq_length_with_past = seq_length_with_past + past_key_values_length
+
+        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).view(-1, seq_length)
+        else:
+            position_ids = position_ids.view(-1, seq_length).long()
+
+        if inputs_embeds is None:
+            inputs_embeds = self.embed_tokens(input_ids)
+        # embed positions
+        if attention_mask is None:
+            attention_mask = torch.ones(
+                (batch_size, seq_length_with_past), dtype=torch.bool, device=inputs_embeds.device
+            )
+        attention_mask = self._prepare_decoder_attention_mask(
+            attention_mask, (batch_size, seq_length), inputs_embeds, past_key_values_length
+        )
+
+        hidden_states = 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
+
+        # decoder layers
+        all_hidden_states = () if output_hidden_states else None
+        all_self_attns = () if output_attentions else None
+        next_decoder_cache = () if use_cache else None
+
+        for idx, decoder_layer in enumerate(self.layers):
+            if output_hidden_states:
+                all_hidden_states += (hidden_states,)
+
+            past_key_value = past_key_values[idx] if past_key_values is not None else None
+
+            if self.gradient_checkpointing and self.training:
+
+                def create_custom_forward(module):
+                    def custom_forward(*inputs):
+                        # None for past_key_value
+                        return module(*inputs, output_attentions, None)
+
+                    return custom_forward
+
+                layer_outputs = torch.utils.checkpoint.checkpoint(
+                    create_custom_forward(decoder_layer),
+                    hidden_states,
+                    attention_mask,
+                    position_ids,
+                    None,
+                )
+            else:
+                layer_outputs = decoder_layer(
+                    hidden_states,
+                    attention_mask=attention_mask,
+                    position_ids=position_ids,
+                    past_key_value=past_key_value,
+                    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 = next_decoder_cache if use_cache else None
+        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 NormHead(nn.Module):
+    def __init__(self, hidden_size, vocab_size, bias=False):
+        super().__init__()
+        self.weight = nn.Parameter(torch.empty((vocab_size, hidden_size)))
+        nn.init.kaiming_uniform_(self.weight, a=math.sqrt(5))
+        self.first_flag = True
+
+    def forward(self, hidden_states):
+        if self.training:
+            norm_weight = nn.functional.normalize(self.weight)
+            self.first_flag = True
+        elif self.first_flag:
+            self.first_flag = False
+            self.weight.data = nn.functional.normalize(self.weight)
+            norm_weight = self.weight
+        else:
+            norm_weight = self.weight
+        return nn.functional.linear(hidden_states, norm_weight)
+
+_init_weights = True
+@contextmanager
+def no_init_weights(_enable=True):
+    global _init_weights
+    old_init_weights = _init_weights
+    if _enable:
+        _init_weights = False
+    try:
+        yield
+    finally:
+        _init_weights = old_init_weights
+
+class BaichuanForCausalLM(BaichuanPreTrainedModel):
+    def __init__(self, config, *model_args, **model_kwargs):
+        super().__init__(config, *model_args, **model_kwargs)
+        self.model = BaichuanModel(config)
+
+        self.lm_head = NormHead(config.hidden_size, config.vocab_size, bias=False)
+        if hasattr(config, "quantization_config") and isinstance(config.quantization_config, dict) and config.quantization_config.get('load_in_4bit', False):
+            try:
+                from .quantizer import quantize_offline, init_model_weight_int4
+            except ImportError:
+                raise ImportError(f"Needs QLinear to run quantize.")
+            quantize_offline(self, 4)
+        # 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
+    
+    @classmethod
+    def from_pretrained(
+        cls,
+        pretrained_model_name_or_path: Optional[Union[str, os.PathLike]],
+        *model_args,
+        config: Optional[Union[PretrainedConfig, str, os.PathLike]] = None,
+        cache_dir: Optional[Union[str, os.PathLike]] = None,
+        ignore_mismatched_sizes: bool = False,
+        force_download: bool = False,
+        local_files_only: bool = False,
+        token: Optional[Union[str, bool]] = None,
+        revision: str = "main",
+        use_safetensors: bool = None,
+        **kwargs,
+    ):
+        # Load config if we don't provide a configuration
+        if not isinstance(config, PretrainedConfig):
+            config_path = config if config is not None else pretrained_model_name_or_path
+            config, model_kwargs = cls.config_class.from_pretrained(
+                config_path,
+                cache_dir=cache_dir,
+                return_unused_kwargs=True,
+                force_download=force_download,
+                resume_download=False,
+                proxies=None,
+                local_files_only=local_files_only,
+                token=token,
+                revision=revision,
+                subfolder="",
+                _from_auto=False,
+                _from_pipeline=None,
+                **kwargs,
+            )
+        else:
+            model_kwargs = kwargs
+        
+        if hasattr(config, "quantization_config") and config.quantization_config['load_in_4bit']:
+            try:
+                from .quantizer import init_model_weight_int4
+                from accelerate import init_empty_weights, dispatch_model, infer_auto_device_map
+                from accelerate.utils import CustomDtype
+                from accelerate.utils import get_balanced_memory
+            except ImportError:
+                raise ImportError(f"Needs import model weight init func to run quantize.") 
+            # Instantiate model.
+            init_contexts = [no_init_weights(_enable=True)]
+            init_contexts.append(init_empty_weights())
+            with ContextManagers(init_contexts):
+                model = cls(config)
+            
+            model_file = os.path.join(pretrained_model_name_or_path, 'pytorch_model.bin')
+            state_dict = torch.load(model_file, map_location="cpu") 
+            model.is_quantized = True
+            
+            device_map = kwargs.pop("device_map", None)
+            torch_dtype = kwargs.pop("torch_dtype", None)
+            
+            if device_map is not None:
+                kwargs = {"no_split_module_classes": model._no_split_modules}
+                target_dtype = CustomDtype.INT4
+                max_memory = get_balanced_memory(
+                    model,
+                    dtype=target_dtype,
+                    low_zero=(device_map == "balanced_low_0"),
+                    max_memory=None,
+                    **kwargs,
+                )
+                kwargs["max_memory"] = max_memory
+                device_map = infer_auto_device_map(model, dtype=target_dtype, **kwargs)
+                
+            model = init_model_weight_int4(config, model, state_dict)
+            
+            # Set model in evaluation mode to deactivate DropOut modules by default
+            model.eval()
+            # If it is a model with generation capabilities, attempt to load the generation config
+            if model.can_generate():
+                try:
+                    model.generation_config = GenerationConfig.from_pretrained(
+                        pretrained_model_name_or_path,
+                        cache_dir=cache_dir,
+                        force_download=force_download,
+                        resume_download=False,
+                        proxies=None,
+                        local_files_only=local_files_only,
+                        token=token,
+                        revision=revision,
+                        subfolder="",
+                        _from_auto=False,
+                        _from_pipeline=None,
+                        **kwargs,
+                    )
+                except (OSError, TypeError):
+                    logger.info(
+                        "Generation config file not found, using a generation config created from the model config."
+                    )
+                    pass
+            
+            if device_map is not None:
+                dispatch_model(model, device_map=device_map)
+            
+            return model
+        return super(BaichuanForCausalLM, cls).from_pretrained(pretrained_model_name_or_path, *model_args, 
+                config=config, cache_dir=cache_dir, ignore_mismatched_sizes=ignore_mismatched_sizes, 
+                force_download=force_download, local_files_only=local_files_only, token=token, revision=revision, 
+                use_safetensors=use_safetensors, **kwargs)   
+
+    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, CausalLMOutputWithPast]:
+
+        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]
+        logits = self.lm_head(hidden_states)
+        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)
+            softmax_normalizer = shift_logits.max(-1).values ** 2
+            z_loss = self.config.z_loss_weight * softmax_normalizer.mean()
+            # Enable model parallelism
+            shift_labels = shift_labels.to(shift_logits.device)
+            loss = loss_fct(shift_logits, shift_labels) + z_loss
+
+        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:
+            input_ids = input_ids[:, -1:]
+
+        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[:, -1].unsqueeze(-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,
+            }
+        )
+        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) for past_state in layer_past),)
+        return reordered_past
+
+    def quantize(self, bits: int):
+        try:
+            from .quantizer import quantize_online
+        except ImportError:
+            raise ImportError(f"Needs QLinear to run quantize.")
+        return quantize_online(self, bits)
+
+    def chat(self, tokenizer, messages: List[dict], stream=False,
+             generation_config: Optional[GenerationConfig]=None):
+        generation_config = generation_config or self.generation_config
+        input_ids = build_chat_input(self, tokenizer, messages, generation_config.max_new_tokens)
+        if stream:
+            streamer = TextIterStreamer(tokenizer, skip_prompt=True, skip_special_tokens=True)
+            Thread(target=self.generate, kwargs=dict(
+                inputs=input_ids, streamer=streamer,
+                generation_config=generation_config,
+            )).start()
+            return streamer
+        else:
+            outputs = self.generate(input_ids, generation_config=generation_config)
+            response = tokenizer.decode(outputs[0][len(input_ids[0]):], skip_special_tokens=True)
+            return response

quantizer.py

@@ -0,0 +1,210 @@
+import bitsandbytes as bnb
+from bitsandbytes.nn.modules import Params4bit, Int8Params
+import torch 
+
+def Params4bitCuda(self, device):
+    self.data = self.data.cuda(device)
+    self.quant_state[0] = self.quant_state[0].cuda(device)
+    self.quant_state[4][0] = self.quant_state[4][0].cuda(device)
+    self.quant_state[4][1][0] = self.quant_state[4][1][0].cuda(device)
+    self.quant_state[4][1][1] = self.quant_state[4][1][1].cuda(device)
+
+    self.quant_state[6] = self.quant_state[6].cuda(device)
+    return self
+
+class Linear4bitOnline(torch.nn.Module):
+    def __init__(self, weight, bias, quant_type):
+        super().__init__()
+        self.weight = Params4bit(
+            weight.data, requires_grad=False, compress_statistics=True, quant_type=quant_type
+        )
+        self.compute_dtype = None
+        #self.weight.cuda(weight.device)
+        self.bias = bias
+
+    def forward(self, x: torch.Tensor):
+        # weights are cast automatically as Int8Params, but the bias has to be cast manually
+        if self.bias is not None and self.bias.dtype != x.dtype:
+            self.bias.data = self.bias.data.to(x.dtype)
+
+        if getattr(self.weight, "quant_state", None) is None:
+            print(
+                "FP4 quantization state not initialized. Please call .cuda() or .to(device) on the LinearFP4 layer first."
+            )
+        inp_dtype = x.dtype
+        if self.compute_dtype is not None:
+            x = x.to(self.compute_dtype)
+
+        bias = None if self.bias is None else self.bias.to(self.compute_dtype)
+        out = bnb.matmul_4bit(
+            x, self.weight.t(), bias=bias, quant_state=self.weight.quant_state
+        )
+
+        out = out.to(inp_dtype)
+
+        return out
+    
+class Linear8bitLtOnline(torch.nn.Module):
+    def __init__(
+        self,
+        weight,
+        bias,
+        has_fp16_weights=True,
+        memory_efficient_backward=False,
+        threshold=0.0,
+        index=None,
+    ):
+        super().__init__()
+        assert (
+            not memory_efficient_backward
+        ), "memory_efficient_backward is no longer required and the argument is deprecated in 0.37.0 and will be removed in 0.39.0"
+        self.state = bnb.MatmulLtState()
+        self.index = index
+
+        # Necessary for stacked layers
+        self.state.threshold = threshold
+        self.state.has_fp16_weights = has_fp16_weights
+        self.state.memory_efficient_backward = memory_efficient_backward
+        if threshold > 0.0 and not has_fp16_weights:
+            self.state.use_pool = True
+
+        self.weight = Int8Params(
+            weight.data,
+            has_fp16_weights=has_fp16_weights,
+            requires_grad=has_fp16_weights,
+        )
+        self.bias = bias
+
+    def init_8bit_state(self):
+        self.state.CB = self.weight.CB
+        self.state.SCB = self.weight.SCB
+        self.weight.CB = None
+        self.weight.SCB = None
+
+    def forward(self, x: torch.Tensor):
+        self.state.is_training = self.training
+        if self.weight.CB is not None:
+            self.init_8bit_state()
+
+        # weights are cast automatically as Int8Params, but the bias has to be cast manually
+        if self.bias is not None and self.bias.dtype != x.dtype:
+            self.bias.data = self.bias.data.to(x.dtype)
+        
+        out = bnb.matmul(x, self.weight, bias=self.bias, state=self.state)
+
+        if not self.state.has_fp16_weights:
+            if self.state.CB is not None and self.state.CxB is not None:
+                # we converted 8-bit row major to turing/ampere format in the first inference pass
+                # we no longer need the row-major weight
+                del self.state.CB
+                self.weight.data = self.state.CxB
+        return out
+    
+def quantize_offline(model, bits: int):
+    assert (bits == 4), f'bits: {bits} is not supported'
+    
+    for i, layer in enumerate(model.model.layers):
+        layer.self_attn.W_pack = bnb.nn.Linear4bit(
+                            layer.self_attn.W_pack.weight.shape[1],
+                            layer.self_attn.W_pack.weight.shape[0],
+                            False,
+                            torch.float16,
+                            compress_statistics=True,
+                            quant_type="nf4",
+                        )
+        layer.self_attn.o_proj = bnb.nn.Linear4bit(
+                            layer.self_attn.o_proj.weight.shape[1],
+                            layer.self_attn.o_proj.weight.shape[0],
+                            False,
+                            torch.float16,
+                            compress_statistics=True,
+                            quant_type="nf4",
+                        )
+
+        layer.mlp.gate_proj = bnb.nn.Linear4bit(
+                            layer.mlp.gate_proj.weight.shape[1],
+                            layer.mlp.gate_proj.weight.shape[0],
+                            False,
+                            torch.float16,
+                            compress_statistics=True,
+                            quant_type="nf4",
+                        )
+        layer.mlp.down_proj = bnb.nn.Linear4bit(
+                            layer.mlp.down_proj.weight.shape[1],
+                            layer.mlp.down_proj.weight.shape[0],
+                            False,
+                            torch.float16,
+                            compress_statistics=True,
+                            quant_type="nf4",
+                        )
+        layer.mlp.up_proj = bnb.nn.Linear4bit(
+                            layer.mlp.up_proj.weight.shape[1],
+                            layer.mlp.up_proj.weight.shape[0],
+                            False,
+                            torch.float16,
+                            compress_statistics=True,
+                            quant_type="nf4",
+                        )
+    return model
+
+def quantize_online(model, bits: int):
+    def quant(weight, bias=None):
+        if bits == 8:
+            linear = Linear8bitLtOnline(
+                weight,
+                bias,
+                has_fp16_weights=False,
+                threshold=6.0,
+            )
+            if bias is not None:
+                linear.bias = torch.nn.Parameter(bias)
+        elif bits == 4:
+            linear = Linear4bitOnline(
+                weight,
+                bias,
+                quant_type="nf4", #fp4/nf4
+            )
+        else:
+            raise ValueError("quantize only support 4/8 bit")
+        return linear
+
+    for i, layer in enumerate(model.model.layers):
+        layer.self_attn.W_pack = quant(layer.self_attn.W_pack.weight)
+        layer.self_attn.o_proj = quant(layer.self_attn.o_proj.weight)
+        layer.mlp.gate_proj = quant(layer.mlp.gate_proj.weight)
+        layer.mlp.down_proj = quant(layer.mlp.down_proj.weight)
+        layer.mlp.up_proj = quant(layer.mlp.up_proj.weight)
+    return model
+
+def init_model_weight_int4(config, model, state_dict):
+    #replace Params4bit.cuda with Params4bitCuda
+    Params4bit.cuda = Params4bitCuda
+
+    for i in range(config.num_hidden_layers):
+        weight_data = state_dict[f'model.layers.{i}.self_attn.W_pack.weight.data']
+        weight_quant_state = state_dict[f'model.layers.{i}.self_attn.W_pack.weight.quant_state']
+        model.model.layers[i].self_attn.W_pack.weight = Params4bit(weight_data, requires_grad=False, quant_state=weight_quant_state)
+        
+        weight_data = state_dict[f'model.layers.{i}.self_attn.o_proj.weight.data']
+        weight_quant_state = state_dict[f'model.layers.{i}.self_attn.o_proj.weight.quant_state']
+        model.model.layers[i].self_attn.o_proj.weight = Params4bit(weight_data, requires_grad=False, quant_state=weight_quant_state)
+        
+        weight_data = state_dict[f'model.layers.{i}.mlp.gate_proj.weight.data']
+        weight_quant_state = state_dict[f'model.layers.{i}.mlp.gate_proj.weight.quant_state']
+        model.model.layers[i].mlp.gate_proj.weight = Params4bit(weight_data, requires_grad=False, quant_state=weight_quant_state)
+        
+        weight_data = state_dict[f'model.layers.{i}.mlp.up_proj.weight.data']
+        weight_quant_state = state_dict[f'model.layers.{i}.mlp.up_proj.weight.quant_state']
+        model.model.layers[i].mlp.up_proj.weight = Params4bit(weight_data, requires_grad=False, quant_state=weight_quant_state)
+        
+        weight_data = state_dict[f'model.layers.{i}.mlp.down_proj.weight.data']
+        weight_quant_state = state_dict[f'model.layers.{i}.mlp.down_proj.weight.quant_state']
+        model.model.layers[i].mlp.down_proj.weight = Params4bit(weight_data, requires_grad=False, quant_state=weight_quant_state)
+        
+        model.model.layers[i].input_layernorm.weight = state_dict[f'model.layers.{i}.input_layernorm.weight']
+        model.model.layers[i].post_attention_layernorm.weight = state_dict[f'model.layers.{i}.post_attention_layernorm.weight']
+    
+    model.model.embed_tokens.weight = state_dict['model.embed_tokens.weight']
+    model.model.norm.weight = state_dict['model.norm.weight']
+    model.lm_head.weight = state_dict['lm_head.weight'] 
+    return model