Skip to content

Commit 81a1998

Browse files
authored
Update README.md
1 parent 92919e5 commit 81a1998

1 file changed

Lines changed: 24 additions & 4 deletions

File tree

README.md

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,37 @@
11
# code-it
22

3-
This is a highly experimental project. Code-it leverages LLMs to generate code - unlike other solutions, it doesn't try to rely on the smartness of LLMs, but rather assume they are rather dumb and perform several mistakes along the way. It applies a simple algorithm to iteratively code towards it's task objective, in a similar way a programmer might do. This algorithm is implemented with control statements and different prompts to steer the LLM at performing the correct action.
3+
Code-it is simultaneously:
4+
5+
1. A standalone package to generate code and execute with LLMs
6+
2. An importable tool into langchain
7+
8+
9+
This is a highly experimental project, the quality of the generations may not be high enough for production usage.
10+
11+
Code-it leverages LLMs to generate code - unlike other solutions, it doesn't try to rely on the smartness of LLMs, but rather assume they are rather dumb and perform several mistakes along the way. It applies a simple algorithm to iteratively code towards it's task objective, in a similar way a programmer might do. This algorithm is implemented with control statements and different prompts to steer the LLM at performing the correct action.
412

513
It is **not** an autonomous agent - at most, we could call it semi-autonomous.
614

715

16+
## Overview Idea
17+
![Overview Diagram](/overview_diagram.jpg?raw=true "Optional Title")
18+
19+
820
## Installation
921

1022
1. Setup https://github.com/oobabooga/text-generation-webui with API enabled
11-
2. `pip install -r requirements.txt`
23+
2. Install it through pip / git on your project. For, you can define this line in your project requirements.txt:
24+
```text
25+
code_it @ git+https://github.com/paolorechia/code-it
26+
```
27+
Note that I did not yet have tags or a PyPi package, as I'm not sure how useful this package will be in the future.
28+
29+
3. Locally with your Python shell / virtualenv:
30+
`pip install -r requirements.txt`
31+
32+
33+
## Running it as a standalone package
1234

13-
## Running it
1435

1536
WARNING: the LLM will run arbitrary code, use it at your own risk.
1637
Execute the main:
@@ -20,4 +41,3 @@ This will save the code in `persistent_source.py`
2041

2142
Change the task in the `task.txt` file to perform another task.
2243

23-

0 commit comments

Comments
 (0)