updated readme

Author: yeshaokai

README.md

@@ -79,7 +79,32 @@ You can git clone (or download) this repo to grab a copy and go. We provide exam
 5) [Reuse the task program generated by LLM and run it on different videos](notebook/MABe_demo.ipynb)
 7) You can ask one query across multiple videos. Put your keypoint files and video files (pairs) in the same folder and specify the `data_folder` as shown in this [Demo](notebook/custom_mouse_video.ipynb). Make sure your video file and keypoint file follows the normal DeepLabCut convention, i.e., `prefix.mp4` `prefix*.h5`.
 
+### Minimal example
 
+```python
+import os
+from amadeusgpt import create_project
+from amadeusgpt import AMADEUS
+from amadeusgpt.utils import parse_result
+
+if 'OPENAI_API_KEY' not in os.environ:  
+     os.environ['OPENAI_API_KEY'] = 'your key'
+
+# data folder contains video file and optionally keypoint files
+data_folder = "temp_data_folder"
+# where the results are saved 
+result_folder = "temp_result_folder"
+# Create a project
+config = create_project(data_folder, result_folder, video_suffix = ".mp4")
+
+# Create an AMADEUS instance
+amadeus = AMADEUS(config)
+
+query = "Plot the trajectory of the animal using the animal center and color it by time"
+qa_message = amadeus.step(query)
+# we made it easier to parse the result
+parse_result(amadeus, qa_message)
+```
 
 ### Try AmadeusGPT with a local WebApp
 - You will need to git clone this repo and have a copy locally. Then in your env run `pip install 'amadeusGPT[streamlit]'`

tests/test_project_creation.py

@@ -1,9 +1,11 @@
 import os
+from amadeusgpt import create_project
+from amadeusgpt import AMADEUS
+from amadeusgpt.utils import parse_result
+
 if 'OPENAI_API_KEY' not in os.environ:  
      os.environ['OPENAI_API_KEY'] = 'your key'
 
-from amadeusgpt import create_project
-from amadeusgpt import AMADEUS
 # Create a project
 
 data_folder = "temp_data_folder"
@@ -12,4 +14,8 @@
 config = create_project(data_folder, result_folder)
 
 # Create an AMADEUS instance
-amadeus = AMADEUS(config)
+amadeus = AMADEUS(config)
+
+# query = "Plot the trajectory of the animal using the animal center and color it by time"
+# qa_message = amadeus.step(query)
+# parse_result(amadeus, qa_message)