structai 0.1.2__tar.gz → 0.1.4__tar.gz

{structai-0.1.2/structai.egg-info → structai-0.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: structai
-Version: 0.1.2
+Version: 0.1.4
 Summary: A utility package for AI development
 Author-email: Wanghan Xu <xu_wanghan@sjtu.edu.cn>
 Project-URL: Homepage, https://github.com/black-yt/structai
@@ -41,9 +41,15 @@ cd structai
 pip install -e .
 ```
 
-## API Reference & Usage
+## Usage
 
-### `load_file(path)`
+> **Note:** Before using LLM-related features, please ensure you have set the necessary environment variables:
+> ```bash
+> export LLM_API_KEY="your-api-key"
+> export LLM_BASE_URL="your-api-base-url"
+> ```
+
+#### `load_file(path)`
 
 Automatically reads a file based on its extension.
 
@@ -62,7 +68,7 @@ df = load_file("data.csv")
 image = load_file("photo.jpg")
 ```
 
-### `save_file(data, path)`
+#### `save_file(data, path)`
 
 Automatically saves data to a file based on the extension.
 
@@ -78,7 +84,7 @@ save_file(data, "output.json")
 save_file(data, "backup.pkl")
 ```
 
-### `print_once(msg)`
+#### `print_once(msg)`
 
 Prints a message to stdout only the first time it is called. Useful for logging inside loops.
 
@@ -90,7 +96,7 @@ for i in range(10):
     # process(i)
 ```
 
-### `make_print_once()`
+#### `make_print_once()`
 
 Returns a new function that prints a message only once. This allows for creating local "print once" scopes.
 
@@ -106,7 +112,7 @@ logger1("Hello") # Does nothing
 logger2("World") # Prints "World"
 ```
 
-### `LLMAgent`
+#### `LLMAgent`
 
 A powerful wrapper class for interacting with OpenAI-compatible LLM APIs. It handles retries, timeouts, and structured output validation.
 
@@ -129,9 +135,9 @@ agent = LLMAgent(
 **Basic Usage (`__call__` or `safe_api`):**
 
 ```python
-response = agent("What is the capital of France?")
+response = agent("Generate a random number.", n=3, temperature=1)
 print(response)
-# Output: "Paris"
+# Output: ["Sure! Here's a random number for you: 738", "Sure! Here's a random number: 7382", "Sure! Here's a random number: 487."]
 ```
 
 **Structured Output Validation:**
@@ -141,7 +147,7 @@ You can enforce the output format (List, Dict, or specific types) using `return_
 ```python
 # Enforce a list of integers
 numbers = agent(
-    "Generate 3 random numbers", 
+    "Generate 3 random numbers, for example, [1, 2, 3].", 
     return_example=[1], 
     list_len=3
 )
@@ -149,7 +155,7 @@ numbers = agent(
 
 # Enforce a dictionary with specific keys
 profile = agent(
-    "Create a user profile for Alice", 
+    "Create a user profile for Alice, for example, {'name': Alice, 'age': 1, 'city': 'shanghai'}.", 
     return_example={"name": "str", "age": 1, "city": "str"}
 )
 # Output: {'name': 'Alice', 'age': 25, 'city': 'New York'}
@@ -165,7 +171,20 @@ description = agent(
 )
 ```
 
-### `sanitize_text(text)`
+**Memory Context:**
+
+```python
+history = [
+    {"role": "user", "content": "My name is Bob."},
+    {"role": "assistant", "content": "Hello Bob."}
+]
+answer = agent(
+    "What is my name?", 
+    history=history, 
+)
+```
+
+#### `sanitize_text(text)`
 
 Sanitizes text by keeping only ASCII English characters, digits, and common punctuation. Removes control characters and ANSI codes.
 
@@ -176,7 +195,7 @@ clean = sanitize_text("Hello \x1b[31mWorld\x1b[0m!")
 print(clean) # "Hello World!"
 ```
 
-### `str2dict(s)`
+#### `str2dict(s)`
 
 Robustly converts a string representation of a dictionary to a Python `dict`. It handles common formatting errors and uses `json_repair` as a fallback.
 
@@ -187,7 +206,7 @@ d = str2dict("{'a': 1, 'b': 2}")
 print(d['a']) # 1
 ```
 
-### `str2list(s)`
+#### `str2list(s)`
 
 Robustly converts a string representation of a list to a Python `list`.
 
@@ -198,7 +217,7 @@ l = str2list("[1, 2, 3]")
 print(len(l)) # 3
 ```
 
-### `add_no_proxy_if_private(url)`
+#### `add_no_proxy_if_private(url)`
 
 Checks if the hostname in the URL is a private IP address. If so, it adds it to the `no_proxy` environment variable to bypass proxies.
 
@@ -208,7 +227,7 @@ from structai import add_no_proxy_if_private
 add_no_proxy_if_private("http://192.168.1.100:8080/v1")
 ```
 
-### `read_image(image_path)`
+#### `read_image(image_path)`
 
 Reads an image from a path and returns a PIL Image object.
 
@@ -218,7 +237,7 @@ from structai import read_image
 img = read_image("photo.jpg")
 ```
 
-### `encode_image(image_obj)`
+#### `encode_image(image_obj)`
 
 Encodes a PIL Image object into a base64 string.
 
@@ -228,7 +247,7 @@ from structai import encode_image
 b64_str = encode_image(img)
 ```
 
-### `messages_to_responses_input(messages)`
+#### `messages_to_responses_input(messages)`
 
 Converts standard Chat Completions `messages` format (list of dicts) to the input format required by the Responses API.
 
@@ -239,7 +258,7 @@ messages = [{"role": "user", "content": "Hello"}]
 system_prompt, input_blocks = messages_to_responses_input(messages)
 ```
 
-### `extract_text_outputs(result)`
+#### `extract_text_outputs(result)`
 
 Extracts the text content from an LLM API response object (supports both Chat Completions and Responses API formats).
 
@@ -251,7 +270,7 @@ texts = extract_text_outputs(response)
 print(texts[0])
 ```
 
-### `multi_thread(inp_list, function, max_workers=40, use_tqdm=True)`
+#### `multi_thread(inp_list, function, max_workers=40, use_tqdm=True)`
 
 Executes a function concurrently for each item in `inp_list` using a thread pool.
 
@@ -267,7 +286,7 @@ results = multi_thread(inputs, square, max_workers=4)
 print(results) # [0, 1, 4, 9, ...]
 ```
 
-### `multi_process(inp_list, function, max_workers=40, use_tqdm=True)`
+#### `multi_process(inp_list, function, max_workers=40, use_tqdm=True)`
 
 Executes a function concurrently for each item in `inp_list` using a process pool. Ideal for CPU-bound tasks.
 
@@ -281,7 +300,7 @@ inputs = [{"n": 1000000} for _ in range(5)]
 results = multi_process(inputs, heavy_computation)
 ```
 
-### `run_server(host="0.0.0.0", port=8001)`
+#### `run_server(host="0.0.0.0", port=8001)`
 
 Starts a FastAPI server that acts as a proxy to an OpenAI-compatible LLM provider.
 
@@ -292,7 +311,7 @@ if __name__ == "__main__":
     run_server()
 ```
 
-### `timeout_limit(timeout=None)`
+#### `timeout_limit(timeout=None)`
 
 A decorator that enforces a maximum execution time on a function. Raises `TimeoutError` if the limit is exceeded.
 
@@ -308,7 +327,7 @@ def task():
 task()
 ```
 
-### `run_with_timeout(func, args=(), kwargs=None, timeout=None)`
+#### `run_with_timeout(func, args=(), kwargs=None, timeout=None)`
 
 Runs a function with a specified timeout without using a decorator.
 
@@ -321,7 +340,7 @@ def task(x):
 result = run_with_timeout(task, args=(10,), timeout=1.0)
 ```
 
-### `parse_think_answer(text)`
+#### `parse_think_answer(text)`
 
 Parses a string containing Chain-of-Thought tags (`<think>...</think>` and `<answer>...</answer>`) and returns the content of both.
 
@@ -334,7 +353,7 @@ print(f"Reasoning: {think}")
 print(f"Result: {answer}")
 ```
 
-### `extract_within_tags(content, start_tag='<answer>', end_tag='</answer>', default_return=None)`
+#### `extract_within_tags(content, start_tag='<answer>', end_tag='</answer>', default_return=None)`
 
 Extracts the substring found between two specific tags.
 
@@ -345,7 +364,7 @@ text = "Result: <json>{...}</json>"
 json_str = extract_within_tags(text, "<json>", "</json>")
 ```
 
-### `get_all_file_paths(directory, suffix='')`
+#### `get_all_file_paths(directory, suffix='')`
 
 Recursively retrieves all file paths in a directory that match a given suffix.
 
@@ -357,7 +376,7 @@ py_files = get_all_file_paths(".", suffix=".py")
 print(py_files)
 ```
 
-### `remove_tag(s, tags=["<think>", "</think>", "<answer>", "</answer>"], r="\n")`
+#### `remove_tag(s, tags=["<think>", "</think>", "<answer>", "</answer>"], r="\n")`
 
 Removes specified tags from a string, replacing them with a separator (default newline).
 
@@ -369,4 +388,4 @@ clean_text = remove_tag("<think>...</think> Answer")
 
 ## License
 
-MIT License
+[MIT License](LICENSE)

{structai-0.1.2 → structai-0.1.4}/README.md

@@ -17,9 +17,15 @@ cd structai
 pip install -e .
 ```
 
-## API Reference & Usage
+## Usage
 
-### `load_file(path)`
+> **Note:** Before using LLM-related features, please ensure you have set the necessary environment variables:
+> ```bash
+> export LLM_API_KEY="your-api-key"
+> export LLM_BASE_URL="your-api-base-url"
+> ```
+
+#### `load_file(path)`
 
 Automatically reads a file based on its extension.
 
@@ -38,7 +44,7 @@ df = load_file("data.csv")
 image = load_file("photo.jpg")
 ```
 
-### `save_file(data, path)`
+#### `save_file(data, path)`
 
 Automatically saves data to a file based on the extension.
 
@@ -54,7 +60,7 @@ save_file(data, "output.json")
 save_file(data, "backup.pkl")
 ```
 
-### `print_once(msg)`
+#### `print_once(msg)`
 
 Prints a message to stdout only the first time it is called. Useful for logging inside loops.
 
@@ -66,7 +72,7 @@ for i in range(10):
     # process(i)
 ```
 
-### `make_print_once()`
+#### `make_print_once()`
 
 Returns a new function that prints a message only once. This allows for creating local "print once" scopes.
 
@@ -82,7 +88,7 @@ logger1("Hello") # Does nothing
 logger2("World") # Prints "World"
 ```
 
-### `LLMAgent`
+#### `LLMAgent`
 
 A powerful wrapper class for interacting with OpenAI-compatible LLM APIs. It handles retries, timeouts, and structured output validation.
 
@@ -105,9 +111,9 @@ agent = LLMAgent(
 **Basic Usage (`__call__` or `safe_api`):**
 
 ```python
-response = agent("What is the capital of France?")
+response = agent("Generate a random number.", n=3, temperature=1)
 print(response)
-# Output: "Paris"
+# Output: ["Sure! Here's a random number for you: 738", "Sure! Here's a random number: 7382", "Sure! Here's a random number: 487."]
 ```
 
 **Structured Output Validation:**
@@ -117,7 +123,7 @@ You can enforce the output format (List, Dict, or specific types) using `return_
 ```python
 # Enforce a list of integers
 numbers = agent(
-    "Generate 3 random numbers", 
+    "Generate 3 random numbers, for example, [1, 2, 3].", 
     return_example=[1], 
     list_len=3
 )
@@ -125,7 +131,7 @@ numbers = agent(
 
 # Enforce a dictionary with specific keys
 profile = agent(
-    "Create a user profile for Alice", 
+    "Create a user profile for Alice, for example, {'name': Alice, 'age': 1, 'city': 'shanghai'}.", 
     return_example={"name": "str", "age": 1, "city": "str"}
 )
 # Output: {'name': 'Alice', 'age': 25, 'city': 'New York'}
@@ -141,7 +147,20 @@ description = agent(
 )
 ```
 
-### `sanitize_text(text)`
+**Memory Context:**
+
+```python
+history = [
+    {"role": "user", "content": "My name is Bob."},
+    {"role": "assistant", "content": "Hello Bob."}
+]
+answer = agent(
+    "What is my name?", 
+    history=history, 
+)
+```
+
+#### `sanitize_text(text)`
 
 Sanitizes text by keeping only ASCII English characters, digits, and common punctuation. Removes control characters and ANSI codes.
 
@@ -152,7 +171,7 @@ clean = sanitize_text("Hello \x1b[31mWorld\x1b[0m!")
 print(clean) # "Hello World!"
 ```
 
-### `str2dict(s)`
+#### `str2dict(s)`
 
 Robustly converts a string representation of a dictionary to a Python `dict`. It handles common formatting errors and uses `json_repair` as a fallback.
 
@@ -163,7 +182,7 @@ d = str2dict("{'a': 1, 'b': 2}")
 print(d['a']) # 1
 ```
 
-### `str2list(s)`
+#### `str2list(s)`
 
 Robustly converts a string representation of a list to a Python `list`.
 
@@ -174,7 +193,7 @@ l = str2list("[1, 2, 3]")
 print(len(l)) # 3
 ```
 
-### `add_no_proxy_if_private(url)`
+#### `add_no_proxy_if_private(url)`
 
 Checks if the hostname in the URL is a private IP address. If so, it adds it to the `no_proxy` environment variable to bypass proxies.
 
@@ -184,7 +203,7 @@ from structai import add_no_proxy_if_private
 add_no_proxy_if_private("http://192.168.1.100:8080/v1")
 ```
 
-### `read_image(image_path)`
+#### `read_image(image_path)`
 
 Reads an image from a path and returns a PIL Image object.
 
@@ -194,7 +213,7 @@ from structai import read_image
 img = read_image("photo.jpg")
 ```
 
-### `encode_image(image_obj)`
+#### `encode_image(image_obj)`
 
 Encodes a PIL Image object into a base64 string.
 
@@ -204,7 +223,7 @@ from structai import encode_image
 b64_str = encode_image(img)
 ```
 
-### `messages_to_responses_input(messages)`
+#### `messages_to_responses_input(messages)`
 
 Converts standard Chat Completions `messages` format (list of dicts) to the input format required by the Responses API.
 
@@ -215,7 +234,7 @@ messages = [{"role": "user", "content": "Hello"}]
 system_prompt, input_blocks = messages_to_responses_input(messages)
 ```
 
-### `extract_text_outputs(result)`
+#### `extract_text_outputs(result)`
 
 Extracts the text content from an LLM API response object (supports both Chat Completions and Responses API formats).
 
@@ -227,7 +246,7 @@ texts = extract_text_outputs(response)
 print(texts[0])
 ```
 
-### `multi_thread(inp_list, function, max_workers=40, use_tqdm=True)`
+#### `multi_thread(inp_list, function, max_workers=40, use_tqdm=True)`
 
 Executes a function concurrently for each item in `inp_list` using a thread pool.
 
@@ -243,7 +262,7 @@ results = multi_thread(inputs, square, max_workers=4)
 print(results) # [0, 1, 4, 9, ...]
 ```
 
-### `multi_process(inp_list, function, max_workers=40, use_tqdm=True)`
+#### `multi_process(inp_list, function, max_workers=40, use_tqdm=True)`
 
 Executes a function concurrently for each item in `inp_list` using a process pool. Ideal for CPU-bound tasks.
 
@@ -257,7 +276,7 @@ inputs = [{"n": 1000000} for _ in range(5)]
 results = multi_process(inputs, heavy_computation)
 ```
 
-### `run_server(host="0.0.0.0", port=8001)`
+#### `run_server(host="0.0.0.0", port=8001)`
 
 Starts a FastAPI server that acts as a proxy to an OpenAI-compatible LLM provider.
 
@@ -268,7 +287,7 @@ if __name__ == "__main__":
     run_server()
 ```
 
-### `timeout_limit(timeout=None)`
+#### `timeout_limit(timeout=None)`
 
 A decorator that enforces a maximum execution time on a function. Raises `TimeoutError` if the limit is exceeded.
 
@@ -284,7 +303,7 @@ def task():
 task()
 ```
 
-### `run_with_timeout(func, args=(), kwargs=None, timeout=None)`
+#### `run_with_timeout(func, args=(), kwargs=None, timeout=None)`
 
 Runs a function with a specified timeout without using a decorator.
 
@@ -297,7 +316,7 @@ def task(x):
 result = run_with_timeout(task, args=(10,), timeout=1.0)
 ```
 
-### `parse_think_answer(text)`
+#### `parse_think_answer(text)`
 
 Parses a string containing Chain-of-Thought tags (`<think>...</think>` and `<answer>...</answer>`) and returns the content of both.
 
@@ -310,7 +329,7 @@ print(f"Reasoning: {think}")
 print(f"Result: {answer}")
 ```
 
-### `extract_within_tags(content, start_tag='<answer>', end_tag='</answer>', default_return=None)`
+#### `extract_within_tags(content, start_tag='<answer>', end_tag='</answer>', default_return=None)`
 
 Extracts the substring found between two specific tags.
 
@@ -321,7 +340,7 @@ text = "Result: <json>{...}</json>"
 json_str = extract_within_tags(text, "<json>", "</json>")
 ```
 
-### `get_all_file_paths(directory, suffix='')`
+#### `get_all_file_paths(directory, suffix='')`
 
 Recursively retrieves all file paths in a directory that match a given suffix.
 
@@ -333,7 +352,7 @@ py_files = get_all_file_paths(".", suffix=".py")
 print(py_files)
 ```
 
-### `remove_tag(s, tags=["<think>", "</think>", "<answer>", "</answer>"], r="\n")`
+#### `remove_tag(s, tags=["<think>", "</think>", "<answer>", "</answer>"], r="\n")`
 
 Removes specified tags from a string, replacing them with a separator (default newline).
 
@@ -345,4 +364,4 @@ clean_text = remove_tag("<think>...</think> Answer")
 
 ## License
 
-MIT License
+[MIT License](LICENSE)

{structai-0.1.2 → structai-0.1.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "structai"
-version = "0.1.2"
+version = "0.1.4"
 authors = [
   { name="Wanghan Xu", email="xu_wanghan@sjtu.edu.cn" },
 ]

{structai-0.1.2 → structai-0.1.4/structai.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: structai
-Version: 0.1.2
+Version: 0.1.4
 Summary: A utility package for AI development
 Author-email: Wanghan Xu <xu_wanghan@sjtu.edu.cn>
 Project-URL: Homepage, https://github.com/black-yt/structai
@@ -41,9 +41,15 @@ cd structai
 pip install -e .
 ```
 
-## API Reference & Usage
+## Usage
 
-### `load_file(path)`
+> **Note:** Before using LLM-related features, please ensure you have set the necessary environment variables:
+> ```bash
+> export LLM_API_KEY="your-api-key"
+> export LLM_BASE_URL="your-api-base-url"
+> ```
+
+#### `load_file(path)`
 
 Automatically reads a file based on its extension.
 
@@ -62,7 +68,7 @@ df = load_file("data.csv")
 image = load_file("photo.jpg")
 ```
 
-### `save_file(data, path)`
+#### `save_file(data, path)`
 
 Automatically saves data to a file based on the extension.
 
@@ -78,7 +84,7 @@ save_file(data, "output.json")
 save_file(data, "backup.pkl")
 ```
 
-### `print_once(msg)`
+#### `print_once(msg)`
 
 Prints a message to stdout only the first time it is called. Useful for logging inside loops.
 
@@ -90,7 +96,7 @@ for i in range(10):
     # process(i)
 ```
 
-### `make_print_once()`
+#### `make_print_once()`
 
 Returns a new function that prints a message only once. This allows for creating local "print once" scopes.
 
@@ -106,7 +112,7 @@ logger1("Hello") # Does nothing
 logger2("World") # Prints "World"
 ```
 
-### `LLMAgent`
+#### `LLMAgent`
 
 A powerful wrapper class for interacting with OpenAI-compatible LLM APIs. It handles retries, timeouts, and structured output validation.
 
@@ -129,9 +135,9 @@ agent = LLMAgent(
 **Basic Usage (`__call__` or `safe_api`):**
 
 ```python
-response = agent("What is the capital of France?")
+response = agent("Generate a random number.", n=3, temperature=1)
 print(response)
-# Output: "Paris"
+# Output: ["Sure! Here's a random number for you: 738", "Sure! Here's a random number: 7382", "Sure! Here's a random number: 487."]
 ```
 
 **Structured Output Validation:**
@@ -141,7 +147,7 @@ You can enforce the output format (List, Dict, or specific types) using `return_
 ```python
 # Enforce a list of integers
 numbers = agent(
-    "Generate 3 random numbers", 
+    "Generate 3 random numbers, for example, [1, 2, 3].", 
     return_example=[1], 
     list_len=3
 )
@@ -149,7 +155,7 @@ numbers = agent(
 
 # Enforce a dictionary with specific keys
 profile = agent(
-    "Create a user profile for Alice", 
+    "Create a user profile for Alice, for example, {'name': Alice, 'age': 1, 'city': 'shanghai'}.", 
     return_example={"name": "str", "age": 1, "city": "str"}
 )
 # Output: {'name': 'Alice', 'age': 25, 'city': 'New York'}
@@ -165,7 +171,20 @@ description = agent(
 )
 ```
 
-### `sanitize_text(text)`
+**Memory Context:**
+
+```python
+history = [
+    {"role": "user", "content": "My name is Bob."},
+    {"role": "assistant", "content": "Hello Bob."}
+]
+answer = agent(
+    "What is my name?", 
+    history=history, 
+)
+```
+
+#### `sanitize_text(text)`
 
 Sanitizes text by keeping only ASCII English characters, digits, and common punctuation. Removes control characters and ANSI codes.
 
@@ -176,7 +195,7 @@ clean = sanitize_text("Hello \x1b[31mWorld\x1b[0m!")
 print(clean) # "Hello World!"
 ```
 
-### `str2dict(s)`
+#### `str2dict(s)`
 
 Robustly converts a string representation of a dictionary to a Python `dict`. It handles common formatting errors and uses `json_repair` as a fallback.
 
@@ -187,7 +206,7 @@ d = str2dict("{'a': 1, 'b': 2}")
 print(d['a']) # 1
 ```
 
-### `str2list(s)`
+#### `str2list(s)`
 
 Robustly converts a string representation of a list to a Python `list`.
 
@@ -198,7 +217,7 @@ l = str2list("[1, 2, 3]")
 print(len(l)) # 3
 ```
 
-### `add_no_proxy_if_private(url)`
+#### `add_no_proxy_if_private(url)`
 
 Checks if the hostname in the URL is a private IP address. If so, it adds it to the `no_proxy` environment variable to bypass proxies.
 
@@ -208,7 +227,7 @@ from structai import add_no_proxy_if_private
 add_no_proxy_if_private("http://192.168.1.100:8080/v1")
 ```
 
-### `read_image(image_path)`
+#### `read_image(image_path)`
 
 Reads an image from a path and returns a PIL Image object.
 
@@ -218,7 +237,7 @@ from structai import read_image
 img = read_image("photo.jpg")
 ```
 
-### `encode_image(image_obj)`
+#### `encode_image(image_obj)`
 
 Encodes a PIL Image object into a base64 string.
 
@@ -228,7 +247,7 @@ from structai import encode_image
 b64_str = encode_image(img)
 ```
 
-### `messages_to_responses_input(messages)`
+#### `messages_to_responses_input(messages)`
 
 Converts standard Chat Completions `messages` format (list of dicts) to the input format required by the Responses API.
 
@@ -239,7 +258,7 @@ messages = [{"role": "user", "content": "Hello"}]
 system_prompt, input_blocks = messages_to_responses_input(messages)
 ```
 
-### `extract_text_outputs(result)`
+#### `extract_text_outputs(result)`
 
 Extracts the text content from an LLM API response object (supports both Chat Completions and Responses API formats).
 
@@ -251,7 +270,7 @@ texts = extract_text_outputs(response)
 print(texts[0])
 ```
 
-### `multi_thread(inp_list, function, max_workers=40, use_tqdm=True)`
+#### `multi_thread(inp_list, function, max_workers=40, use_tqdm=True)`
 
 Executes a function concurrently for each item in `inp_list` using a thread pool.
 
@@ -267,7 +286,7 @@ results = multi_thread(inputs, square, max_workers=4)
 print(results) # [0, 1, 4, 9, ...]
 ```
 
-### `multi_process(inp_list, function, max_workers=40, use_tqdm=True)`
+#### `multi_process(inp_list, function, max_workers=40, use_tqdm=True)`
 
 Executes a function concurrently for each item in `inp_list` using a process pool. Ideal for CPU-bound tasks.
 
@@ -281,7 +300,7 @@ inputs = [{"n": 1000000} for _ in range(5)]
 results = multi_process(inputs, heavy_computation)
 ```
 
-### `run_server(host="0.0.0.0", port=8001)`
+#### `run_server(host="0.0.0.0", port=8001)`
 
 Starts a FastAPI server that acts as a proxy to an OpenAI-compatible LLM provider.
 
@@ -292,7 +311,7 @@ if __name__ == "__main__":
     run_server()
 ```
 
-### `timeout_limit(timeout=None)`
+#### `timeout_limit(timeout=None)`
 
 A decorator that enforces a maximum execution time on a function. Raises `TimeoutError` if the limit is exceeded.
 
@@ -308,7 +327,7 @@ def task():
 task()
 ```
 
-### `run_with_timeout(func, args=(), kwargs=None, timeout=None)`
+#### `run_with_timeout(func, args=(), kwargs=None, timeout=None)`
 
 Runs a function with a specified timeout without using a decorator.
 
@@ -321,7 +340,7 @@ def task(x):
 result = run_with_timeout(task, args=(10,), timeout=1.0)
 ```
 
-### `parse_think_answer(text)`
+#### `parse_think_answer(text)`
 
 Parses a string containing Chain-of-Thought tags (`<think>...</think>` and `<answer>...</answer>`) and returns the content of both.
 
@@ -334,7 +353,7 @@ print(f"Reasoning: {think}")
 print(f"Result: {answer}")
 ```
 
-### `extract_within_tags(content, start_tag='<answer>', end_tag='</answer>', default_return=None)`
+#### `extract_within_tags(content, start_tag='<answer>', end_tag='</answer>', default_return=None)`
 
 Extracts the substring found between two specific tags.
 
@@ -345,7 +364,7 @@ text = "Result: <json>{...}</json>"
 json_str = extract_within_tags(text, "<json>", "</json>")
 ```
 
-### `get_all_file_paths(directory, suffix='')`
+#### `get_all_file_paths(directory, suffix='')`
 
 Recursively retrieves all file paths in a directory that match a given suffix.
 
@@ -357,7 +376,7 @@ py_files = get_all_file_paths(".", suffix=".py")
 print(py_files)
 ```
 
-### `remove_tag(s, tags=["<think>", "</think>", "<answer>", "</answer>"], r="\n")`
+#### `remove_tag(s, tags=["<think>", "</think>", "<answer>", "</answer>"], r="\n")`
 
 Removes specified tags from a string, replacing them with a separator (default newline).
 
@@ -369,4 +388,4 @@ clean_text = remove_tag("<think>...</think> Answer")
 
 ## License
 
-MIT License
+[MIT License](LICENSE)