alexgoodell commited on
Commit
f13aea8
1 Parent(s): 8c922f2

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +34 -1
README.md CHANGED
@@ -7,4 +7,37 @@ sdk: static
7
  pinned: false
8
  ---
9
 
10
- Edit this `README.md` markdown file to author your organization card.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
7
  pinned: false
8
  ---
9
 
10
+ ## Synthetic Patients
11
+
12
+ ![revised_group](https://github.com/synthetic-patients/.github/assets/2191507/11dc7f6a-5c68-4894-aa2c-fe30c91728a5)
13
+
14
+ [Preprint](https://google.com)
15
+ [Demo video]
16
+
17
+ ### Real-time chat application
18
+
19
+ To experiment with the realtime video chat application, you will need to run it locally. We have provided a [docker container](https://hub.docker.com/r/syntheticpatients/base) with the requirements. You will need: API keys for OpenAI and ElevenLabs to run this program; you will be prompted to provide them. You will need an account to both of these services to get the keys and will be charged for usage. These keys will only be stored within your instance of docker and will not be shared.
20
+
21
+ To begin, make sure that you have Docker installed. Then, from your command-line, run:
22
+
23
+ ```
24
+ docker pull syntheticpatients/base
25
+ ```
26
+
27
+ This will take a significant amount of time to download, as it currently is around 8GB. Once this has been completed, you can run the script by executing the following in your terminal:
28
+
29
+ ```
30
+ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/synthetic-patients/install/main/run.sh)"
31
+ ```
32
+
33
+ This will launch the synthetic patient server using your OpenAI and ElevenLabs API. Once the server has completed launching, direct your browser to http://localhost:5000/client to begin interacting.
34
+
35
+ ### Notes
36
+
37
+ - Because of docker's audio limitations, voice-recognition has been disabled. You will need to input text through a text field.
38
+ - Depending on the computer running the server, response times may be quite slow.
39
+
40
+ ### Video demonstration
41
+
42
+ https://github.com/alexgoodell/synthetic-patients/assets/2191507/27cac321-b9de-4e79-a80d-fd93a50574c5
43
+