From 7242023eaa97a3a11972c0e078b8118b7a893d10 Mon Sep 17 00:00:00 2001
From: adldotori <adldotori@gmail.com>
Date: Tue, 21 Mar 2023 04:41:10 +0000
Subject: [PATCH] docs: update README.md

---
 README.md        | 43 +++++++++++++++++++++++++++++++++++++------
 prompts/input.py |  9 +++++++--
 tools/cpu.py     |  1 +
 3 files changed, 45 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index e808c0e..0c99ffd 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,46 @@
 # EVAL
 
-Everything you can do with a computer through EVAL is executable like the eval method. It can understand and generate data formats for text, image, dataframe, audio (TODO), video (TODO). It must be run inside a container that is only available to it, and it can build your container environment directly through Terminal Tools.
+> **EVAL(Elastic Versatile Agent with Langchain) will execute all your requests. Like the eval method!**
+
+You don't have to think about how. If you tell them the results you want, they'll search, code, run, and test the Internet themselves, and they'll return the final results.
+
+### EVAL's FEATURE
+
+1. It can **understand** and **generate** data formats for text, image, dataframe, audio (TODO), video (TODO).
+2. It can **create tools** that it can use by writing and modifying code.
+3. It can **evolve** itself by executing and testing its code.
+
+### BUILT-IN TOOLS
+
+1. Search
+   - Google, Bing, Wikipedia
+   - Custom DB Search (Currently using Corca's Wine Data in https://www.workershop.kr/en)
+     - Use GPT index to quickly find the information you need in a document and use that information to answer
+   - Requests.get (Get information from anywhere you want)
+2. Terminal
+3. Python REPL
+4. Image Understanding, Generation, Editing
+   - Image Understanding
+     - Image Understanding: blip-image-captioning
+     - Visual Question&Answering: blip-vqa
+   - Image Generation: Stable Diffusion 1.5
+   - Image Editing
+     - Replace or remove an object: Stable Diffusion Inpainting
+     - Change Image's style: InstructPix2Pix
+
+Thanks to [LangChain](https://github.com/hwchase17/langchain), [Visual ChatGPT](https://github.com/microsoft/visual-chatgpt), [llama index](https://github.com/jerryjliu/llama_index).
+
+### CUSTOM TOOLS
+
+We also don't know what tools EVAL will create. Every day, It will create the right tools to execute your request.
+
+---
 
 ## Usage
 
 1. S3 Settings
 2. environments settings
-3. Execute `docker-compose up -d`
+3. `docker-compose up -d`
 
 ### S3
 
@@ -51,14 +85,11 @@ SERPAPI_API_KEY: need to append google search tool
 BING_SEARCH_URL, BING_SUBSCRIPTION_KEY: need to append bing search tool
 ```
 
-## Tools
-
 ## TODO
 
 - [ ] memory saving
 - [ ] session manage
 - [ ] convert to alpaca
-- [ ] requests.get refactoring
 - [ ] prompt upgrade
 - [ ] give a tool to create tools
 - [ ] etc.
@@ -67,6 +98,6 @@ BING_SEARCH_URL, BING_SUBSCRIPTION_KEY: need to append bing search tool
 
 Thanks to the following repositories.
 
-- https://github.com/jerryjliu/llama_index
 - https://github.com/hwchase17/langchain
 - https://github.com/microsoft/visual-chatgpt
+- https://github.com/jerryjliu/llama_index
diff --git a/prompts/input.py b/prompts/input.py
index 3f421d8..3588b30 100644
--- a/prompts/input.py
+++ b/prompts/input.py
@@ -1,3 +1,5 @@
+from env import settings
+
 EVAL_PREFIX = """{bot_name} is designed to be able to assist with a wide range of text, visual related tasks, data analysis related tasks, auditory related tasks, from answering simple questions to providing in-depth explanations and discussions on a wide range of topics. 
 {bot_name} is able to generate human-like text based on the input it receives, allowing it to engage in natural-sounding conversations and provide responses that are coherent and relevant to the topic at hand.
 {bot_name} is able to process and understand large amounts of various types of files(image, audio, video, dataframe, etc.). As a language model, {bot_name} can not directly read various types of files(text, image, audio, video, dataframe, etc.), but it has a list of tools to finish different visual tasks. 
@@ -31,12 +33,15 @@ Markdown code snippet formatted in the following schema:
 ```
 
 **Option #2:**
-Use this if you want to respond directly to the human. Markdown code snippet formatted in the following schema:
+Use this if you want to respond directly to the human.
+You should replace sensitive data or encrypted data with "d1dy0uth1nk7hat1t1s7haAAat3aSy?" in action_input.
+
+Markdown code snippet formatted in the following schema:
 
 ```json
 {{{{
     "action": "Final Answer",
-    "action_input": string \\ You should put what you want to return to use here
+    "action_input": string \\ You should put what you want to return to use here.
 }}}}
 ```"""
 
diff --git a/tools/cpu.py b/tools/cpu.py
index a27038e..f8236df 100644
--- a/tools/cpu.py
+++ b/tools/cpu.py
@@ -20,6 +20,7 @@ class Terminal(BaseToolSet):
     @tool(
         name="Terminal",
         description="Executes commands in a terminal."
+        "You can install packages with pip, apt, etc."
         "Input should be valid commands, "
         "and the output will be any output from running that command.",
     )