Dark-Alex-17/llm-functions
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: update readme

Browse Source
This commit is contained in:
sigoden
2024-07-03 23:52:11 +00:00
parent ca462b69e5
commit 6d48c0a031
1 changed files with 10 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+10 -13
View File
@@ -1,6 +1,11 @@
# LLM Functions # LLM Functions
This project allows you to enhance large language models (LLMs) with custom functions written in bash/js/python. Imagine your LLM being able to execute system commands, access web APIs, or perform other complex tasks – all triggered by simple, natural language prompts. This project allows you to enhance large language models (LLMs) with custom tools and agents developed in bash/javascript/python. Imagine your LLM being able to execute system commands, access web APIs, or perform other complex tasks – all triggered by simple, natural language prompts.
![tool-showcase](https://github.com/sigoden/llm-functions/assets/4012553/41c297cb-b3f7-4e5f-925e-a80d07684b1d)
![agent-showcase](https://github.com/sigoden/aichat/assets/4012553/7308a423-2ee5-4847-be1b-a53538bc98dc)
## Prerequisites ## Prerequisites
@@ -23,14 +28,16 @@ git clone https://github.com/sigoden/llm-functions
``` ```
get_current_weather.sh get_current_weather.sh
may_execute_py_code.py execute_command.sh
#execute_py_code.py
``` ```
- Create a `./agents.txt` file with each agent name on a new line. - Create a `./agents.txt` file with each agent name on a new line.
``` ```
todo-sh todo-sh
hackernews #todo-js
#todo-py
``` ```
- Run `argc build` to build functions declarations files (`functions.json`) and binaries (`./bin`) for tools and agents. - Run `argc build` to build functions declarations files (`functions.json`) and binaries (`./bin`) for tools and agents.
@@ -51,16 +58,6 @@ AIChat will automatically load `functions.json` and execute commands located in
Now you can interact with your LLM using natural language prompts that trigger your defined functions. Now you can interact with your LLM using natural language prompts that trigger your defined functions.
## Showcases
### Tool
![aichat-tool-use](https://github.com/sigoden/llm-functions/assets/4012553/41c297cb-b3f7-4e5f-925e-a80d07684b1d)
### Agent
![aichat-agent](https://github.com/sigoden/aichat/assets/4012553/7308a423-2ee5-4847-be1b-a53538bc98dc)
## Writing Your Own Tools ## Writing Your Own Tools
Writing tools is super easy, you only need to write functions with comments. Writing tools is super easy, you only need to write functions with comments.