hjxdl 0.3.21__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.21'
-__version_tuple__ = version_tuple = (0, 3, 21)
+__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):
@@ -33,6 +32,12 @@ class OpenAIWrapper(object):
         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:
@@ -78,6 +83,13 @@ class OpenAIWrapper(object):
 
         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:
@@ -158,6 +170,7 @@ class OpenAIWrapper(object):
 
         client = self.client_conf[client_id]['client']
         if response_model:
+            import instructor #TODO 有些模型支持这个 instructor 的结构化输出，但实际上它调用的还是openai api的功能，以后适时删除或补全
             client = instructor.from_openai(client)
 
         messages = []
@@ -244,6 +257,15 @@ class OpenAIWrapper(object):
                   - '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 = {}
 
@@ -279,6 +301,16 @@ class OpenAIWrapper(object):
                 - 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)
 
@@ -312,7 +344,3 @@ class OpenAIWrapper(object):
                 return
 
         return
-
-
-
-

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: hjxdl
-Version: 0.3.21
+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.21.dist-info → hjxdl-0.3.22.dist-info}/RECORD

@@ -1,5 +1,5 @@
 hdl/__init__.py,sha256=GffnD0jLJdhkd-vo989v40N90sQbofkayRBwxc6TVhQ,72
-hdl/_version.py,sha256=RePWyWgLItSCeI7HV40DbnyFzjteC1Gpxd4cuRPe79I,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=sg1uh06yd5gEnHVhSp6FgQI9cOGFVJt0e0_vYpzpRPE,12377
+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.21.dist-info/LICENSE,sha256=lkMiSbeZHBQLB9LJEkS9-L3Z-LBC4yGnKrzHSG8RkPM,2599
-hjxdl-0.3.21.dist-info/METADATA,sha256=4iJS1jchqo13kaCQ7DzOspSZT1E4d3NJkn1bk75cGmc,1336
-hjxdl-0.3.21.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-hjxdl-0.3.21.dist-info/top_level.txt,sha256=-kxwTM5JPhylp06z3zAVO3w6_h7wtBfBo2zgM6YZoTk,4
-hjxdl-0.3.21.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,,