From e6f4cafab64d26389fb1642c5f6b7f9856e0a437 Mon Sep 17 00:00:00 2001 From: bucolucas Date: Sat, 17 Aug 2024 13:05:16 -0500 Subject: [PATCH] docs: Update readme.md with tools overview --- readme.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/readme.md b/readme.md index 1b258dc..e4d0e98 100644 --- a/readme.md +++ b/readme.md @@ -7,4 +7,13 @@ ## Running the code (Any) 1. Run telegram_inference_bot.py after entering the environment -2. now we're cooking with gas! \ No newline at end of file +2. now we're cooking with gas! + +## Tools Overview + +The `tools` directory contains essential utilities that extend the capabilities of the main application. Below are key Python files and their roles: +1. **tools/base_tool.py**: + - **Purpose**: Serves as an abstract base class for other tools. + - **Core Methods**: + `get_functions()`: Abstract method to list available functions. + `execute(function_name, **kwargs)`: Abstract method to execute a specified function with given arguments. \ No newline at end of file