nexaai 1.0.21__cp313-cp313-win_arm64.whl

nexaai/common.py

@@ -0,0 +1,105 @@
+from dataclasses import dataclass
+from typing import TypedDict, Literal, Optional, List
+from enum import Enum
+
+
+class PluginID(str, Enum):
+    """Enum for plugin identifiers."""
+    MLX = "mlx"
+    LLAMA_CPP = "llama_cpp"
+    NEXAML = "nexaml"
+    NPU = "npu"
+
+
+class ChatMessage(TypedDict):
+    role: Literal["user", "assistant", "system"]
+    content: str
+
+class MultiModalMessageContent(TypedDict):
+    type: Literal["text", "image", "audio", "video"]
+    text: Optional[str]
+    url: Optional[str]
+    path: Optional[str]
+
+class MultiModalMessage(TypedDict):
+    role: Literal["user", "assistant", "system"]
+    content: List[MultiModalMessageContent] 
+
+
+@dataclass
+class SamplerConfig:
+    temperature: float = 0.8
+    top_p: float = 0.95
+    top_k: int = 40
+    repetition_penalty: float = 1.0
+    presence_penalty: float = 0.0
+    frequency_penalty: float = 0.0
+    seed: int = -1
+    grammar_path: str = None
+    grammar_string: str = None
+
+@dataclass
+class GenerationConfig:
+    max_tokens: int = 1024
+    stop_words: list[str] = None
+    sampler_config: SamplerConfig = None
+    image_paths: list[str] = None
+    audio_paths: list[str] = None
+
+@dataclass
+class ModelConfig:
+    n_ctx: int = 4096
+    n_threads: int = None
+    n_threads_batch: int = None
+    n_batch: int = 512
+    n_ubatch: int = 512
+    n_seq_max: int = 1
+    n_gpu_layers: int = 999
+    chat_template_path: str = None
+    chat_template_content: str = None
+
+
+@dataclass(frozen=True) # Read-only
+class ProfilingData:
+    """Profiling data structure for LLM/VLM performance metrics."""
+    ttft: int = 0             # Time to first token (us)
+    prompt_time: int = 0      # Prompt processing time (us)
+    decode_time: int = 0      # Token generation time (us)
+    prompt_tokens: int = 0    # Number of prompt tokens
+    generated_tokens: int = 0  # Number of generated tokens
+    audio_duration: int = 0   # Audio duration (us)
+    prefill_speed: float = 0.0  # Prefill speed (tokens/sec)
+    decoding_speed: float = 0.0 # Decoding speed (tokens/sec)
+    real_time_factor: float = 0.0 # Real-Time Factor (RTF)
+    stop_reason: str = ""     # Stop reason: "eos", "length", "user", "stop_sequence"
+    
+    @classmethod
+    def from_dict(cls, data: dict) -> "ProfilingData":
+        """Create ProfilingData from dictionary."""
+        return cls(
+            ttft=data.get("ttft", 0),
+            prompt_time=data.get("prompt_time", 0),
+            decode_time=data.get("decode_time", 0),
+            prompt_tokens=data.get("prompt_tokens", 0),
+            generated_tokens=data.get("generated_tokens", 0),
+            audio_duration=data.get("audio_duration", 0),
+            prefill_speed=data.get("prefill_speed", 0.0),
+            decoding_speed=data.get("decoding_speed", 0.0),
+            real_time_factor=data.get("real_time_factor", 0.0),
+            stop_reason=data.get("stop_reason", "")
+        )
+    
+    def to_dict(self) -> dict:
+        """Convert to dictionary."""
+        return {
+            "ttft": self.ttft,
+            "prompt_time": self.prompt_time,
+            "decode_time": self.decode_time,
+            "prompt_tokens": self.prompt_tokens,
+            "generated_tokens": self.generated_tokens,
+            "audio_duration": self.audio_duration,
+            "prefill_speed": self.prefill_speed,
+            "decoding_speed": self.decoding_speed,
+            "real_time_factor": self.real_time_factor,
+            "stop_reason": self.stop_reason
+        }

nexaai/cv.py

@@ -0,0 +1,93 @@
+from typing import List, Optional, Union
+from abc import abstractmethod
+from dataclasses import dataclass
+
+from nexaai.base import BaseModel
+from nexaai.common import PluginID
+
+
+@dataclass
+class BoundingBox:
+    """Generic bounding box structure."""
+    x: float  # X coordinate (normalized or pixel, depends on model)
+    y: float  # Y coordinate (normalized or pixel, depends on model) 
+    width: float  # Width
+    height: float  # Height
+
+
+@dataclass
+class CVResult:
+    """Generic detection/classification result."""
+    image_paths: Optional[List[str]] = None  # Output image paths
+    image_count: int = 0  # Number of output images
+    class_id: int = 0  # Class ID (example: ConvNext)
+    confidence: float = 0.0  # Confidence score [0.0-1.0]
+    bbox: Optional[BoundingBox] = None  # Bounding box (example: YOLO)
+    text: Optional[str] = None  # Text result (example: OCR)
+    embedding: Optional[List[float]] = None  # Feature embedding (example: CLIP embedding)
+    embedding_dim: int = 0  # Embedding dimension
+
+
+@dataclass
+class CVResults:
+    """Generic CV inference result."""
+    results: List[CVResult]  # Array of CV results
+    result_count: int  # Number of CV results
+
+
+class CVCapabilities:
+    """CV capabilities enum."""
+    OCR = 0  # OCR
+    CLASSIFICATION = 1  # Classification
+    SEGMENTATION = 2  # Segmentation
+    CUSTOM = 3  # Custom task
+
+
+@dataclass
+class CVModelConfig:
+    """CV model preprocessing configuration."""
+    capabilities: int  # CVCapabilities
+
+    # MLX-OCR
+    det_model_path: Optional[str] = None  # Detection model path
+    rec_model_path: Optional[str] = None  # Recognition model path
+
+    # QNN
+    model_path: Optional[str] = None  # Model path
+    system_library_path: Optional[str] = None  # System library path
+    backend_library_path: Optional[str] = None  # Backend library path
+    extension_library_path: Optional[str] = None  # Extension library path
+    config_file_path: Optional[str] = None  # Config file path
+    char_dict_path: Optional[str] = None  # Character dictionary path
+
+
+class CVModel(BaseModel):
+    """Abstract base class for generic computer vision models."""
+
+    def __init__(self):
+        """Initialize base CV model class."""
+        pass
+
+    @classmethod
+    def _load_from(cls,
+                   _: str,  # TODO: remove this argument, this is a hack to make api design happy
+                   config: CVModelConfig,
+                   plugin_id: Union[PluginID, str] = PluginID.LLAMA_CPP,
+                   device_id: Optional[str] = None,
+                   **kwargs
+        ) -> 'CVModel':
+        """Load CV model from configuration, routing to appropriate implementation."""
+        # Check plugin_id value for routing - handle both enum and string
+        plugin_value = plugin_id.value if isinstance(plugin_id, PluginID) else plugin_id
+        
+        if plugin_value == "mlx":
+            from nexaai.cv_impl.mlx_cv_impl import MLXCVImpl
+            return MLXCVImpl._load_from(config, plugin_id, device_id)
+        else:
+            from nexaai.cv_impl.pybind_cv_impl import PyBindCVImpl
+            return PyBindCVImpl._load_from(config, plugin_id, device_id)
+
+    @abstractmethod
+    def infer(self, input_image_path: str) -> CVResults:
+        """Perform inference on image."""
+        pass

nexaai/cv_impl/mlx_cv_impl.py

@@ -0,0 +1,89 @@
+# Note: This code is generated by Cursor, not tested yet.
+
+from typing import Optional, Union
+import os
+
+from nexaai.common import PluginID
+from nexaai.cv import CVModel, CVModelConfig, CVResults
+from nexaai.mlx_backend.cv.interface import CVModel as MLXCVInterface, create_cv_model
+
+
+class MLXCVImpl(CVModel):
+    def __init__(self):
+        """Initialize MLX CV implementation."""
+        super().__init__()
+        self._mlx_cv = None
+
+    @classmethod
+    def _load_from(cls,
+                   config: CVModelConfig,
+                   plugin_id: Union[PluginID, str] = PluginID.MLX,
+                   device_id: Optional[str] = None
+        ) -> 'MLXCVImpl':
+        """Load CV model from configuration using MLX backend."""
+        try:
+            # Get MLX config class
+            from nexaai.mlx_backend.ml import CVModelConfig as MLXCVModelConfig
+            
+            # Convert our config to MLX format
+            mlx_config = MLXCVModelConfig(
+                capabilities=config.capabilities,
+                det_model_path=config.det_model_path,
+                rec_model_path=config.rec_model_path,
+                model_path=config.model_path,
+                system_library_path=config.system_library_path,
+                backend_library_path=config.backend_library_path,
+                extension_library_path=config.extension_library_path,
+                config_file_path=config.config_file_path,
+                char_dict_path=config.char_dict_path
+            )
+            
+            # Create instance and load MLX CV model
+            instance = cls()
+            instance._mlx_cv = create_cv_model(mlx_config, device_id)
+            
+            return instance
+        except Exception as e:
+            raise RuntimeError(f"Failed to load MLX CV: {str(e)}")
+
+    def eject(self):
+        """Destroy the model and free resources."""
+        if self._mlx_cv:
+            self._mlx_cv.destroy()
+            self._mlx_cv = None
+
+    def infer(self, input_image_path: str) -> CVResults:
+        """Perform inference on image."""
+        if not self._mlx_cv:
+            raise RuntimeError("MLX CV not loaded")
+        
+        try:
+            # Use MLX CV inference
+            result = self._mlx_cv.infer(input_image_path)
+            
+            # Convert MLX result to our format
+            from nexaai.cv import CVResult
+            
+            our_results = []
+            for mlx_result in result.results:
+                our_result = CVResult(
+                    image_paths=mlx_result.image_paths,
+                    image_count=mlx_result.image_count,
+                    class_id=mlx_result.class_id,
+                    confidence=mlx_result.confidence,
+                    bbox=mlx_result.bbox,
+                    text=mlx_result.text,
+                    embedding=mlx_result.embedding,
+                    embedding_dim=mlx_result.embedding_dim
+                )
+                our_results.append(our_result)
+            
+            return CVResults(
+                results=our_results,
+                result_count=result.result_count
+            )
+            
+        except Exception as e:
+            raise RuntimeError(f"Failed to perform CV inference: {str(e)}")
+
+

nexaai/cv_impl/pybind_cv_impl.py

@@ -0,0 +1,32 @@
+from typing import Optional, Union
+
+from nexaai.common import PluginID
+from nexaai.cv import CVModel, CVModelConfig, CVResults
+
+
+class PyBindCVImpl(CVModel):
+    def __init__(self):
+        """Initialize PyBind CV implementation."""
+        super().__init__()
+        # TODO: Add PyBind-specific initialization
+
+    @classmethod
+    def _load_from(cls,
+                   config: CVModelConfig,
+                   plugin_id: Union[PluginID, str] = PluginID.LLAMA_CPP,
+                   device_id: Optional[str] = None
+        ) -> 'PyBindCVImpl':
+        """Load CV model from configuration using PyBind backend."""
+        # TODO: Implement PyBind CV loading
+        instance = cls()
+        return instance
+
+    def eject(self):
+        """Destroy the model and free resources."""
+        # TODO: Implement PyBind CV cleanup
+        pass
+
+    def infer(self, input_image_path: str) -> CVResults:
+        """Perform inference on image."""
+        # TODO: Implement PyBind CV inference
+        raise NotImplementedError("PyBind CV inference not yet implemented")

nexaai/embedder.py

@@ -0,0 +1,73 @@
+from typing import List, Union
+from dataclasses import dataclass
+from abc import abstractmethod
+import numpy as np
+
+from nexaai.base import BaseModel
+from nexaai.common import PluginID
+
+
+@dataclass
+class EmbeddingConfig:
+    batch_size: int = 32
+    normalize: bool = True
+    normalize_method: str = "l2"
+
+
+class Embedder(BaseModel):
+    def __init__(self):
+        """
+        Internal initializer
+        """
+        pass
+
+    @classmethod
+    def _load_from(cls, model_path: str, model_name: str = None, tokenizer_file: str = "tokenizer.json", plugin_id: Union[PluginID, str] = PluginID.LLAMA_CPP, **kwargs):
+        """
+        Load an embedder from model files, routing to appropriate implementation.
+
+        Args:
+            model_path: Path to the model file
+            model_name: Name of the model
+            tokenizer_file: Path to the tokenizer file (default: "tokenizer.json")
+            plugin_id: Plugin ID to use for the model (default: PluginID.LLAMA_CPP)
+
+        Returns:
+            Embedder instance
+        """
+        # Check plugin_id value for routing - handle both enum and string
+        plugin_value = plugin_id.value if isinstance(plugin_id, PluginID) else plugin_id
+        
+        if plugin_value == "mlx":
+            from nexaai.embedder_impl.mlx_embedder_impl import MLXEmbedderImpl
+            return MLXEmbedderImpl._load_from(model_path, model_name, tokenizer_file, plugin_id)
+        else:
+            from nexaai.embedder_impl.pybind_embedder_impl import PyBindEmbedderImpl
+            return PyBindEmbedderImpl._load_from(model_path, model_name, tokenizer_file, plugin_id)
+
+    @abstractmethod
+    def generate(self, texts: Union[List[str], str] = None, config: EmbeddingConfig = EmbeddingConfig(), input_ids: Union[List[int], List[List[int]]] = None) -> np.ndarray:
+        """
+        Generate embeddings for the given texts or input_ids.
+
+        Args:
+            texts: List of strings or single string to embed
+            input_ids: Pre-tokenized input as:
+                      - Single sequence: list of integers [1, 2, 3, 4]
+                      - Multiple sequences: list of lists [[1, 2, 3], [4, 5, 6]]
+            config: Configuration for embedding generation
+
+        Returns:
+            numpy array of embeddings with shape (num_sequences, embedding_dim)
+        """
+        pass
+
+    @abstractmethod
+    def get_embedding_dim(self) -> int:
+        """
+        Get the embedding dimension of the model
+
+        Returns:
+            The embedding dimension in int
+        """
+        pass

nexaai/embedder_impl/mlx_embedder_impl.py

@@ -0,0 +1,118 @@
+from typing import List, Union
+import numpy as np
+
+from nexaai.common import PluginID
+from nexaai.embedder import Embedder, EmbeddingConfig
+from nexaai.mlx_backend.embedding.interface import create_embedder
+from nexaai.mlx_backend.ml import ModelConfig as MLXModelConfig, SamplerConfig as MLXSamplerConfig, GenerationConfig as MLXGenerationConfig, EmbeddingConfig
+
+
+class MLXEmbedderImpl(Embedder):
+    def __init__(self):
+        """Initialize MLX Embedder implementation."""
+        super().__init__()
+        self._mlx_embedder = None
+
+    @classmethod
+    def _load_from(cls, model_path: str, model_name: str = None, tokenizer_file: str = "tokenizer.json", plugin_id: Union[PluginID, str] = PluginID.MLX):
+        """
+        Load an embedder from model files using MLX backend.
+
+        Args:
+            model_path: Path to the model file
+            model_name: Name of the model
+            tokenizer_file: Path to the tokenizer file (default: "tokenizer.json")
+            plugin_id: Plugin ID to use for the model (default: PluginID.MLX)
+
+        Returns:
+            MLXEmbedderImpl instance
+        """
+        try:
+            # Create instance
+            instance = cls()
+            
+            # Use the factory function to create the appropriate embedder based on model type
+            # This will automatically detect if it's JinaV2 or generic model and route correctly
+            instance._mlx_embedder = create_embedder(
+                model_path=model_path,
+                # model_name=model_name, # FIXME: For MLX Embedder, model_name is not used
+                tokenizer_path=tokenizer_file
+            )
+            
+            # Load the model
+            success = instance._mlx_embedder.load_model(model_path)
+            if not success:
+                raise RuntimeError("Failed to load MLX embedder model")
+            
+            return instance
+        except Exception as e:
+            raise RuntimeError(f"Failed to load MLX Embedder: {str(e)}")
+
+    def eject(self):
+        """
+        Clean up resources and destroy the embedder
+        """
+        if self._mlx_embedder:
+            self._mlx_embedder.destroy()
+            self._mlx_embedder = None
+
+    def generate(self, texts: Union[List[str], str] = None, config: EmbeddingConfig = EmbeddingConfig(), input_ids: Union[List[int], List[List[int]]] = None) -> np.ndarray:
+        """
+        Generate embeddings for the given texts or input_ids.
+
+        Args:
+            texts: List of strings or single string to embed
+            input_ids: Pre-tokenized input as:
+                      - Single sequence: list of integers [1, 2, 3, 4]
+                      - Multiple sequences: list of lists [[1, 2, 3], [4, 5, 6]]
+            config: Configuration for embedding generation
+
+        Returns:
+            numpy array of embeddings with shape (num_sequences, embedding_dim)
+        """
+        if not self._mlx_embedder:
+            raise RuntimeError("MLX Embedder not loaded")
+        
+        if texts is None and input_ids is None:
+            raise ValueError("Either texts or input_ids must be provided")
+        
+        # MLX embedder currently only supports text input, not pre-tokenized input_ids
+        if input_ids is not None:
+            raise NotImplementedError("MLX embedder does not support input_ids, only text input")
+        
+        try:
+            # Convert single string to list if needed
+            if isinstance(texts, str):
+                texts = [texts]
+            
+            # MLX config classes are already imported
+            
+            # Convert our config to MLX config
+            mlx_config = EmbeddingConfig()
+            mlx_config.batch_size = config.batch_size
+            mlx_config.normalize = config.normalize
+            mlx_config.normalize_method = config.normalize_method
+            
+            # Generate embeddings using MLX
+            embeddings = self._mlx_embedder.embed(texts, mlx_config)
+            
+            # Convert to numpy array
+            return np.array(embeddings, dtype=np.float32)
+            
+        except Exception as e:
+            raise RuntimeError(f"Failed to generate embeddings: {str(e)}")
+
+    def get_embedding_dim(self) -> int:
+        """
+        Get the embedding dimension of the model
+
+        Returns:
+            The embedding dimension in int
+        """
+        if not self._mlx_embedder:
+            raise RuntimeError("MLX Embedder not loaded")
+        
+        try:
+            return self._mlx_embedder.embedding_dim()
+        except Exception as e:
+            raise RuntimeError(f"Failed to get embedding dimension: {str(e)}")

nexaai/embedder_impl/pybind_embedder_impl.py

@@ -0,0 +1,96 @@
+from typing import List, Union
+import numpy as np
+
+from nexaai.common import PluginID
+from nexaai.embedder import Embedder, EmbeddingConfig
+from nexaai.binds import embedder_bind
+from nexaai.runtime import _ensure_runtime
+
+
+class PyBindEmbedderImpl(Embedder):
+    def __init__(self, _handle_ptr):
+        """
+        Internal initializer
+        """
+        super().__init__()
+        self._handle = _handle_ptr
+
+    @classmethod
+    def _load_from(cls, model_path: str, model_name: str = None, tokenizer_file: str = "tokenizer.json", plugin_id: Union[PluginID, str] = PluginID.LLAMA_CPP):
+        """
+        Load an embedder from model files
+
+        Args:
+            model_path: Path to the model file
+            model_name: Name of the model
+            tokenizer_file: Path to the tokenizer file (default: "tokenizer.json")
+            plugin_id: Plugin ID to use for the model (default: PluginID.LLAMA_CPP)
+
+        Returns:
+            PyBindEmbedderImpl instance
+        """
+        _ensure_runtime()
+        # Convert enum to string for C++ binding
+        plugin_id_str = plugin_id.value if isinstance(plugin_id, PluginID) else plugin_id
+        # New parameter order: model_path, plugin_id, tokenizer_path (optional)
+        handle = embedder_bind.ml_embedder_create(model_path, model_name, plugin_id_str, tokenizer_file)
+        return cls(handle)
+
+    def eject(self):
+        """
+        Clean up resources and destroy the embedder
+        """
+        # Destructor of the handle will unload the model correctly
+        del self._handle
+        self._handle = None
+
+    def generate(self, texts: Union[List[str], str] = None, config: EmbeddingConfig = EmbeddingConfig(), input_ids: Union[List[int], List[List[int]]] = None) -> np.ndarray:
+        """
+        Generate embeddings for the given texts or input_ids.
+
+        Args:
+            texts: List of strings or single string to embed
+            input_ids: Pre-tokenized input as:
+                      - Single sequence: list of integers [1, 2, 3, 4]
+                      - Multiple sequences: list of lists [[1, 2, 3], [4, 5, 6]]
+            config: Configuration for embedding generation
+
+        Returns:
+            numpy array of embeddings with shape (num_sequences, embedding_dim)
+        """
+        if texts is None and input_ids is None:
+            raise ValueError("Either texts or input_ids must be provided")
+
+        # Create bind config
+        bind_config = embedder_bind.EmbeddingConfig()
+        bind_config.batch_size = config.batch_size
+        bind_config.normalize = config.normalize
+        bind_config.normalize_method = config.normalize_method
+
+        # Convert single string to list if needed
+        if isinstance(texts, str):
+            texts = [texts]
+
+        # Convert input_ids to 2D format if needed
+        processed_input_ids = None
+        if input_ids is not None:
+            if len(input_ids) > 0 and isinstance(input_ids[0], int):
+                # Single sequence: convert [1, 2, 3] to [[1, 2, 3]]
+                processed_input_ids = [input_ids]
+            else:
+                # Multiple sequences: already in correct format [[1, 2], [3, 4]]
+                processed_input_ids = input_ids
+
+        # Pass both parameters, let the ABI handle validation
+        embeddings = embedder_bind.ml_embedder_embed(self._handle, bind_config, texts, processed_input_ids)
+
+        return embeddings
+
+    def get_embedding_dim(self) -> int:
+        """
+        Get the embedding dimension of the model
+
+        Returns:
+            The embedding dimension in int
+        """
+        return embedder_bind.ml_embedder_embedding_dim(self._handle)