You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+21-7Lines changed: 21 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,31 +35,44 @@ Note that in order to access our demo video and keypoint files, you will need to
35
35
36
36
### Install from the source
37
37
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.
39
40
40
41
```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
42
43
bash install_minimal.sh
43
44
45
+
# Activate the conda environment
44
46
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.
46
51
47
52
```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
49
54
bash install_gpu.sh
50
55
56
+
# Activate the conda environment
51
57
conda activate amadeusgpt-gpu
52
58
```
53
59
60
+
#### CPU installation
61
+
**Recommended for:** MacOS / Linux users working with very small video files.
62
+
54
63
```bash
55
-
#For MacOS users, if you are only playing with very small video files.
64
+
# Install the cpu environment
56
65
bash install_cpu.sh
57
66
67
+
# Activate the conda environment
58
68
conda activate amadeusgpt-cpu
59
69
```
70
+
71
+
60
72
### Setup OpenAI Key to use AmadeusGPT
61
73
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).
63
76
- 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:
64
77
65
78
### Try AmadeusGPT with local web app
@@ -70,11 +83,12 @@ make app
70
83
### Try AmadeusGPT with our example notebooks
71
84
We provide example notebooks at [Notebooks](notebook)
72
85
86
+
73
87
## Citation
74
88
75
89
If you use ideas or code from this project in your work, please cite us using the following BibTeX entry. 🙏
76
90
77
-
```
91
+
```
78
92
@article{ye2023amadeusGPT,
79
93
title={AmadeusGPT: a natural language interface for interactive animal behavioral analysis},
80
94
author={Shaokai Ye and Jessy Lauer and Mu Zhou and Alexander Mathis and Mackenzie Weygandt Mathis},
0 commit comments