Skip to content

Commit

Permalink
[doc] updated readme file and improved readability (lm-sys#117)
Browse files Browse the repository at this point in the history
Co-authored-by: Siyuan (Ryans) Zhuang <[email protected]>
  • Loading branch information
devvsakib and suquark authored Apr 1, 2023
1 parent 223929c commit 98e672b
Showing 1 changed file with 23 additions and 10 deletions.
33 changes: 23 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,20 @@ Join our [Discord](https://discord.gg/h6kCZb72G7) server and follow our [Twitter

## Install

```
1. Clone this repository and navigate to FastChat folder
```bash
git clone https://github.com/lm-sys/FastChat.git
cd FastChat
pip3 install --upgrade pip
```

2. Install Package
```bash
pip3 install --upgrade pip # enable PEP 660 support
pip3 install -e .
```

# Install the latest main branch of huggingface/transformers
3. Install the latest main branch of huggingface/transformers
```bash
pip3 install git+https://github.com/huggingface/transformers
```

Expand All @@ -41,21 +48,27 @@ python3 -m fastchat.serve.cli --model-name facebook/opt-1.3b
```

### Web UI
```
# Launch a controller

#### Launch a controller
```bash
python3 -m fastchat.serve.controller
```

# Launch a model worker
#### Launch a model worker
```bash
python3 -m fastchat.serve.model_worker --model-path facebook/opt-1.3b
```

# Send a test message
#### Send a test message
```bash
python3 -m fastchat.serve.test_message
```

# Launch a gradio web server.
#### Launch a gradio web server.
```bash
python3 -m fastchat.serve.gradio_web_server
# You can open your brower and chat with a model now.
```
#### You can open your brower and chat with a model now.

## Evaluation

Expand Down

0 comments on commit 98e672b

Please sign in to comment.