hjxdl 0.2.80__py3-none-any.whl → 0.2.82__py3-none-any.whl

hdl/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.2.80'
-__version_tuple__ = version_tuple = (0, 2, 80)
+__version__ = version = '0.2.82'
+__version_tuple__ = version_tuple = (0, 2, 82)

hdl/utils/database_tools/web.py

@@ -58,11 +58,20 @@ def web_search_text(
 
 def fetch_baidu_results(query, max_n_links=3):
     """
-    模拟百度搜索，提取前三个搜索结果的网页文字内容并拼接返回。
-
-    :param query: str 要搜索的文本
-    :return: str 提取的网页内容拼接字符串
+    Fetches search results from Baidu for a given query and retrieves the text content of the top results.
+    Args:
+        query (str): The search query to be sent to Baidu.
+        max_n_links (int, optional): The maximum number of search result links to fetch. Defaults to 3.
+    Returns:
+        str: The concatenated text content of the fetched web pages.
+    Raises:
+        requests.RequestException: If there is an issue with the HTTP request.
     """
+    try:
+        max_n_links = int(max_n_links)
+    except Exception as e:
+        print(e)
+        max_n_links = 3
     headers = {
         'User-Agent': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36'
     }
@@ -100,13 +109,14 @@ def fetch_baidu_results(query, max_n_links=3):
 
 def wolfram_alpha_calculate(query):
     """
-    This function sends a query to Wolfram Alpha and returns the calculation result.
-
-    Parameters:
-    query (str): The query string to send to Wolfram Alpha.
-
+    Sends a query to the Wolfram Alpha API and returns the result.
+    Args:
+        query (str): The query string to be sent to Wolfram Alpha.
     Returns:
-    str: The calculation result from Wolfram Alpha, or an error message if the request fails.
+        str: The result of the query in plaintext format, or an error message if the query was unsuccessful or if an error occurred.
+    Raises:
+        requests.Timeout: If the request to Wolfram Alpha times out.
+        Exception: If any other error occurs during the request.
     """
     # Get the Wolfram Alpha App ID from environment variables
     app_id = os.getenv('WOLFRAM_APP_ID', None)

hdl/utils/general/glob.py

@@ -2,6 +2,14 @@ import subprocess
 
 
 def get_num_lines(file):
+    """
+    Get the number of lines in a given file.
+    Args:
+        file (str): The path to the file.
+    Returns:
+        int: The number of lines in the file.
+    """
+
     num_lines = subprocess.check_output(
         ['wc', '-l', file]
     ).split()[0]
@@ -9,6 +17,15 @@ def get_num_lines(file):
 
 
 def str_from_line(file, line, split=False):
+    """
+    Extracts a specific line from a file and optionally splits the line.
+    Args:
+        file (str): The path to the file from which to extract the line.
+        line (int): The line number to extract (0-based index).
+        split (bool, optional): If True, splits the line at the first space or tab and returns the first part. Defaults to False.
+    Returns:
+        str: The extracted line, optionally split at the first space or tab.
+    """
     smi = subprocess.check_output(
         # ['sed','-n', f'{str(i+1)}p', file]
         ["sed", f"{str(line + 1)}q;d", file]

hdl/utils/general/runners.py

@@ -61,14 +61,17 @@ def calculate(expression):
 
 def count_character_occurrences(text, char):
     """
-    统计文本中某个字符出现的次数
+    Count the occurrences of a character in a text.
 
     Args:
-        text (str): 输入的单词或句子
-        char (str): 要统计的字符（仅支持单个字符）
+        text (str): The text in which to count character occurrences.
+        char (str): The character to count occurrences of.
 
     Returns:
-        int: 字符在文本中出现的次数
+        str: A string indicating how many times the character appears in the text.
+
+    Raises:
+        ValueError: If the input text is not a string or if the character is not a single character string.
     """
     if not isinstance(text, str):
         raise ValueError("输入的文本必须是字符串类型")
@@ -77,4 +80,4 @@ def count_character_occurrences(text, char):
     text = text.lower()
     char = char.lower()
 
-    return f"{text} 中 {char} 共出现了 {text.count(char)} 次。"
+    return f"{text} 中 {char} 共出现了 {text.count(char)} 次。"

hdl/utils/llm/chat.py

@@ -14,6 +14,15 @@ import json
 # import traceback
 
 def parse_fn_markdown(markdown_text, params_key="params"):
+    """
+    Parses a markdown text to extract function name and parameters.
+    Args:
+        markdown_text (str): The markdown text containing the function name and parameters.
+        params_key (str, optional): The key under which the parameters will be nested in the result dictionary. Defaults to "params".
+    Returns:
+        dict: A dictionary containing the function name and parameters. The function name is stored with the key "function_name", and the parameters are nested under the specified params_key.
+    """
+
     lines = markdown_text.strip().split("\n")
     result = {}
     params = {}
@@ -53,6 +62,23 @@ def parse_fn_markdown(markdown_text, params_key="params"):
     return result
 
 def parse_cot_markdown(markdown_text):
+    """
+    Parse a Markdown text formatted as 'COT' (Title, Tool, Content, Stop Thinking) and extract relevant information.
+
+    Args:
+        markdown_text (str): The Markdown text to parse.
+
+    Returns:
+        dict: A dictionary containing the parsed information with the following keys:
+            - 'title': Title extracted from the Markdown text.
+            - 'tool': Tool extracted from the Markdown text.
+            - 'content': Content extracted from the Markdown text.
+            - 'stop_thinking': Boolean indicating whether 'stop_thinking' is true or false.
+
+    Note:
+        - 'stop_thinking' value is considered True only if it is explicitly 'true' (case-insensitive).
+
+    """
     # 提取标题（支持跨行）
     title_match = re.search(r"##\s*(.+?)(?=\n-|\Z)", markdown_text, re.DOTALL)
     title = title_match.group(1).strip() if title_match else ""
@@ -78,6 +104,7 @@ def parse_cot_markdown(markdown_text):
     }
 
 
+
 def run_tool_with_kwargs(tool, func_kwargs):
     """Run the specified tool with the provided keyword arguments.
 
@@ -108,6 +135,24 @@ class OpenAI_M():
         *args,
         **kwargs
     ):
+        """
+        Initialize an instance of the OpenAI_M class with configuration options.
+
+        Args:
+            model_path (str): Path to the model. Defaults to "default_model".
+            device (str): Device to use, either 'gpu' or 'cpu'. Defaults to 'gpu'.
+            generation_kwargs (dict, optional): Additional keyword arguments for generation.
+            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".
+            use_groq (bool): Flag to use Groq client. Defaults to False.
+            groq_api_key (str, optional): API key for Groq client.
+            tools (list, optional): List of tools to be used.
+            tool_desc (dict, optional): Additional tool descriptions.
+            cot_desc (str, optional): Chain of Thought description.
+            *args: Additional positional arguments.
+            **kwargs: Additional keyword arguments.
+        """
         # self.model_path = model_path
         self.server_ip = server_ip
         self.server_port = server_port
@@ -155,14 +200,22 @@ class OpenAI_M():
         steps: list = None,
         **kwargs
     ):
-        """_summary_
+        """
+        Execute a Chain of Thought (COT) process to iteratively generate steps
+        towards solving a given prompt, utilizing tools if necessary.
 
         Args:
-            prompt (_type_): _description_
-            max_step (int, optional): _description_. Defaults to 30.
+            prompt (str): The initial question or problem to solve.
+            max_step (int, optional): Maximum number of steps to attempt. Defaults to 30.
+            steps (list, optional): List to accumulate steps taken. Defaults to None.
+            **kwargs: Additional keyword arguments for tool invocation.
 
-        Returns:
-            _type_: _description_
+        Yields:
+            tuple: A tuple containing the current step number, accumulated information,
+            and the list of steps taken.
+
+        Raises:
+            Exception: If an error occurs during the parsing or tool invocation process.
         """
         # 初始化当前信息为空字符串，用于累积后续的思考步骤和用户问题
         current_info = ""

hdl/utils/llm/chatgr.py

@@ -32,11 +32,11 @@ def chat_with_llm(user_input, chat_history=[]):
 def create_demo():
     """
     Creates a Gradio demo interface for a chatbot application.
-    The interface consists of:
+    The interface includes:
     - A chat history display at the top of the page.
-    - A user input textbox and a send button at the bottom of the page.
-    The send button and the enter key are both bound to the `chat_with_llm` function,
-    which handles sending the user's message and updating the chat history.
+    - A user input textbox at the bottom of the page.
+    - A send button to submit messages.
+    The user can send messages either by clicking the send button or by pressing the Enter key.
     Returns:
         gr.Blocks: The Gradio Blocks object representing the demo interface.
     """

{hjxdl-0.2.80.dist-info → hjxdl-0.2.82.dist-info}/METADATA

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

{hjxdl-0.2.80.dist-info → hjxdl-0.2.82.dist-info}/RECORD

@@ -1,5 +1,5 @@
 hdl/__init__.py,sha256=GffnD0jLJdhkd-vo989v40N90sQbofkayRBwxc6TVhQ,72
-hdl/_version.py,sha256=dMhu6bTZ2DnK2Ao7umsywyrYd1I_j8b4qEG947KjLAc,413
+hdl/_version.py,sha256=e3IzU75tUXwJv1hSzAqotnR7QIz2cy3BvcTNm40NY9c,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
@@ -120,16 +120,16 @@ hdl/utils/chemical_tools/sdf.py,sha256=71PEqU0H885L6IeGHEa6n7ZLZThvMsZOVLuFG2wno
 hdl/utils/database_tools/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 hdl/utils/database_tools/connect.py,sha256=xCacGucKxlQUXs6AsNddpeECvdqT1180V1ZWqHrUdNA,875
 hdl/utils/database_tools/datetime.py,sha256=xqE2xNiOpADzX-R8_bM0bioJRF3Ay9Jp1CAG6dy6uVI,1202
-hdl/utils/database_tools/web.py,sha256=PJ7R1chUD-vz-Up0orfFqdrZq3CFOlwiO9gIjFSb-R8,5224
+hdl/utils/database_tools/web.py,sha256=awJ8lafL-2KRjf3V1uuij8JIvX9U5fI8fLZKOkOvqtk,5771
 hdl/utils/desc/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 hdl/utils/desc/func_desc.py,sha256=VCqjvZs7qCwBq3NR3ZRknl4oiO5-JP7xm-Rx85W2exg,3365
 hdl/utils/desc/template.py,sha256=GJSXkVzdTAQoNT3j7YTLhz8-4CmvCMt2gLr7YBYPRWw,2192
 hdl/utils/general/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-hdl/utils/general/glob.py,sha256=8-RCnt6L297wMIfn34ZAMCsGCZUjHG3MGglGZI1cX0g,491
-hdl/utils/general/runners.py,sha256=EFTk9PeVnqc51yU4b-HxsLwJyMA7dFMZBsdAa-VZ-sQ,2880
+hdl/utils/general/glob.py,sha256=Zuf7WHU0UdUPOs9UrhxmrCiMC8GrHxQU6n3mTThv6yc,1120
+hdl/utils/general/runners.py,sha256=x7QBolp3MrqNV6L4rB6Ueybr26bqkRFZTuXhY0SwyLk,3061
 hdl/utils/llm/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-hdl/utils/llm/chat.py,sha256=MoOI80SPQUkgGob09XLKuPV5DwDJ0yG8e8wgBsYWmXA,20458
-hdl/utils/llm/chatgr.py,sha256=A9SCWAvQulgO2x0ArIqcmgd_iVWVbSi1Oj15Diwb3Ok,3743
+hdl/utils/llm/chat.py,sha256=JnegglANgyp-avF4BdnhGji1w-x2wtonPPgjllsquV0,23283
+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
@@ -139,7 +139,7 @@ hdl/utils/schedulers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hS
 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.2.80.dist-info/METADATA,sha256=AzpsfvWDd8RKp3inYLv7qZt_qJueTUPAiaBCqlQO2aw,836
-hjxdl-0.2.80.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-hjxdl-0.2.80.dist-info/top_level.txt,sha256=-kxwTM5JPhylp06z3zAVO3w6_h7wtBfBo2zgM6YZoTk,4
-hjxdl-0.2.80.dist-info/RECORD,,
+hjxdl-0.2.82.dist-info/METADATA,sha256=o5ShJ2TtbtQjRWiWt_laol2kYbOys3NYLJsJdvffplo,836
+hjxdl-0.2.82.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+hjxdl-0.2.82.dist-info/top_level.txt,sha256=-kxwTM5JPhylp06z3zAVO3w6_h7wtBfBo2zgM6YZoTk,4
+hjxdl-0.2.82.dist-info/RECORD,,