hjxdl 0.1.23__py3-none-any.whl → 0.1.25__py3-none-any.whl

hdl/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.1.23'
-__version_tuple__ = version_tuple = (0, 1, 23)
+__version__ = version = '0.1.25'
+__version_tuple__ = version_tuple = (0, 1, 25)

hdl/utils/llm/chat.py

@@ -332,25 +332,20 @@ class OpenAI_M():
         *args,
         **kwargs
     ):
-        """Initialize the OpenAI client.
+        """Initialize the OpenAI client with the specified parameters.
 
         Args:
-            model_path (str): Path to the model file. Defaults to "default_model".
-            device (str): Device to use for model inference. Defaults to 'gpu'.
-            generation_kwargs (dict): Additional keyword arguments for model generation. Defaults to {}.
-            server_ip (str): IP address of the server. Defaults to "172.28.1.2".
-            server_port (int): Port number of the server. Defaults to 8000.
-            api_key (str): API key for authentication. Defaults to "dummy_key".
-            *args: Variable length argument list.
-            **kwargs: Arbitrary keyword arguments.
+            model_path (str): Path to the model (default is "default_model").
+            device (str): Device to use (default is 'gpu').
+            generation_kwargs (dict): Additional generation arguments (default is an empty dictionary).
+            server_ip (str): IP address of the server (default is "172.28.1.2").
+            server_port (int): Port of the server (default is 8000).
+            api_key (str): API key for authentication (default is "dummy_key").
+            tools (list): List of tools.
+            tool_desc (dict): Description of tools.
 
-        Attributes:
-            model_path (str): Path to the model file.
-            server_ip (str): IP address of the server.
-            server_port (int): Port number of the server.
-            base_url (str): Base URL for API requests.
-            api_key (str): API key for authentication.
-            client (OpenAI): OpenAI client for making API requests.
+        Raises:
+            ValueError: If an invalid argument is provided.
         """
         # self.model_path = model_path
         self.server_ip = server_ip
@@ -439,6 +434,18 @@ class OpenAI_M():
         prompt: str,
         **kwargs: t.Any
     ):
+        """Get decision based on the provided prompt and additional keyword arguments.
+
+        Args:
+            prompt (str): The prompt for decision making.
+            **kwargs: Additional keyword arguments.
+
+        Returns:
+            dict: A dictionary containing the decision.
+
+        Example:
+            decision = get_decision("Should I buy this product?", option1="yes", option2="no")
+        """
         prompt_final = FN_TEMPLATE
         for tool in self.tools:
             prompt_final += self.tool_desc.get(tool.__name__, "")
@@ -453,6 +460,15 @@ class OpenAI_M():
         prompt: str,
         **kwargs: t.Any
     ):
+        """Get the result from a tool based on the provided prompt and keyword arguments.
+
+            Args:
+                prompt (str): The prompt to get the decision for.
+                **kwargs: Additional keyword arguments to pass to the decision function.
+
+            Returns:
+                str: The result from the selected tool based on the decision made.
+        """
         decision_dict = self.get_decision(prompt, **kwargs)
         if decision_dict.get("function_name", None) is None:
             return ""
@@ -471,7 +487,17 @@ class OpenAI_M():
         stream = True,
         **kwargs: t.Any
     ):
+        """'''Generate agent response based on the given prompt.
 
+        Args:
+            prompt (str): The prompt for which agent response is generated.
+            stream (bool, optional): Flag to determine if the response should be streamed. Defaults to True.
+            **kwargs: Additional keyword arguments.
+
+        Returns:
+            str: The agent response based on the prompt.
+        '''
+        """
         decision_dict = self.get_decision(prompt, **kwargs)
         if decision_dict.get("function_name", None) is None:
             return self.stream(prompt, **kwargs)

hdl/utils/weather/weather.py

@@ -10,6 +10,11 @@ from ..llm.embs import HFEmbedder
 
 
 def get_city_codes():
+    """Get city codes from a JSON file.
+
+    Returns:
+        dict: A dictionary containing city codes.
+    """
     # with open('../../city.json', 'r', encoding='utf-8') as f:
     #     code_dic = eval(f.read())
     # return code_dic
@@ -22,6 +27,17 @@ def get_city_codes():
 
 
 def get_html(code):
+    """Get the HTML content of a weather webpage based on the provided code.
+
+    Args:
+        code (str): The code used to identify the specific weather webpage.
+
+    Returns:
+        str: The HTML content of the weather webpage.
+
+    Example:
+        html_content = get_html('101010100')
+    """
     weather_url = f'http://www.weather.com.cn/weather/{code}.shtml'
     header = {
         "User-Agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/94.0.4606.81 Safari/537.36"}
@@ -32,6 +48,14 @@ def get_html(code):
 
 
 def get_page_data(html):
+    """Get weather information for the next seven days from the provided HTML content.
+
+    Args:
+        html (str): The HTML content containing weather information.
+
+    Returns:
+        str: A formatted string with weather information for the next seven days.
+    """
     soup = BeautifulSoup(html, 'html.parser')
     weather_info = soup.find('div', id='7d')
     seven_weather = weather_info.find('ul')
@@ -62,6 +86,14 @@ def get_page_data(html):
 
 
 def get_weather(city):
+    """Get the weather information for a specific city.
+
+    Args:
+        city (str): The name of the city to get weather information for.
+
+    Returns:
+        str: A string containing the latest weather information for the specified city.
+    """
     code_dic = get_city_codes()
     city_name = city
     weather_str = ""
@@ -82,6 +114,15 @@ def get_standard_cityname(
         '/home/jhu/dev/models/bge-m3'
     )
 ):
+    """Get the standard city name based on the input city name.
+
+    Args:
+        city (str): The input city name.
+        emb_dir (str): The directory path for the embedding model (default is '/home/jhu/dev/models/bge-m3').
+
+    Returns:
+        str: The standard city name.
+    """
     code_dic = get_city_codes()
     city_list = list(code_dic.keys())
 

{hjxdl-0.1.23.dist-info → hjxdl-0.1.25.dist-info}/METADATA

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

{hjxdl-0.1.23.dist-info → hjxdl-0.1.25.dist-info}/RECORD

@@ -1,5 +1,5 @@
 hdl/__init__.py,sha256=GffnD0jLJdhkd-vo989v40N90sQbofkayRBwxc6TVhQ,72
-hdl/_version.py,sha256=sfQd5PJr9QXyrhyCJmUy3FxYrMpjvCnNhW8XGLw-MjA,413
+hdl/_version.py,sha256=2z8sOHys3QouaDyoTFldOod5mPhdtLw8dgODNwh6eyY,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
@@ -125,14 +125,14 @@ hdl/utils/desc/template.py,sha256=uKPGIgYFgSY4uBvfsbh5fZN7s39NdGQ2XSVH3pIpsuc,10
 hdl/utils/general/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 hdl/utils/general/glob.py,sha256=8-RCnt6L297wMIfn34ZAMCsGCZUjHG3MGglGZI1cX0g,491
 hdl/utils/llm/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-hdl/utils/llm/chat.py,sha256=RJgiDTW16Ah-bYDySW9QWhkD_VZf9Q3uBZcO7vXZuvA,16877
+hdl/utils/llm/chat.py,sha256=cpXgfHtjDz0A5HIInwODQ2kM04hdDsllTqalOU9wmQs,17784
 hdl/utils/llm/embs.py,sha256=Tf0FOYrOFZp7qQpEPiSCXzlgyHH0X9HVTUtsup74a9E,7174
 hdl/utils/llm/extract.py,sha256=2sK_WJzmYIc8iuWaM9DA6Nw3_6q1O4lJ5pKpcZo-bBA,6512
 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=bkN2kFHIC2r9HNfJoKTgj1tZ6f9AYCGyYDG2OpbyYD4,3164
-hjxdl-0.1.23.dist-info/METADATA,sha256=xXXbNXBK6oKhcbaFwWNQBPpnrVjDeT0BSUHDKLkTdVE,627
-hjxdl-0.1.23.dist-info/WHEEL,sha256=UvcQYKBHoFqaQd6LKyqHw9fxEolWLQnlzP0h_LgJAfI,91
-hjxdl-0.1.23.dist-info/top_level.txt,sha256=-kxwTM5JPhylp06z3zAVO3w6_h7wtBfBo2zgM6YZoTk,4
-hjxdl-0.1.23.dist-info/RECORD,,
+hdl/utils/weather/weather.py,sha256=k11o6wM15kF8b9NMlEfrg68ak-SfSYLN3nOOflFUv-I,4381
+hjxdl-0.1.25.dist-info/METADATA,sha256=nOQQlDQJmZ6C5W5oedJIMy_5cB1HLtwgJC6PJlFw8pg,627
+hjxdl-0.1.25.dist-info/WHEEL,sha256=UvcQYKBHoFqaQd6LKyqHw9fxEolWLQnlzP0h_LgJAfI,91
+hjxdl-0.1.25.dist-info/top_level.txt,sha256=-kxwTM5JPhylp06z3zAVO3w6_h7wtBfBo2zgM6YZoTk,4
+hjxdl-0.1.25.dist-info/RECORD,,