xinference 1.1.1__py3-none-any.whl → 1.2.0__py3-none-any.whl

xinference/model/llm/transformers/cogagent.py

@@ -0,0 +1,272 @@
+# Copyright 2022-2023 XProbe Inc.
+#
+# 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 logging
+import re
+import uuid
+from concurrent.futures import ThreadPoolExecutor
+from typing import Dict, Iterator, List, Literal, Optional, Union
+
+import torch
+
+from ....model.utils import select_device
+from ....types import (
+    ChatCompletion,
+    ChatCompletionChunk,
+    CogagentGenerateConfig,
+    CompletionChunk,
+)
+from ..llm_family import LLMFamilyV1, LLMSpecV1
+from ..utils import (
+    _decode_image,
+    generate_chat_completion,
+    generate_completion_chunk,
+    parse_messages,
+)
+from .core import PytorchChatModel
+from .utils import cache_clean
+
+logger = logging.getLogger(__name__)
+
+
+class CogAgentChatModel(PytorchChatModel):
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self._torch_type = None
+        self._device = None
+        self._tokenizer = None
+        self._model = None
+        self._platform: Literal["Mac", "WIN", "Mobile"] | None = "Mac"
+        self._format: Literal[
+            "(Answer in Action-Operation-Sensitive format.)",
+            "(Answer in Status-Plan-Action-Operation format.)",
+            "(Answer in Status-Action-Operation-Sensitive format.)",
+            "(Answer in Status-Action-Operation format.)",
+            "(Answer in Action-Operation format.)",
+        ] | None = "(Answer in Action-Operation-Sensitive format.)"
+
+    @classmethod
+    def match(
+        cls, model_family: "LLMFamilyV1", model_spec: "LLMSpecV1", quantization: str
+    ) -> bool:
+        family = model_family.model_family or model_family.model_name
+        if "cogagent" in family.lower():
+            return True
+        return False
+
+    def load(self, **kwargs):
+        from transformers import AutoModelForCausalLM, AutoTokenizer, BitsAndBytesConfig
+
+        device = self._pytorch_model_config.get("device", "auto")
+        self._device = select_device(device)
+
+        self._tokenizer = AutoTokenizer.from_pretrained(
+            self.model_path, trust_remote_code=True
+        )
+        if self.quantization == "4-bit":
+            quantization_config = BitsAndBytesConfig(load_in_4bit=True)
+        elif self.quantization == "8-bit":
+            quantization_config = BitsAndBytesConfig(load_in_8bit=True)
+        else:
+            quantization_config = None
+
+        self._model = AutoModelForCausalLM.from_pretrained(
+            self.model_path,
+            torch_dtype=torch.bfloat16,
+            trust_remote_code=True,
+            device_map=self._device,
+            quantization_config=quantization_config,
+        ).eval()
+
+    def _message_content_to_cogagent(self, content):
+        assert isinstance(content, list)
+        texts = []
+        image_urls = []
+        for c in content:
+            c_type = c.get("type")
+            if c_type == "text":
+                texts.append(c["text"])
+            elif c_type == "image_url":
+                image_urls.append(c["image_url"]["url"])
+        image_futures = []
+        with ThreadPoolExecutor() as executor:
+            for image_url in image_urls:
+                fut = executor.submit(_decode_image, image_url)
+                image_futures.append(fut)
+        images = [fut.result() for fut in image_futures]
+        text = " ".join(texts)
+        if len(images) == 0:
+            raise RuntimeError(
+                "CogAgent requires image input to perform GUI Agent tasks. Pure text-based interaction cannot execute such tasks."
+            )
+        elif len(images) == 1:
+            return text, images[-1]
+        else:
+            logger.warning(
+                "There are multiple images in the prompt, CogAgent will automatically use the most recently provided image as the input."
+            )
+            return text, images[-1]
+
+    def _history_content_to_cogagent(self, chat_history: List[Dict]):
+        grounded_pattern = r"Grounded Operation:\s*(.*)"
+        action_pattern = r"Action:\s*(.*)"
+
+        def extract_operations(_content: str):
+            """extract grounded operation and action operation"""
+            _history_step = []
+            _history_action = []
+
+            matches_history = re.search(grounded_pattern, _content)
+            matches_actions = re.search(action_pattern, _content)
+
+            if matches_history:
+                grounded_operation = matches_history.group(1)
+                _history_step.append(grounded_operation)
+            if matches_actions:
+                action_operation = matches_actions.group(1)
+                _history_action.append(action_operation)
+
+            return _history_step, _history_action
+
+        history_step = []
+        history_action = []
+
+        for i in range(0, len(chat_history) - 1, 2):
+            content = chat_history[i + 1].get("content")
+            if isinstance(content, str):  # 如果内容是字符串
+                steps, actions = extract_operations(content)
+                history_step.extend(steps)
+                history_action.extend(actions)
+
+            elif isinstance(content, list):  # 如果内容是列表
+                for c in content:
+                    c_content = c.get("content")
+                    if isinstance(c_content, str):  # 确保是字符串类型
+                        steps, actions = extract_operations(c_content)
+                        history_step.extend(steps)
+                        history_action.extend(actions)
+
+        return history_step, history_action
+
+    def get_query_and_history(
+        self,
+        prompt: Union[str, List[Dict]],
+        chat_history: Optional[List[Dict]] = None,
+    ):
+        task, image = self._message_content_to_cogagent(prompt)
+
+        history_step, history_action = [], []
+
+        if chat_history:
+            history_step, history_action = self._history_content_to_cogagent(
+                chat_history
+            )
+
+        # Verify history lengths match
+        if len(history_step) != len(history_action):
+            raise ValueError("Mismatch in lengths of history_step and history_action.")
+
+        # Format history steps for output
+        history_str = "\nHistory steps: "
+        for index, (step, action) in enumerate(zip(history_step, history_action)):
+            history_str += f"\n{index}. {step}\t{action}"
+
+        # Compose the query with task, platform, and selected format instructions
+        query = f"Task: {task}{history_str}\n{self._platform}{self._format}"
+        logger.info(f"query:{query}")
+        return query, image
+
+    @cache_clean
+    def chat(
+        self,
+        messages: List[Dict],
+        generate_config: Optional[CogagentGenerateConfig] = None,
+    ) -> Union[ChatCompletion, Iterator[ChatCompletionChunk]]:
+        if generate_config is not None:
+            self._platform = generate_config.pop("platform", self._platform)
+            self._format = generate_config.pop("format", self._format)
+
+        sanitize_generate_config = self._sanitize_generate_config(generate_config)
+        stream = sanitize_generate_config.get("stream")
+        sanitized_config = {
+            "max_length": sanitize_generate_config.get("max_tokens", 512),
+            "top_k": sanitize_generate_config.get("top_k", 1),
+            "do_sample": True,
+        }
+        prompt, _, chat_history = parse_messages(messages)
+
+        query, image = self.get_query_and_history(prompt, chat_history)
+
+        full_context_kwargs = {
+            "return_tensors": "pt",
+            "return_dict": True,
+        }
+        assert self.model_family.chat_template is not None
+        inputs = self.get_full_context(
+            [{"role": "user", "image": image, "content": query}],
+            self.model_family.chat_template,
+            self._tokenizer,
+            tokenize=True,
+            **full_context_kwargs,
+        )
+        inputs.to(self._model.device)
+
+        if stream:
+            it = self._streaming_chat_response(inputs, sanitized_config)
+            return self._to_chat_completion_chunks(it)
+        else:
+            # Generate response
+            with torch.no_grad():
+                outputs = self._model.generate(**inputs, **sanitized_config)
+                outputs = outputs[:, inputs["input_ids"].shape[1] :]
+                response = self._tokenizer.decode(outputs[0], skip_special_tokens=True)
+
+            return generate_chat_completion(self.model_uid, response)
+
+    def _streaming_chat_response(
+        self, inputs: Dict, config: Dict
+    ) -> Iterator[CompletionChunk]:
+        from threading import Thread
+
+        from transformers import TextIteratorStreamer
+
+        streamer = TextIteratorStreamer(
+            self._tokenizer, skip_prompt=True, skip_special_tokens=True
+        )
+        generation_kwargs = {**inputs, **config}
+
+        thread = Thread(target=self._model.generate, kwargs=generation_kwargs)
+        thread.start()
+
+        completion_id = str(uuid.uuid1())
+        for new_text in streamer:
+            yield generate_completion_chunk(
+                chunk_text=new_text,
+                finish_reason=None,
+                chunk_id=completion_id,
+                model_uid=self.model_uid,
+                prompt_tokens=-1,
+                completion_tokens=-1,
+                total_tokens=-1,
+            )
+        yield generate_completion_chunk(
+            chunk_text=None,
+            finish_reason="stop",
+            chunk_id=completion_id,
+            model_uid=self.model_uid,
+            prompt_tokens=-1,
+            completion_tokens=-1,
+            total_tokens=-1,
+            has_choice=True,
+            has_content=False,
+        )

xinference/model/llm/transformers/core.py

@@ -70,6 +70,7 @@ NON_DEFAULT_MODEL_LIST: List[str] = [
     "deepseek-v2-chat-0628",
     "glm-edge-v",
     "QvQ-72B-Preview",
+    "cogagent",
 ]
 
 

xinference/model/llm/transformers/qwen2_vl.py

@@ -17,6 +17,7 @@ import sys
 import uuid
 from typing import Iterator, List, Optional, Union
 
+from ....device_utils import is_npu_available
 from ....model.utils import select_device
 from ....types import (
     ChatCompletion,
@@ -73,6 +74,14 @@ class Qwen2VLChatModel(PytorchChatModel):
                 attn_implementation="flash_attention_2",
                 trust_remote_code=True,
             ).eval()
+        elif is_npu_available():
+            # Ascend do not support bf16
+            self._model = Qwen2VLForConditionalGeneration.from_pretrained(
+                self.model_path,
+                device_map="auto",
+                trust_remote_code=True,
+                torch_dtype="float16",
+            ).eval()
         else:
             self._model = Qwen2VLForConditionalGeneration.from_pretrained(
                 self.model_path, device_map=device, trust_remote_code=True
@@ -114,7 +123,7 @@ class Qwen2VLChatModel(PytorchChatModel):
             padding=True,
             return_tensors="pt",
         )
-        inputs = inputs.to("cuda")
+        inputs = inputs.to(self._device)
 
         # Inference: Generation of the output
         generated_ids = self._model.generate(

xinference/model/llm/utils.py

@@ -97,13 +97,18 @@ class ChatModelMixin:
         return rendered
 
     def get_full_context(
-        self, messages: List, chat_template: str, tokenizer=None, **kwargs
-    ) -> str:
+        self,
+        messages: List,
+        chat_template: str,
+        tokenizer=None,
+        tokenize=False,
+        **kwargs,
+    ):
         if tokenizer is not None:
             try:
                 full_context = tokenizer.apply_chat_template(
                     messages,
-                    tokenize=False,
+                    tokenize=tokenize,
                     chat_template=chat_template,
                     add_generation_prompt=True,
                     **kwargs,
@@ -119,6 +124,25 @@ class ChatModelMixin:
             # Compilation function uses a cache to avoid recompiling the same template
             return self._build_from_raw_template(messages, chat_template, **kwargs)
 
+    @staticmethod
+    def convert_messages_with_content_list_to_str_conversion(
+        messages: List[Dict],
+    ) -> List[Dict]:
+        """
+        Handles messages with content list conversion, in order to support Cline, see GH#2659 .
+        """
+        for message in messages:
+            texts = ""
+            msg_content = message.get("content")
+            if msg_content:
+                if isinstance(msg_content, str):
+                    texts = msg_content
+                elif isinstance(msg_content, list):
+                    texts = "\n".join(item.get("text", "") for item in msg_content)
+            if texts:
+                message["content"] = texts
+        return messages
+
     @staticmethod
     def get_specific_prompt(model_family: str, messages: List[ChatCompletionMessage]):
         """

xinference/model/llm/vllm/core.py

@@ -156,6 +156,7 @@ if VLLM_INSTALLED and vllm.__version__ >= "0.3.0":
     VLLM_SUPPORTED_MODELS.append("qwen2.5-coder")
     VLLM_SUPPORTED_CHAT_MODELS.append("qwen2.5-coder-instruct")
     VLLM_SUPPORTED_CHAT_MODELS.append("QwQ-32B-Preview")
+    VLLM_SUPPORTED_CHAT_MODELS.append("marco-o1")
 
 
 if VLLM_INSTALLED and vllm.__version__ >= "0.3.2":
@@ -224,6 +225,10 @@ class VLLMModel(LLM):
         self._engine = None
         self.lora_modules = peft_model
         self.lora_requests: List[LoRARequest] = []
+        self._xavier_config = None
+
+    def set_xavier_config(self, value: Optional[Dict]):
+        self._xavier_config = value  # type: ignore
 
     def load(self):
         try:
@@ -269,13 +274,34 @@ class VLLMModel(LLM):
             f"Enable lora: {enable_lora}. Lora count: {max_loras}."
         )
 
-        engine_args = AsyncEngineArgs(
-            model=self.model_path,
-            enable_lora=enable_lora,
-            max_loras=max_loras,
-            **self._model_config,
-        )
-        self._engine = AsyncLLMEngine.from_engine_args(engine_args)
+        if self._xavier_config is not None:
+            from .xavier.engine import XavierEngine
+
+            # Enabling Xavier means that `enable_prefix_caching` is enabled by default.
+            self._model_config.setdefault("enable_prefix_caching", True)
+            xavier_transfer_block_num = self._model_config.pop(
+                "xavier_transfer_block_num", 512
+            )
+            self._xavier_config["transfer_block_num"] = xavier_transfer_block_num
+            engine_args = AsyncEngineArgs(
+                model=self.model_path,
+                enable_lora=enable_lora,
+                max_loras=max_loras,
+                **self._model_config,
+            )
+
+            logger.debug(f"Start xavier for vllm with config: {self._xavier_config}")
+            self._engine = XavierEngine.from_engine_args(
+                engine_args, xavier_config=self._xavier_config
+            )
+        else:
+            engine_args = AsyncEngineArgs(
+                model=self.model_path,
+                enable_lora=enable_lora,
+                max_loras=max_loras,
+                **self._model_config,
+            )
+            self._engine = AsyncLLMEngine.from_engine_args(engine_args)
 
         self._check_health_task = None
         if hasattr(self._engine, "check_health"):
@@ -293,6 +319,9 @@ class VLLMModel(LLM):
             model_executor.shutdown()
         self._engine = None
 
+    async def init_xavier(self):
+        await self._engine.init_xavier()
+
     async def _check_healthy(self, interval: int = 30):
         from vllm.engine.async_llm_engine import AsyncEngineDeadError
 
@@ -775,6 +804,7 @@ class VLLMChatModel(VLLMModel, ChatModelMixin):
         generate_config: Optional[Dict] = None,
         request_id: Optional[str] = None,
     ) -> Union[ChatCompletion, AsyncGenerator[ChatCompletionChunk, None]]:
+        messages = self.convert_messages_with_content_list_to_str_conversion(messages)
         tools = generate_config.pop("tools", []) if generate_config else None
         model_family = self.model_family.model_family or self.model_family.model_name
         full_context_kwargs = {}

xinference/model/llm/vllm/xavier/__init__.py

@@ -0,0 +1,13 @@
+# Copyright 2022-2025 XProbe Inc.
+#
+# 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.

xinference/model/llm/vllm/xavier/allocator.py

@@ -0,0 +1,74 @@
+# Copyright 2022-2025 XProbe Inc.
+#
+# 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 typing import Any, Dict, Optional
+
+from vllm.core.block.cpu_gpu_block_allocator import CpuGpuBlockAllocator
+from vllm.core.block.interfaces import DeviceAwareBlockAllocator
+from vllm.platforms import current_platform
+from vllm.utils import Device
+
+from .block import XavierPrefixCachingBlockAllocator
+
+
+class XavierCpuGpuBlockAllocator(CpuGpuBlockAllocator):
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self._xavier_config: Optional[Dict[str, Any]] = None
+
+    @property
+    def xavier_config(self):
+        return self._xavier_config
+
+    @xavier_config.setter
+    def xavier_config(self, v: Dict[str, Any]):
+        self._xavier_config = v
+        self._allocators[Device.GPU].xavier_config = v
+
+    @staticmethod
+    def create(
+        allocator_type: str,
+        num_gpu_blocks: int,
+        num_cpu_blocks: int,
+        block_size: int,
+    ) -> DeviceAwareBlockAllocator:
+        """Xinference Change!!!
+        1. The code is copied here because the `allocator` needs to be instantiated as a subclass.
+        2. Why not re-instantiate it externally?
+        Re-instantiating the `allocator` is costly because it requires initializing many tensors.
+        """
+
+        # For HPU, block id 0 is used only for padding
+        reserved_blocks = 1 if current_platform.is_hpu() else 0
+        block_ids = list(range(reserved_blocks, num_gpu_blocks + num_cpu_blocks))
+        num_gpu_blocks -= reserved_blocks
+        gpu_block_ids = block_ids[:num_gpu_blocks]
+        cpu_block_ids = block_ids[num_gpu_blocks:]
+
+        gpu_allocator = XavierPrefixCachingBlockAllocator(
+            run_isolation=True,
+            num_blocks=num_gpu_blocks,
+            block_size=block_size,
+            block_ids=gpu_block_ids,
+        )
+
+        cpu_allocator = XavierPrefixCachingBlockAllocator(
+            num_blocks=num_cpu_blocks,
+            block_size=block_size,
+            block_ids=cpu_block_ids,
+        )
+
+        return XavierCpuGpuBlockAllocator(
+            cpu_block_allocator=cpu_allocator,
+            gpu_block_allocator=gpu_allocator,
+        )

xinference/model/llm/vllm/xavier/block.py

@@ -0,0 +1,112 @@
+# Copyright 2022-2025 XProbe Inc.
+#
+# 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 asyncio
+import logging
+from typing import Any, Dict, Optional
+
+import xoscar as xo
+from vllm.core.block.interfaces import BlockId
+from vllm.core.block.prefix_caching_block import (
+    BlockTracker,
+    PrefixCachingBlockAllocator,
+)
+
+from .....isolation import Isolation
+
+logger = logging.getLogger(__name__)
+
+
+class XavierInnerBlockTracker(BlockTracker):
+    """Used to track the status of a block inside the prefix caching allocator"""
+
+    """
+    Here, two fixed attributes, `transferred` and `executed`,
+    have been added to the `BlockTracker` class to mark the status of the corresponding `block_id`.
+    We cannot directly set attributes on the `Block` object
+    because the `Block` objects are dynamically allocated with each scheduling.
+    The `Block` objects executed in two different scheduling steps may have the same `id`, `hash`, etc.,
+    but the instance objects may differ.
+    The BlockTracker object inside vllm is one-to-one with the block_id.
+    """
+    __slots__ = ("active", "last_accessed", "computed", "transferred", "executed")
+
+    def __init__(self):
+        super().__init__()
+        self.transferred = False
+        self.executed = False
+
+
+class XavierPrefixCachingBlockAllocator(PrefixCachingBlockAllocator):
+    def __init__(self, *args, run_isolation: bool = False, **kwargs):
+        super().__init__(*args, **kwargs)
+        for _id in self._block_tracker.keys():
+            self._block_tracker[_id] = XavierInnerBlockTracker()
+
+        self._xavier_config: Optional[Dict[str, Any]] = None
+        self._block_tracker_ref = None
+        if run_isolation:
+            self._isolation = Isolation(
+                asyncio.new_event_loop(), threaded=True, daemon=True
+            )
+            self._isolation.start()
+        else:
+            self._isolation = None  # type: ignore
+
+    def __del__(self):
+        if self._isolation is not None:
+            self._isolation.stop()
+
+    @property
+    def xavier_config(self):
+        return self._xavier_config
+
+    @xavier_config.setter
+    def xavier_config(self, v: Dict[str, Any]):
+        self._xavier_config = v
+
+    async def _get_block_tracker_ref(self):
+        from .block_tracker import VLLMBlockTracker
+
+        if self._block_tracker_ref is None:
+            block_tracker_address = self.xavier_config.get("block_tracker_address")
+            self._block_tracker_ref = await xo.actor_ref(
+                address=block_tracker_address, uid=VLLMBlockTracker.default_uid()
+            )
+        return self._block_tracker_ref
+
+    async def unregister_block(self, block_id: int):
+        assert self._xavier_config is not None
+        tracker_ref = await self._get_block_tracker_ref()
+        await tracker_ref.unregister_block(
+            self.xavier_config.get("virtual_engine"),
+            self.xavier_config.get("rank_address"),
+            block_id,
+        )
+
+    def _maybe_allocate_evicted_block_id(self) -> Optional[BlockId]:
+        """
+        This is the only entry point where the `block_id` is evicted from the cache.
+        Therefore, when the `block_id` is evicted, the tracker actor needs to unregister the block information.
+        At the same time, make sure to reset the attributes corresponding to that `block_id`.
+        """
+        evicted_block_id = super()._maybe_allocate_evicted_block_id()
+        logger.debug(f"block_id: {evicted_block_id} will be evicted from the cache.")
+        if evicted_block_id is not None and self._isolation is not None:
+            tracker = self._block_tracker[evicted_block_id]
+            assert isinstance(tracker, XavierInnerBlockTracker)
+            tracker.transferred = False
+            tracker.executed = False
+            self._isolation.call(self.unregister_block(evicted_block_id))
+            logger.debug(f"block_id: {evicted_block_id} will be used again.")
+        return evicted_block_id