TensorRT-LLMs/tensorrt_llm/models/chatglm/model.py

# SPDX-FileCopyrightText: Copyright (c) 2022-2023 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
#
# 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.
import argparse

import tensorrt as trt

from ..._common import default_net
from ..._utils import pad_vocab_size, str_dtype_to_trt
from ...functional import (PositionEmbeddingType, Tensor,
                           gather_last_token_logits)
from ...layers import (MLP, Attention, AttentionMaskType, AttentionParams,
                       ColumnLinear, Embedding, KeyValueCacheParams, LayerNorm,
                       RmsNorm)
from ...module import Module, ModuleList
from ..generation_mixin import GenerationMixin


class ChatGLMDecoderLayer(Module):

    def __init__(self, layer_id, args):

        super().__init__()

        self.model_version = args.model_version
        self.use_cache = args.use_cache

        if self.model_version == "1":
            self.alpha = (2 * args.num_layers)**0.5
            self.norm = LayerNorm
        else:
            self.apply_residual_connection_post_layernorm = args.apply_residual_connection_post_layernorm
            self.norm = RmsNorm if args.rmsnorm else LayerNorm

        self.pre_norm = self.norm(
            normalized_shape=args.hidden_size,
            eps=args.norm_epsilon,
            elementwise_affine=True,
            dtype=args.dtype,
        )

        self.attention = Attention(
            hidden_size=args.hidden_size,
            num_attention_heads=args.num_heads,
            num_kv_heads=args.num_kv_heads,
            max_position_embeddings=args.max_seq_length,
            num_layers=args.num_layers,
            apply_query_key_layer_scaling=args.apply_query_key_layer_scaling,
            attention_mask_type=AttentionMaskType.bidirectional
            if args.model_version == "1" else AttentionMaskType.causal,
            bias=args.qkv_bias,
            dtype=args.dtype,
            position_embedding_type=PositionEmbeddingType.chatglm
            if args.model_version == "1" else PositionEmbeddingType.rope_gptj,
            rotary_embedding_base=10000.0,
            rotary_embedding_scaling=None,
            use_int8_kv_cache=args.quant_mode.has_int8_kv_cache(),
            rotary_embedding_percentage=0.5,
            tp_group=args.mapping.tp_group,
            tp_size=args.mapping.tp_size,
            tp_rank=args.mapping.rank,
            multi_block_mode=args.multi_block_mode,
            quant_mode=args.quant_mode,
            q_scaling=1.0,
            cross_attention=False,
            relative_attention=False,
            max_distance=0,
            num_buckets=0,
            instance_id=layer_id * 2,
            dense_bias=args.linear_bias,
        )

        self.mlp = MLP(
            hidden_size=args.hidden_size,
            ffn_hidden_size=args.ffn_hidden_size,
            hidden_act=args.hidden_act,
            bias=args.linear_bias,
            dtype=args.dtype,
            tp_group=args.mapping.tp_group,
            tp_size=args.mapping.tp_size,
            quant_mode=args.quant_mode,
            instance_id=layer_id * 2 + 1,
        )

        self.post_norm = self.norm(
            normalized_shape=args.hidden_size,
            eps=args.norm_epsilon,
            elementwise_affine=True,
            dtype=args.dtype,
        )

    def forward(
        self,
        hidden_states: Tensor,
        position_ids: Tensor = None,  # only used in ChatGLM-6B
        kv_cache_params: KeyValueCacheParams = None,
        attention_params: AttentionParams = None,
    ):

        norm_output = self.pre_norm(hidden_states)

        attention_output = self.attention(
            hidden_states=norm_output,
            attention_mask=None,
            use_cache=self.use_cache,
            kv_cache_params=kv_cache_params,
            attention_params=attention_params,
            encoder_output=None,
            workspace=None,
            position_embedding=position_ids,
        )

        if self.use_cache:
            attention_output, presents = attention_output

        if self.model_version == "1":
            residual = norm_output

            norm_input = residual * self.alpha + attention_output

            norm_output = self.post_norm(norm_input)

            mlp_output = self.mlp(norm_output)

            residual = norm_output

            output = residual * self.alpha + mlp_output

        else:
            residual = norm_output if self.apply_residual_connection_post_layernorm else hidden_states

            norm_input = residual + attention_output

            norm_output = self.post_norm(norm_input)

            mlp_output = self.mlp(norm_output)

            residual = norm_output if self.apply_residual_connection_post_layernorm else norm_input

            output = residual + mlp_output

        return (output, presents) if self.use_cache else output


class ChatGLMModel(Module):

    def __init__(self, args):

        super().__init__()

        self.norm = LayerNorm if args.model_version == "1" else RmsNorm
        self.use_cache = args.use_cache

        self.embedding = Embedding(
            num_embeddings=args.vocab_size,
            embedding_dim=args.hidden_size,
            dtype=args.dtype,
            tp_size=1,  #args.mapping.tp_size,
            tp_group=None,  #args.mapping.tp_group,
            sharding_dim=0,
            tp_rank=0,  #args.mapping.rank,
            instance_id=args.num_layers * 2,
        )

        self.layers = ModuleList(
            ChatGLMDecoderLayer(i, args) for i in range(args.num_layers))

        self.final_norm = self.norm(
            normalized_shape=args.hidden_size,
            eps=args.norm_epsilon,
            elementwise_affine=True,
            dtype=args.dtype,
        )

    def forward(
        self,
        input_ids: Tensor = None,
        position_ids: Tensor = None,  # only used in ChatGLM-6B
        kv_cache_params: KeyValueCacheParams = None,
        attention_params: AttentionParams = None,
    ):

        hidden_states = self.embedding(input_ids)

        if self.use_cache:
            presents = []

        for layer, past_key_value, kv_cache_block_pointers in zip(
                self.layers, kv_cache_params.past_key_value,
                kv_cache_params.kv_cache_block_pointers):
            layer_output = layer(
                hidden_states,
                position_ids,
                kv_cache_params=KeyValueCacheParams(
                    past_key_value=[past_key_value],
                    kv_cache_block_pointers=[kv_cache_block_pointers],
                    host_past_key_value_lengths=kv_cache_params.
                    host_past_key_value_lengths,
                    cache_indirection=kv_cache_params.cache_indirection,
                ),
                attention_params=attention_params,
            )

            if self.use_cache:
                hidden_states = layer_output[0]
                presents.append(layer_output[1])

        hidden_states = self.final_norm(hidden_states)

        return (hidden_states,
                tuple(presents)) if self.use_cache else hidden_states


class ChatGLMHeadModel(ChatGLMModel, GenerationMixin):

    def __init__(self, **args):

        if "args" not in args.keys():
            argNamespace = argparse.Namespace()
            for key, value in args.items():
                argNamespace.__setattr__(key, value)
            assert "model_version" in args.keys(), "model_version not set"
            # Other default values
            argNamespace.multi_block_mode = False
            argNamespace.norm_epsilon = 1.0e-5
            argNamespace.tokens_per_block = 64
            argNamespace.use_cache = True
            if argNamespace.model_version == "1":
                argNamespace.ffn_hidden_size = 16384
                argNamespace.linear_bias = True
                argNamespace.max_seq_length = min(
                    2048, argNamespace.max_position_embeddings)
                argNamespace.num_kv_heads = 32
                argNamespace.qkv_bias = True
            else:
                argNamespace.apply_residual_connection_post_layernorm = False
                argNamespace.ffn_hidden_size = 13696
                argNamespace.linear_bias = False
                argNamespace.num_kv_heads = 2
                argNamespace.qkv_bias = True
                argNamespace.rmsnorm = True

            args = argNamespace
        else:
            args = args["args"]

        self.init(args)

    def init(self, args):

        super().__init__(args)

        if isinstance(args.dtype, str):
            self.kv_dtype = str_dtype_to_trt(args.dtype)
        else:
            assert isinstance(args.dtype, trt.DataType)
            self.kv_dtype = args.dtype
        self.dtype = self.kv_dtype

        if args.quant_mode.has_int8_kv_cache():
            self.kv_dtype = str_dtype_to_trt('int8')
        elif args.quant_mode.has_fp8_kv_cache():
            self.kv_dtype = str_dtype_to_trt('fp8')

        self.hidden_size = args.hidden_size
        self.mapping = args.mapping
        self.max_num_tokens = args.max_output_len + args.max_input_len
        self.model_version = args.model_version
        self.num_heads = args.num_heads
        self.num_kv_heads = args.num_kv_heads
        self.num_layers = args.num_layers
        self.tokens_per_block = args.tokens_per_block
        self.use_cache = args.use_cache

        self.lm_head = ColumnLinear(
            in_features=self.hidden_size,
            out_features=pad_vocab_size(args.vocab_size, self.mapping.tp_size),
            bias=False,
            dtype=self.dtype,
            tp_group=self.mapping.tp_group,
            tp_size=self.mapping.tp_size,
            gather_output=True,
        )

    def forward(
        self,
        input_ids: Tensor = None,
        position_ids: Tensor = None,  # only used in ChatGLM-6B
        last_token_ids: Tensor = None,
        kv_cache_params: KeyValueCacheParams = None,
        attention_params: AttentionParams = None,
    ):

        hidden_states = super().forward(
            input_ids,
            position_ids,
            kv_cache_params,
            attention_params,
        )

        if self.use_cache:
            hidden_states, presents = hidden_states

        hidden_states = gather_last_token_logits(
            hidden_states, last_token_ids,
            default_net().plugin_config.remove_input_padding)

        lm_logits = self.lm_head(hidden_states)
        lm_logits.mark_output('logits', self.dtype)

        if self.use_cache and default_net(
        ).plugin_config.paged_kv_cache == False:
            for i, present in enumerate(presents):
                present.mark_output(f'present_key_value_{i}', self.kv_dtype)
            return (lm_logits, presents)

        return lm_logits

    def prepare_inputs(
        self,
        max_batch_size: int = 0,
        max_input_len: int = 0,
        max_new_tokens: int = 0,
        use_cache: bool = True,
        max_beam_width: int = 1,
    ):
        '''@brief: Prepare inputs Tensors for the model, the given sizes are used to determine the
            ranges of the dimensions of when using TRT dynamic shapes.

            @return: a list contains values which can be fed into the self.forward()
        '''

        model_inputs = self.prepare_basic_inputs(
            max_batch_size=max_batch_size,
            max_beam_width=max_beam_width,
            max_input_len=max_input_len,
            max_new_tokens=max_new_tokens,
            num_kv_heads=self.num_kv_heads // self.mapping.tp_size,
            head_size=self.hidden_size // self.num_heads,
            num_layers=self.num_layers,
            kv_dtype=self.kv_dtype,
            remove_input_padding=default_net(
            ).plugin_config.remove_input_padding,
            use_gpt_attention_plugin=default_net().plugin_config.
            gpt_attention_plugin,
            use_gemm_plugin=default_net().plugin_config.gemm_plugin,
            use_custom_all_reduce=False,
            paged_kv_cache=default_net().plugin_config.paged_kv_cache,
            tokens_per_block=self.tokens_per_block,
            gather_all_token_logits=False,
            dtype=self.kv_dtype,
            num_heads=self.num_heads,
            mapping=self.mapping,
            max_num_tokens=self.max_num_tokens,
            prompt_embedding_table_size=0,
            is_chatglm6b=(self.model_version == "1"),
        )

        return (model_inputs['input_ids'], model_inputs['position_ids'],
                model_inputs['last_token_ids'],
                KeyValueCacheParams(
                    past_key_value=model_inputs['past_key_value'],
                    host_past_key_value_lengths=model_inputs[
                        'host_past_key_value_lengths'],
                    kv_cache_block_pointers=model_inputs[
                        'kv_cache_block_pointers_list'],
                    cache_indirection=model_inputs['cache_indirection'],
                ),
                AttentionParams(
                    sequence_length=model_inputs['sequence_length'],
                    context_lengths=model_inputs['context_lengths'],
                    host_context_lengths=model_inputs['host_context_lengths'],
                    max_context_length=max_input_len,
                    host_request_types=model_inputs['host_request_types'],
                ))