2024-08-17 11:01:59 -05:00
|
|
|
## Setting up the environment (Windows)
|
|
|
|
|
|
|
|
|
|
1. Run `python setup_venv.py` to create the virtual environment and install dependencies.
|
|
|
|
|
2. To activate the virtual environment, run `activate_venv` in the Windows Terminal.
|
2024-08-17 11:30:34 -05:00
|
|
|
3. To deactivate the virtual environment, simply type `deactivate`.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Running the code (Any)
|
|
|
|
|
1. Run telegram_inference_bot.py after entering the environment
|
2024-08-17 13:05:16 -05:00
|
|
|
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.
|
