maxframe 1.2.1__cp311-cp311-win_amd64.whl → 1.3.1__cp311-cp311-win_amd64.whl

maxframe/learn/contrib/llm/multi_modal.py

@@ -11,6 +11,7 @@
 # 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
 
 from ....dataframe.core import DATAFRAME_TYPE, SERIES_TYPE
@@ -33,6 +34,98 @@ def generate(
     prompt_template: Dict[str, Any],
     params: Dict[str, Any] = None,
 ):
+    """
+    Generate text with multi model llm based on given data and prompt template.
+
+    Parameters
+    ----------
+    data : DataFrame or Series
+        Input data used for generation. Can be maxframe DataFrame, Series that contain text to be processed.
+    model : MultiModalLLM
+        Language model instance support **MultiModal** inputs used for text generation.
+    prompt_template : List[Dict[str, List[Dict[str, str]]]]
+        List of message with column names as placeholders. Each message contains a role and content. Content is a list of dict, each dict contains a text or image, the value can reference column data from input.
+
+        Here is an example of prompt template.
+
+        .. code-block:: python
+
+            [
+                {
+                    "role": "<role>",  # e.g. "user" or "assistant"
+                    "content": [
+                        {
+                            # At least one of these fields is required
+                            "image": "<image_data_url>",  # optional
+                            "text": "<prompt_text_template>"  # optional
+                        },
+                        ...
+                    ]
+                }
+            ]
+
+        Where:
+
+        - ``text`` can be a Python format string using column names from input data as parameters (e.g. ``"{column_name}"``)
+        - ``image`` should be a DataURL string following `RFC2397 <https://en.wikipedia.org/wiki/Data_URI_scheme>`_ standard with format.
+
+        .. code-block:: none
+
+            data:<mime_type>[;base64],<column_name>
+
+
+    params : Dict[str, Any], optional
+        Additional parameters for generation configuration, by default None.
+        Can include settings like temperature, max_tokens, etc.
+
+    Returns
+    -------
+    DataFrame
+        Generated text raw response and success status. If the success is False, the generated text will return the
+        error message.
+
+    Notes
+    -----
+    - The ``api_key_resource`` parameter should reference a text file resource in MaxCompute that contains only your DashScope API key.
+
+    - Using DashScope services requires enabling public network access for your MaxCompute project. This can be configured through the MaxCompute console by `enabling the Internet access feature <https://help.aliyun.com/zh/maxcompute/user-guide/network-connection-process>`_ for your project. Without this configuration, the API calls to DashScope will fail due to network connectivity issues.
+
+    Examples
+    --------
+    You can initialize a DashScope multi-modal model (such as qwen-vl-max) by providing a model name and an ``api_key_resource``.
+    The ``api_key_resource`` is a MaxCompute resource name that points to a text file containing a `DashScope <https://dashscope.aliyun.com/>`_ API key.
+
+    >>> from maxframe.learn.contrib.llm.models.dashscope import DashScopeMultiModalLLM
+    >>> import maxframe.dataframe as md
+    >>>
+    >>> model = DashScopeMultiModalLLM(
+    ...     name="qwen-vl-max",
+    ...     api_key_resource="<api-key-resource-name>"
+    ... )
+
+    We use Data Url Schema to provide multi modal input in prompt template, here is an example to fill in the image from table.
+
+    Assuming you have a MaxCompute table with two columns: ``image_id`` (as the index) and ``encoded_image_data_base64`` (containing Base64 encoded image data),
+    you can construct a prompt message template as follows:
+
+    >>> df = md.read_odps_table("image_content", index_col="image_id")
+
+    >>> prompt_template = [
+    ...     {
+    ...         "role": "user",
+    ...         "content": [
+    ...             {
+    ...                 "image": "data:image/png;base64,encoded_image_data_base64",
+    ...             },
+    ...             {
+    ...                 "text": "Analyze this image in detail",
+    ...             },
+    ...         ],
+    ...     },
+    ... ]
+    >>> result = model.generate(df, prompt_template)
+    >>> result.execute()
+    """
     if not isinstance(data, DATAFRAME_TYPE) and not isinstance(data, SERIES_TYPE):
         raise ValueError("data must be a maxframe dataframe or series object")
     if not isinstance(model, MultiModalLLM):

maxframe/learn/contrib/llm/text.py

@@ -11,32 +11,292 @@
 # 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
 
-from ....dataframe.core import DATAFRAME_TYPE, SERIES_TYPE
-from .core import LLM
+from typing import Any, Dict, List
+
+import numpy as np
+
+from .... import opcodes
+from ....dataframe.core import DataFrame, Series
+from ....serialization.serializables import FieldTypes, ListField, StringField
+from .core import LLM, LLMTaskOperator
+
+
+class TextLLMSummarizeOperator(LLMTaskOperator):
+    _op_type_ = opcodes.LLM_TEXT_SUMMARIZE_TASK
+
+    def get_output_dtypes(self) -> Dict[str, np.dtype]:
+        return {
+            "summary": np.dtype("O"),
+            "success": np.dtype("bool"),
+        }
+
+
+class TextLLMTranslateOperator(LLMTaskOperator):
+    _op_type_ = opcodes.LLM_TEXT_TRANSLATE_TASK
+
+    source_language = StringField("source_language")
+    target_language = StringField("target_language")
+
+    def get_output_dtypes(self) -> Dict[str, np.dtype]:
+        return {
+            "target": np.dtype("O"),
+            "success": np.dtype("bool"),
+        }
+
+
+class TextLLMClassifyOperator(LLMTaskOperator):
+    _op_type_ = opcodes.LLM_TEXT_CLASSIFY_TASK
+
+    labels = ListField("labels")
+    description = StringField("description", default=None)
+    examples = ListField("examples", FieldTypes.dict, default=None)
+
+    def get_output_dtypes(self) -> Dict[str, np.dtype]:
+        return {
+            "label": np.dtype("O"),
+            "reason": np.dtype("O"),
+            "success": np.dtype("bool"),
+        }
 
 
 class TextLLM(LLM):
     def generate(
         self,
         data,
-        prompt_template: Dict[str, Any],
+        prompt_template: List[Dict[str, str]],
         params: Dict[str, Any] = None,
     ):
         raise NotImplementedError
 
+    def summarize(self, series, index=None, **kw):
+        return TextLLMSummarizeOperator(model=self, task="summarize", **kw)(
+            series, index
+        )
+
+    def translate(
+        self,
+        series,
+        target_language: str,
+        source_language: str = None,
+        index=None,
+        **kw
+    ):
+        return TextLLMTranslateOperator(
+            model=self,
+            task="translate",
+            source_language=source_language,
+            target_language=target_language,
+            **kw
+        )(series, index)
+
+    def classify(
+        self,
+        series,
+        labels: List[str],
+        description=None,
+        examples=None,
+        index=None,
+        **kw
+    ):
+        return TextLLMClassifyOperator(
+            model=self,
+            labels=labels,
+            task="classify",
+            description=description,
+            examples=examples,
+            **kw
+        )(series, index)
+
 
 def generate(
     data,
     model: TextLLM,
-    prompt_template: Dict[str, Any],
+    prompt_template: List[Dict[str, Any]],
     params: Dict[str, Any] = None,
 ):
-    if not isinstance(data, DATAFRAME_TYPE) and not isinstance(data, SERIES_TYPE):
+    """
+    Generate text using a text language model based on given data and prompt template.
+
+    Parameters
+    ----------
+    data : DataFrame or Series
+        Input data used for generation. Can be maxframe DataFrame, Series that contain text to be processed.
+    model : TextLLM
+        Language model instance used for text generation.
+    prompt_template : List[Dict[str, str]]
+        Dictionary containing the conversation messages template. Use ``{col_name}`` as a placeholder to reference
+        column data from input data.
+
+        Usually in format of [{"role": "user", "content": "{query}"}], same with openai api schema.
+    params : Dict[str, Any], optional
+        Additional parameters for generation configuration, by default None.
+        Can include settings like temperature, max_tokens, etc.
+
+    Returns
+    -------
+    DataFrame
+        Generated text raw response and success status. If the success is False, the generated text will return the
+        error message.
+
+    Examples
+    --------
+    >>> from maxframe.learn.contrib.llm.models.managed import ManagedTextLLM
+    >>> import maxframe.dataframe as md
+    >>>
+    >>> # Initialize the model
+    >>> llm = ManagedTextLLM(name="Qwen2.5-0.5B-instruct")
+    >>>
+    >>> # Prepare prompt template
+    >>> messages = [
+    ...     {
+    ...         "role": "user",
+    ...         "content": "Help answer following question: {query}",
+    ...     },
+    ... ]
+
+    >>> # Create sample data
+    >>> df = md.DataFrame({"query": ["What is machine learning?"]})
+    >>>
+    >>> # Generate response
+    >>> result = generate(df, llm, prompt_template=messages)
+    >>> result.execute()
+    """
+    if not isinstance(data, DataFrame) and not isinstance(data, Series):
         raise ValueError("data must be a maxframe dataframe or series object")
     if not isinstance(model, TextLLM):
-        raise ValueError("model must be a TextLLM object")
+        raise TypeError("model must be a TextLLM object")
     params = params if params is not None else dict()
     model.validate_params(params)
-    return model.generate(data, prompt_template, params)
+    return model.generate(data, prompt_template=prompt_template, params=params)
+
+
+def summary(series, model: TextLLM, index=None):
+    """
+    Generate summaries for text content in a series using a language model.
+
+    Parameters
+    ----------
+    series : Series
+        A maxframe Series containing text data to be summarized.
+        Each element should be a text string.
+    model : TextLLM
+        Language model instance used for text summarization.
+    index : array-like, optional
+        Index for the output series, by default None, will generate new index.
+
+    Returns
+    -------
+    maxframe.Series
+        A pandas Series containing the generated summaries and success status.
+
+    Notes
+    -----
+      **Preview:** This API is in preview state and may be unstable.
+      The interface may change in future releases.
+    """
+    if not isinstance(series, Series):
+        raise ValueError("series must be a maxframe series object")
+
+    if series.dtype != np.str_:
+        raise ValueError("summary input must be a string series")
+
+    return model.summarize(series, index=index)
+
+
+def translate(
+    series, model: TextLLM, source_language: str, target_language: str, index=None
+):
+    """
+    Translate text content in a series using a language model from source language to target language.
+
+    Parameters
+    ----------
+    series : pandas.Series
+        A maxframe Series containing text data to translate.
+        Each element should be a text string.
+    model : TextLLM
+        Language model instance used for text summarization.
+    source_language : str
+        Source language of the text.
+    target_language : str
+        Target language of the text.
+    index : array-like, optional
+        Index for the output series, by default None, will generate new index.
+
+    Returns
+    -------
+    maxframe.Series
+        A pandas Series containing the generated translation and success status.
+
+    Notes
+    -----
+      **Preview:** This API is in preview state and may be unstable.
+      The interface may change in future releases.
+
+    """
+    if not isinstance(series, Series):
+        raise ValueError("series must be a maxframe series object")
+    if series.dtype != np.str_:
+        raise ValueError("translate input must be a string series")
+    return model.translate(
+        series,
+        source_language=source_language,
+        target_language=target_language,
+        index=index,
+    )
+
+
+def classify(
+    series,
+    model: TextLLM,
+    labels: List[str],
+    description: str = None,
+    examples: List[Dict[str, str]] = None,
+    index=None,
+):
+    """
+    Classify text content in a series with given labels.
+
+    Parameters
+    ----------
+    series : pandas.Series
+        A maxframe Series containing text data to be classified.
+        Each element should be a text string.
+    model : TextLLM
+        Language model instance used for text summarization.
+    labels : List[str]
+        List of labels to classify the text.
+    description : str
+        Description of the classification task.
+    examples : List[Dict[str, Dict[str, str]]]
+        Examples of the classification task, like [{ "text": "text...", "label":"A", reason : "reason..."}], help
+        LLM to better understand your rules.
+    index : array-like, optional
+        Index for the output series, by default None, will generate new index.
+
+    Returns
+    -------
+    maxframe.Series
+        A pandas Series containing the generated classification results and success status.
+
+    Notes
+    -----
+      **Preview:** This API is in preview state and may be unstable.
+      The interface may change in future releases.
+    """
+    if not isinstance(series, Series):
+        raise ValueError("series must be a maxframe series object")
+
+    if series.dtype != np.str_:
+        raise ValueError("classify input must be a string series")
+
+    if not isinstance(labels, list):
+        raise TypeError("labels must be a list")
+
+    if not labels:
+        raise ValueError("labels must not be empty")
+
+    return model.classify(
+        series, labels=labels, description=description, examples=examples, index=index
+    )

maxframe/learn/contrib/models.py

@@ -0,0 +1,77 @@
+# Copyright 1999-2025 Alibaba Group Holding Ltd.
+#
+# 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 ... import opcodes
+from ...core import ENTITY_TYPE, OutputType
+from ...core.operator import ObjectOperator, ObjectOperatorMixin
+from ...serialization.serializables import (
+    AnyField,
+    DictField,
+    FunctionField,
+    TupleField,
+)
+from ...utils import find_objects, replace_objects
+
+
+class ModelDataSource(ObjectOperator, ObjectOperatorMixin):
+    _op_type_ = opcodes.MODEL_DATA_SOURCE
+
+    data = AnyField("data")
+
+    def __call__(self, model_cls):
+        self._output_types = [OutputType.object]
+        return self.new_tileable(None, object_class=model_cls)
+
+
+class ModelApplyChunk(ObjectOperator, ObjectOperatorMixin):
+    _op_module_ = "maxframe.learn.contrib.models"
+    _op_type_ = opcodes.APPLY_CHUNK
+
+    func = FunctionField("func")
+    args = TupleField("args")
+    kwargs = DictField("kwargs")
+
+    def __init__(self, output_types=None, **kwargs):
+        if not isinstance(output_types, (tuple, list)):
+            output_types = [output_types]
+        self._output_types = list(output_types)
+        super().__init__(**kwargs)
+
+    def _set_inputs(self, inputs):
+        super()._set_inputs(inputs)
+        old_inputs = find_objects(self.args, ENTITY_TYPE) + find_objects(
+            self.kwargs, ENTITY_TYPE
+        )
+        mapping = {o: n for o, n in zip(old_inputs, self._inputs[1:])}
+        self.args = replace_objects(self.args, mapping)
+        self.kwargs = replace_objects(self.kwargs, mapping)
+
+    @property
+    def output_limit(self) -> int:
+        return len(self._output_types)
+
+    def __call__(self, t, output_kws, args=None, **kwargs):
+        self.args = args or ()
+        self.kwargs = kwargs
+        inputs = (
+            [t]
+            + find_objects(self.args, ENTITY_TYPE)
+            + find_objects(self.kwargs, ENTITY_TYPE)
+        )
+        return self.new_tileables(inputs, kws=output_kws)
+
+
+def to_remote_model(model, model_cls):
+    op = ModelDataSource(data=model)
+    return op(model_cls)

maxframe/learn/contrib/utils.py

@@ -11,6 +11,7 @@
 # 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 sys
 
 

maxframe/learn/contrib/xgboost/__init__.py

@@ -12,11 +12,14 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from ..utils import config_mod_getattr as _config_mod_getattr
+from .core import Booster
 from .dmatrix import DMatrix
 from .predict import predict
 from .train import train
 
+# isort: off
+from ..utils import config_mod_getattr as _config_mod_getattr
+
 _config_mod_getattr(
     {
         "XGBClassifier": ".classifier.XGBClassifier",
@@ -24,3 +27,7 @@ _config_mod_getattr(
     },
     globals(),
 )
+
+del _config_mod_getattr
+
+__all__ = ["Booster", "DMatrix", "XGBClassifier", "XGBRegressor", "predict", "train"]

maxframe/learn/contrib/xgboost/classifier.py

@@ -12,9 +12,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from typing import Union
+
 import numpy as np
 
-from ....tensor import argmax, transpose
+from .... import tensor as mt
 from ....tensor.merge.vstack import _vstack
 from ..utils import make_import_error_func
 from .core import XGBScikitLearnBase, xgboost
@@ -33,6 +35,14 @@ else:
         Implementation of the scikit-learn API for XGBoost classification.
         """
 
+        def __init__(
+            self,
+            xgb_model: Union[xgboost.XGBClassifier, xgboost.Booster] = None,
+            **kwargs,
+        ):
+            super().__init__(**kwargs)
+            self._set_model(xgb_model)
+
         def fit(
             self,
             X,
@@ -46,7 +56,7 @@ else:
             **kw,
         ):
             session = kw.pop("session", None)
-            run_kwargs = kw.pop("run_kwargs", dict())
+            run_kwargs = kw.pop("run_kwargs", None) or dict()
             dtrain, evals = wrap_evaluation_matrices(
                 None,
                 X,
@@ -58,6 +68,7 @@ else:
                 base_margin_eval_set,
             )
             params = self.get_xgb_params()
+            self._n_features_in = X.shape[1]
             self.n_classes_ = num_class or 1
             if self.n_classes_ > 2:
                 params["objective"] = "multi:softprob"
@@ -81,7 +92,7 @@ else:
         def predict(self, data, **kw):
             prob = self.predict_proba(data, flag=True, **kw)
             if prob.ndim > 1:
-                prediction = argmax(prob, axis=1)
+                prediction = mt.argmax(prob, axis=1)
             else:
                 prediction = (prob > 0.5).astype(np.int64)
             return prediction
@@ -103,7 +114,7 @@ else:
             # binary logistic function
             classone_probs = prediction
             classzero_probs = 1.0 - classone_probs
-            return transpose(_vstack((classzero_probs, classone_probs)))
+            return mt.transpose(_vstack((classzero_probs, classone_probs)))
 
         @property
         def classes_(self) -> np.ndarray: