Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add contents of run.md to README #33

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,30 @@ We provide our implementation and pretrained models as open source in this repos

## Get Started

Please refer to [run.md](run.md)
### Create a new environment
```
conda create -n audiogpt python=3.8
```

### Prepare the basic environments
```
pip install -r requirements.txt
```

### Download the foundation models you need
```
bash download.sh
```

### Prepare your private OpenAI private key
```
export OPENAI_API_KEY={Your_Private_Openai_Key}
```

### Start AudioGPT !
```
python audio-chatgpt.py
```


## Capabilities
Expand Down