Skip to content

Commit 77c816c

Browse files
authored
Update README.md
1 parent 7f08ab0 commit 77c816c

File tree

1 file changed

+21
-7
lines changed

1 file changed

+21
-7
lines changed

README.md

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -35,31 +35,44 @@ Note that in order to access our demo video and keypoint files, you will need to
3535

3636
### Install from the source
3737

38-
We have prepared 3 bash installation scripts. Make sure you edit the path of conda / forge to your in the installation scripts.
38+
#### Minimal installation
39+
**Recommended for:** Running AmadeusGPT without GPUs. This setup is lightweight and is limited to processing movie files and keypoint outputs (.h5) from DeepLabCut.
3940

4041
```bash
41-
# Recommended if you are running AmadeusGPT without gpus. The installation is light-weight and you can only use it with movie files and keypoint output (.h5) from DeepLabCut.
42+
# Install the minimal environment
4243
bash install_minimal.sh
4344

45+
# Activate the conda environment
4446
conda activate amadeusgpt-minimal
45-
```
47+
```
48+
49+
#### GPU installation
50+
**Recommended for:** Users on Linux with GPUs. Support for Windows and MacOS will be added in the future.
4651

4752
```bash
48-
# Recommended if you are running on linux with gpus (We will add Windows and MacsOS support in the future).
53+
# Install the gpu environment
4954
bash install_gpu.sh
5055

56+
# Activate the conda environment
5157
conda activate amadeusgpt-gpu
5258
```
5359

60+
#### CPU installation
61+
**Recommended for:** MacOS / Linux users working with very small video files.
62+
5463
```bash
55-
#For MacOS users, if you are only playing with very small video files.
64+
# Install the cpu environment
5665
bash install_cpu.sh
5766

67+
# Activate the conda environment
5868
conda activate amadeusgpt-cpu
5969
```
70+
71+
6072
### Setup OpenAI Key to use AmadeusGPT
6173

62-
- Please note that you need an [openAI API key](https://platform.openai.com/account/api-keys), which you can easily create [here](https://platform.openai.com/account/api-keys).
74+
75+
- Please note that you need an [openAI API key](https://platform.openai.com/account/api-keys), which you can easily create [here](https://platform.openai.com/account/api-keys).
6376
- If you want the **Streamlit Demo on your computer**, you will also need demo files that are supplied in our repo (see below**), so please git clone the repo and navigate into the `AmadeusGPT` directory. Then in your conda env/terminal run `pip install 'amadeusgpt[streamlit]'` as described above. Then, to launch the Demo App execute in the terminal:
6477

6578
### Try AmadeusGPT with local web app
@@ -70,11 +83,12 @@ make app
7083
### Try AmadeusGPT with our example notebooks
7184
We provide example notebooks at [Notebooks](notebook)
7285

86+
7387
## Citation
7488

7589
If you use ideas or code from this project in your work, please cite us using the following BibTeX entry. 🙏
7690

77-
```
91+
```
7892
@article{ye2023amadeusGPT,
7993
title={AmadeusGPT: a natural language interface for interactive animal behavioral analysis},
8094
author={Shaokai Ye and Jessy Lauer and Mu Zhou and Alexander Mathis and Mackenzie Weygandt Mathis},

0 commit comments

Comments
 (0)