Skip to content

Commit e4f9b5e

Browse files
committed
add ui readme
1 parent 4c4700b commit e4f9b5e

File tree

5 files changed

+33
-4
lines changed

5 files changed

+33
-4
lines changed

.asset/ui_screenshot_1.png

92.8 KB
Loading

.asset/ui_screenshot_2.png

71.7 KB
Loading

.secrets.baseline

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
},
4242
{
4343
"name": "KeywordDetector",
44-
"keyword_exclude": ""
44+
"keyword_exclude": "key"
4545
},
4646
{
4747
"name": "MailchimpDetector"

playground/UI/README.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# How to Run UI
2+
3+
1. Follow the instruction in the repo's [README](../../README.md) to clone the repo and make configurations
4+
5+
```bash
6+
git clone https://github.com/microsoft/TaskWeaver.git
7+
cd TaskWeaver
8+
# install the requirements
9+
pip install -r requirements.txt
10+
```
11+
12+
```json
13+
{
14+
"llm.api_key": "the api key",
15+
"llm.model": "the model name, e.g., gpt-4"
16+
}
17+
```
18+
19+
2. Install the `chainlit` package by `pip install chainlit` if you don't have it in your env.
20+
21+
3. Start the service by running the following command.
22+
23+
```bash
24+
cd playground/UI/
25+
chainlit run app.py
26+
```
27+
28+
4. Open the browser with http://localhost:8000 and you can start the trial.
29+
30+
5. Below are some screenshots:
31+
![TaskWeaver UI Screenshot 1](../../.asset/ui_screenshot_1.png)
32+
![TaskWeaver UI Screenshot 2](../../.asset/ui_screenshot_2.png)

playground/UI/chainlit.md

-3
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,4 @@ TaskWeaver is a code-first agent framework for seamlessly planning and executing
1212

1313
We can't wait to see what you create with TaskWeaver!
1414

15-
## How to Run
16-
```chainlit run app.py```
17-
1815
**Start the Conversation!**

0 commit comments

Comments
 (0)