hjxdl 0.3.20__py3-none-any.whl → 0.3.22__py3-none-any.whl

hdl/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.3.20'
-__version_tuple__ = version_tuple = (0, 3, 20)
+__version__ = version = '0.3.22'
+__version_tuple__ = version_tuple = (0, 3, 22)

hdl/utils/llm/llm_wrapper.py

@@ -2,7 +2,6 @@ import yaml
 import typing as t
 
 from openai import OpenAI
-import instructor
 
 
 class OpenAIWrapper(object):
@@ -14,6 +13,32 @@ class OpenAIWrapper(object):
         *args,
         **kwargs
     ):
+        """
+        Initializes the client configuration for the class.
+
+        Args:
+            client_conf (dict, optional): A dictionary containing client configuration. If None,
+                client configuration will be loaded from the specified directory.
+            client_conf_dir (str, optional): The directory from which to load client configuration
+                if `client_conf` is None. Must be provided in that case.
+            load_conf (bool, optional): A flag indicating whether to load the client
+                configuration from the directory. Defaults to True.
+            *args: Variable length argument list for client initialization.
+            **kwargs: Arbitrary keyword arguments for client initialization.
+
+        Raises:
+            AssertionError: If `client_conf` is None and `client_conf_dir` is also None.
+
+        Note:
+            The method will create a client for each configuration found in `client_conf`,
+            initializing the client with the specified `base_url` and `api_key`.
+        Examples:
+            >>> llm = OpenAIWrapper(
+            >>>     client_conf_dir="/some/path/model_conf.yaml",
+            >>>     # load_conf=False
+            >>> )
+)
+        """
         self.client_conf = {}
         if client_conf is None:
             assert client_conf_dir is not None
@@ -41,6 +66,31 @@ class OpenAIWrapper(object):
         api_key: str = "dummy_key",
         **kwargs
     ):
+        """
+        Add a new client configuration to the client manager.
+
+        This method stores the configuration details for a new client identified by the
+        provided client ID. It constructs the host URL based on the input parameters
+        and initializes an OpenAI client instance.
+
+        Args:
+            client_id (str): Unique identifier for the client.
+            host (str): Hostname or IP address of the client.
+            port (int, optional): Port number for the client connection. Defaults to None.
+            model (str, optional): Model to use for the client. Defaults to "default_model".
+            api_key (str, optional): API key for authentication. Defaults to "dummy_key".
+            **kwargs: Additional keyword arguments passed to the OpenAI client.
+
+        Raises:
+            ValueError: If both host and port are not valid for constructing a URL.
+        Examples:
+            >>> llm.add_client(
+            >>>     client_id="rone",
+            >>>     host="127.0.0.1",
+            >>>     port=22299,
+            >>>     model="ictrek/rone:1.5b32k",
+            >>> )
+        """
         self.client_conf[client_id] = {}
         if not host.startswith('http') and port:
             host = f"http://{host}:{port}/v1"
@@ -53,6 +103,22 @@ class OpenAIWrapper(object):
         )
 
     def load_clients(self):
+        """
+        Loads client configuration from a YAML file and updates the 'host' field
+        for each client entry, ensuring the correct URL format.
+
+        This method reads the client configuration from the specified path,
+        updates the 'host' field to include the appropriate port and the
+        'http' protocol if not already specified, and stores the updated
+        configuration in the `client_conf` attribute.
+
+        Attributes:
+            client_conf_path (str): The file path to the client configuration YAML file.
+            client_conf (dict): The updated client configuration after processing.
+
+        Returns:
+            None
+        """
         with open(self.client_conf_path, 'r') as file:
             data = yaml.safe_load(file)
 
@@ -79,11 +145,32 @@ class OpenAIWrapper(object):
         response_model = None,
         **kwargs: t.Any,
     ):
+        """
+        Generates a response from a chat model based on the given prompt and additional context.
+
+        Args:
+            prompt (str): The main text prompt to send to the chat model.
+            client_id (str, optional): Identifier for the client configuration. Defaults to None.
+            history (list, optional): A list of previous messages to provide context for the conversation. Each message should be a dictionary with "role" and "content". Defaults to None.
+            sys_info (str, optional): System-level information to set the context of the chat. Defaults to None.
+            assis_info (str, optional): Information from the assistant to be included in the conversation. Defaults to None.
+            images (list, optional): A list of images to include in the message content. Defaults to None.
+            image_keys (tuple, optional): Keys to format the image data. Must be of length 1 or 2. Defaults to ("image_url", "url").
+            model (str, optional): The model to use for generating the response. If not provided, it defaults to the one in client configuration for the given client_id.
+            tools (list, optional): List of tools to be available during the chat. Defaults to None.
+            stream (bool, optional): Whether to stream the response. Defaults to True.
+            response_model (optional): Specifies the response model to use. Defaults to None.
+            **kwargs (Any): Additional configuration parameters.
+
+        Returns:
+            Response: The response object from the chat model.
+        """
         if not model:
             model = self.client_conf[client_id]['model']
 
         client = self.client_conf[client_id]['client']
         if response_model:
+            import instructor #TODO 有些模型支持这个 instructor 的结构化输出，但实际上它调用的还是openai api的功能，以后适时删除或补全
             client = instructor.from_openai(client)
 
         messages = []
@@ -157,6 +244,29 @@ class OpenAIWrapper(object):
         prompt,
         **kwargs
     ):
+        """
+        Invoke the API to get a response based on the provided prompt.
+
+        Args:
+            prompt (str): The input prompt to be processed.
+            **kwargs: Additional keyword arguments to customize the API request.
+
+        Returns:
+            dict: A dictionary containing the type of response and its contents.
+                  The possible keys are:
+                  - 'type' (str): Indicates the type of response ('text' or 'tool_calls').
+                  - 'contents' (str, optional): The text content if the response type is 'text'.
+                  - 'tool_params' (dict, optional): The parameters of the tool called if the response type is 'tool_calls'.
+
+        Examples:
+            >>> llm.invoke(
+            >>>     client_id="glm_4_flash",
+            >>>     prompt="深圳天气怎么样？",
+            >>>     tools=[TOOL_DICT['get_weather']],
+            >>> )
+            {'type': 'tool_calls',
+             'tool_parmas': Function(arguments='{"location": "Shenzhen"}', name='get_weather')}
+        """
         answer_dict = {}
 
         resp = self.get_resp(
@@ -174,6 +284,34 @@ class OpenAIWrapper(object):
         return answer_dict
 
     def stream(self, prompt, **kwargs):
+        """
+        Streams responses based on the provided prompt, yielding chunks of data.
+
+        This function calls the `get_resp` method with the prompt and additional keyword arguments,
+        streaming the response in chunks. It processes each chunk to yield either tool call parameters
+        or textual content. If an error occurs while processing the chunks, it yields an error message.
+
+        Args:
+            prompt (str): The input prompt to generate responses for.
+            **kwargs: Additional keyword arguments to be passed to the `get_resp` method.
+
+        Yields:
+            dict: A dictionary with the following possible keys:
+                - type (str): Indicates the type of the response ('tool_calls', 'text', or 'error').
+                - tool_params (dict, optional): Parameters of the tool call if the type is 'tool_calls'.
+                - content (str, optional): The generated text content if the type is 'text'.
+                - message (str, optional): An error message if the type is 'error'.
+
+        Examplse:
+            >>> resp = llm.stream(
+            >>>     client_id="r1", #此模型可以进行cot
+            >>>     prompt=prompt,
+            >>>     # tools=[TOOL_DICT['get_weather']],
+            >>> )
+            >>> for i in resp:
+            >>>     if i['type'] == 'text' and i['content']:
+            >>>         print(i['content'], flush=True, end="")
+        """
         resp = self.get_resp(prompt=prompt, stream=True, **kwargs)
 
         for chunk in resp:
@@ -206,7 +344,3 @@ class OpenAIWrapper(object):
                 return
 
         return
-
-
-
-

{hjxdl-0.3.20.dist-info → hjxdl-0.3.22.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: hjxdl
-Version: 0.3.20
+Version: 0.3.22
 Summary: A collection of functions for Jupyter notebooks
 Home-page: https://github.com/huluxiaohuowa/hdl
 Author: Jianxing Hu

{hjxdl-0.3.20.dist-info → hjxdl-0.3.22.dist-info}/RECORD

@@ -1,5 +1,5 @@
 hdl/__init__.py,sha256=GffnD0jLJdhkd-vo989v40N90sQbofkayRBwxc6TVhQ,72
-hdl/_version.py,sha256=0XAfq64E2h3BqosuCJunl1ENlgUhVRN79F4E0l9nrdU,413
+hdl/_version.py,sha256=q4JPltmBqBzXzF4sbXugC3X2R4f0B_3ypR7bRe2rY5c,413
 hdl/args/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 hdl/args/loss_args.py,sha256=s7YzSdd7IjD24rZvvOrxLLFqMZQb9YylxKeyelSdrTk,70
 hdl/controllers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -134,15 +134,15 @@ hdl/utils/llm/chatgr.py,sha256=5F5PJHe8vz3iCfi4TT54DCLRi1UeJshECdVtgvvvao0,3696
 hdl/utils/llm/embs.py,sha256=Tf0FOYrOFZp7qQpEPiSCXzlgyHH0X9HVTUtsup74a9E,7174
 hdl/utils/llm/extract.py,sha256=2sK_WJzmYIc8iuWaM9DA6Nw3_6q1O4lJ5pKpcZo-bBA,6512
 hdl/utils/llm/llama_chat.py,sha256=watcHGOaz-bv3x-yDucYlGk5f8FiqfFhwWogrl334fk,4387
-hdl/utils/llm/llm_wrapper.py,sha256=94xfPIR_eP7_S8FMCmRDvYpMnKpv9qVR9eDs2F7Nq-Y,6420
+hdl/utils/llm/llm_wrapper.py,sha256=DVpt4TeFN3uWsL1L6BQT4FUKFOvilSNhbR9tfVJIQus,13663
 hdl/utils/llm/vis.py,sha256=SSP6tOwKLq0hWcpM3twI9TitqzBmKjlcGrnXEWYlCzM,26055
 hdl/utils/llm/visrag.py,sha256=0i-VrxqgiV-J7R3VPshu9oc7-rKjFJOldYik3HDXj6M,10176
 hdl/utils/schedulers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 hdl/utils/schedulers/norm_lr.py,sha256=bDwCmdEK-WkgxQMFBiMuchv8Mm7C0-GZJ6usm-PQk14,4461
 hdl/utils/weather/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 hdl/utils/weather/weather.py,sha256=k11o6wM15kF8b9NMlEfrg68ak-SfSYLN3nOOflFUv-I,4381
-hjxdl-0.3.20.dist-info/LICENSE,sha256=lkMiSbeZHBQLB9LJEkS9-L3Z-LBC4yGnKrzHSG8RkPM,2599
-hjxdl-0.3.20.dist-info/METADATA,sha256=BJx8IbACYa8koyo5VGzB4q9R348FSz5U03Z_gLcHaXA,1336
-hjxdl-0.3.20.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-hjxdl-0.3.20.dist-info/top_level.txt,sha256=-kxwTM5JPhylp06z3zAVO3w6_h7wtBfBo2zgM6YZoTk,4
-hjxdl-0.3.20.dist-info/RECORD,,
+hjxdl-0.3.22.dist-info/LICENSE,sha256=lkMiSbeZHBQLB9LJEkS9-L3Z-LBC4yGnKrzHSG8RkPM,2599
+hjxdl-0.3.22.dist-info/METADATA,sha256=F8oNEqwUBDPVS0izQtAppzqat2aXaMm4uE68j6pGyGE,1336
+hjxdl-0.3.22.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+hjxdl-0.3.22.dist-info/top_level.txt,sha256=-kxwTM5JPhylp06z3zAVO3w6_h7wtBfBo2zgM6YZoTk,4
+hjxdl-0.3.22.dist-info/RECORD,,