|
| 1 | +<div align="center"> |
| 2 | + |
1 | 3 | <p align="center"> |
2 | 4 | <img src="https://images.squarespace-cdn.com/content/v1/57f6d51c9f74566f55ecf271/8555eac6-6af0-4538-bda4-c1a8a2c7bed8/amadeusgpt_logo.png?format=1500w" width="95%"> |
3 | 5 | </p> |
4 | 6 |
|
5 | | -🪄 **We turn natural language descriptions of behaviors into machine-executable code.** |
| 7 | +[](https://pepy.tech/project/amadeusgpt) |
| 8 | +[](https://pepy.tech/project/amadeusgpt) |
| 9 | +[](https://badge.fury.io/py/amadeusgpt) |
| 10 | +[](https://github.com/AdaptiveMotorControlLab/AmadeusGPT) |
| 11 | + |
| 12 | +## 🪄 We turn natural language descriptions of behaviors into machine-executable code. |
| 13 | + |
| 14 | +[🛠️ Installation](https://github.com/AdaptiveMotorControlLab/AmadeusGPT?tab=readme-ov-file#install--run-amadeusgpt) | |
| 15 | +[🌎 Home Page](http://www.mackenziemathislab.org/amadeusgpt) | |
| 16 | +[🚨 News](https://github.com/AdaptiveMotorControlLab/AmadeusGPT?tab=readme-ov-file#news) | |
| 17 | +[🪲 Reporting Issues](https://github.com/AdaptiveMotorControlLab/AmadeusGPT/issues) | |
| 18 | +[💬 Discussions!](https://github.com/AdaptiveMotorControlLab/AmadeusGPT/discussions) |
| 19 | + |
| 20 | +</div> |
6 | 21 |
|
7 | 22 | - We use large language models (LLMs) to bridge natural language and behavior analysis. |
8 | | -- This work is accepted to **NeuRIPS2023!** Read the paper, [AmadeusGPT: a natural language interface for interactive animal behavioral analysis](https://www.google.com/search?q=amadeusgpt+openreview&sca_esv=590699485&rlz=1C5CHFA_enCH1059CH1060&ei=K1N6ZaHdKvmrur8PosOOkAo&ved=0ahUKEwjhnta83I2DAxX5le4BHaKhA6IQ4dUDCBE&uact=5&oq=amadeusgpt+openreview&gs_lp=Egxnd3Mtd2l6LXNlcnAiFWFtYWRldXNncHQgb3BlbnJldmlldzIHECEYoAEYCjIHECEYoAEYCki2HVDfAliOHHACeACQAQGYAYMDoAHaGaoBCDEuMTEuMS40uAEDyAEA-AEBwgIFECEYqwLCAggQABiABBiiBMICCBAAGIkFGKIE4gMEGAEgQYgGAQ&sclient=gws-wiz-serp#:~:text=AmadeusGPT%3A%20a%20natural,net%20%E2%80%BA%20pdf) |
| 23 | +- This work is published at **NeuRIPS2023!** Read the paper, [AmadeusGPT: a natural language interface for interactive animal behavioral analysis](https://www.google.com/search?q=amadeusgpt+openreview&sca_esv=590699485&rlz=1C5CHFA_enCH1059CH1060&ei=K1N6ZaHdKvmrur8PosOOkAo&ved=0ahUKEwjhnta83I2DAxX5le4BHaKhA6IQ4dUDCBE&uact=5&oq=amadeusgpt+openreview&gs_lp=Egxnd3Mtd2l6LXNlcnAiFWFtYWRldXNncHQgb3BlbnJldmlldzIHECEYoAEYCjIHECEYoAEYCki2HVDfAliOHHACeACQAQGYAYMDoAHaGaoBCDEuMTEuMS40uAEDyAEA-AEBwgIFECEYqwLCAggQABiABBiiBMICCBAAGIkFGKIE4gMEGAEgQYgGAQ&sclient=gws-wiz-serp#:~:text=AmadeusGPT%3A%20a%20natural,net%20%E2%80%BA%20pdf) by by [Shaokai Ye](https://github.com/yeshaokai), [Jessy Lauer](https://github.com/jeylau), [Mu Zhou](https://github.com/zhoumu53), [Alexander Mathis](https://github.com/AlexEMG) & [Mackenzie W. Mathis](https://github.com/MMathisLab). |
9 | 24 | - Like this project? Please consider giving us a star ⭐️! |
10 | 25 |
|
11 | 26 | ## Install & Run AmadeusGPT🎻 |
|
15 | 30 | pip install 'amadeusgpt[streamlit]' |
16 | 31 | ``` |
17 | 32 | - 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). |
18 | | -- 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 '.[streamlit]'`. Then, to launch the Demo App execute in the terminal: |
| 33 | +- 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: |
19 | 34 | ```python |
20 | 35 | make app |
21 | 36 | ``` |
| 37 | +- You can use AmadeusGPT directly in python: iPython, Jupyter Notebooks, Google Colab, etc. For a quick start, see our `\examples` directory that hosts demo data and a Jupyter Notebook! Enjoy! |
22 | 38 |
|
23 | 39 | ## Citation |
24 | 40 |
|
@@ -47,7 +63,7 @@ make app |
47 | 63 | ## License |
48 | 64 |
|
49 | 65 | AmadeusGPT is license under the Apache-2.0 license. |
50 | | - - 🚨 Please note several key dependencies have their own licensing. Please carefully check the license information for [DeepLabCut](https://github.com/DeepLabCut/DeepLabCut) (LGPL-3.0 license), [SAM](https://github.com/facebookresearch/segment-anything) (Apache-2.0 license), [CEBRA](https://github.com/AdaptiveMotorControlLab/CEBRA) (Non-Commercial), etc... |
| 66 | + - 🚨 Please note several key dependencies have their own licensing. Please carefully check the license information for [DeepLabCut](https://github.com/DeepLabCut/DeepLabCut) (LGPL-3.0 license), [SAM](https://github.com/facebookresearch/segment-anything) (Apache-2.0 license), [CEBRA](https://github.com/AdaptiveMotorControlLab/CEBRA) (Non-Commercial), etc. |
51 | 67 |
|
52 | 68 |
|
53 | 69 | ## News |
|
0 commit comments