Spaces:
Running
Running
Kunal Pai commited on
Commit ·
ce79b6a
1
Parent(s): 8cb108e
Update README.md to enhance usage instructions and add model support details
Browse files
README.md
CHANGED
|
@@ -43,14 +43,25 @@ This project provides a framework for creating and managing AI agents and tools.
|
|
| 43 |
|
| 44 |
## Usage
|
| 45 |
|
| 46 |
-
To use the project,
|
|
|
|
|
|
|
| 47 |
|
| 48 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
| 49 |
2. Create tools and place them in the `src/tools/default_tools` or `src/tools/user_tools` directories.
|
| 50 |
|
| 51 |
Please note that by default, we do provide a lot of pre-defined tools and agents, so you may not need to create your own tools unless you have specific requirements.
|
| 52 |
|
| 53 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 54 |
|
| 55 |
## Contributing
|
| 56 |
|
|
|
|
| 43 |
|
| 44 |
## Usage
|
| 45 |
|
| 46 |
+
To use the project, follow these steps:
|
| 47 |
+
1. Install the required dependencies by running `pip install -r requirements.txt`.
|
| 48 |
+
2. Start the application by running `python app.py`. This will launch a web interface where you can interact with the agents and tools.
|
| 49 |
|
| 50 |
+
By default, on running `python app.py`, you would need to authenticate with Auth0. But, this can be overriden through the CLI argument `--no-auth` to skip authentication.
|
| 51 |
+
|
| 52 |
+
To use the project with additional tools and agents, you need to:
|
| 53 |
+
|
| 54 |
+
1. Configure the budget in `src/tools/default_tools/agent_cost_manager.py`.
|
| 55 |
2. Create tools and place them in the `src/tools/default_tools` or `src/tools/user_tools` directories.
|
| 56 |
|
| 57 |
Please note that by default, we do provide a lot of pre-defined tools and agents, so you may not need to create your own tools unless you have specific requirements.
|
| 58 |
|
| 59 |
+
## Model Support
|
| 60 |
+
The project supports the following language model integrations:
|
| 61 |
+
- **Ollama**: Local model management and invocation.
|
| 62 |
+
- **Gemini**: Cloud-based model management and invocation from Google.
|
| 63 |
+
- **Groq**: Cloud-based model management and invocation from Groq.
|
| 64 |
+
- **Lambda**: Cloud-based model management and invocation from Lambda Labs.
|
| 65 |
|
| 66 |
## Contributing
|
| 67 |
|