alexgoodell commited on
Commit
04d69f0
1 Parent(s): d855f75

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +12 -13
README.md CHANGED
@@ -15,34 +15,29 @@ pinned: true
15
 
16
  Welcome to our repository. Here, we have a collection of files and links to share our work on generating a new type of virtual patient with artificial intelligence.
17
 
18
- ## Data
19
 
20
  - Patient profiles are available in the ```patient_profiles``` folder in this repository.
21
  - The underlying codebase for our application (excluding external packages) is available in the ```code``` folder of this repository.
22
  - To experiment with the platform and experience the realtime video chat applicaiton, we suggest using the containerized Docker version of the application.
23
 
24
- ## Links
25
 
26
- - Our preprint (link pending)
27
- - A low-resolution demo video is below.
28
  - [Video demonstration](alxgd.s3.amazonaws.com/demo.mp4) showcasing a prototype of our platform.
29
  - [Presentation](https://alx.gd/ase_presentation) from the 2024 Association of Surgical Education.
30
 
31
  # Installation
32
 
33
- To experiment with the realtime video chat application, you will need to run it locally.
34
- We have provided a [docker container](https://hub.docker.com/r/syntheticpatients/base) with the requirements.
35
- You will need API keys for both OpenAI and ElevenLabs to run this program. The program will prompt you to provide them at runtime.
36
- You will need an account to both of these services to get the keys, and you will be charged for usage.
37
- These keys will only be stored within your instance of docker and will not be shared.
38
-
39
- To begin, make sure that you have Docker installed. Then, from your command-line, run:
40
 
41
  ```
42
  docker pull syntheticpatients/base
43
  ```
44
 
45
- 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:
46
 
47
  ```
48
  /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/synthetic-patients/install/main/run.sh)"
@@ -50,8 +45,12 @@ This will take a significant amount of time to download, as it currently is arou
50
 
51
  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.
52
 
53
- ## Notes
54
 
55
  - Because of docker's audio limitations, voice-recognition has been disabled. You will need to input text through a text field.
56
  - Depending on the computer running the server, response times may be quite slow (20-30 seconds on our consumer-grade machines).
57
 
 
 
 
 
 
15
 
16
  Welcome to our repository. Here, we have a collection of files and links to share our work on generating a new type of virtual patient with artificial intelligence.
17
 
18
+ ### Data
19
 
20
  - Patient profiles are available in the ```patient_profiles``` folder in this repository.
21
  - The underlying codebase for our application (excluding external packages) is available in the ```code``` folder of this repository.
22
  - To experiment with the platform and experience the realtime video chat applicaiton, we suggest using the containerized Docker version of the application.
23
 
24
+ ### Links
25
 
 
 
26
  - [Video demonstration](alxgd.s3.amazonaws.com/demo.mp4) showcasing a prototype of our platform.
27
  - [Presentation](https://alx.gd/ase_presentation) from the 2024 Association of Surgical Education.
28
 
29
  # Installation
30
 
31
+ 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.
32
+ You will need API keys for both OpenAI and ElevenLabs to run this program. The program will prompt you to provide them at runtime. You will need an account to both of these services to get the keys, and you will be charged for usage.
33
+ These keys will only be stored within your instance of docker and will not be shared. To begin, make sure that you have Docker installed. For MacOS and Windows computers, we suggest [Docker Desktop](https://www.docker.com/products/docker-desktop/).
34
+ Then, from your command-line (terminal), run:
 
 
 
35
 
36
  ```
37
  docker pull syntheticpatients/base
38
  ```
39
 
40
+ This will take a significant amount of time to download, as it currently is around 5GB. Once this has been completed, you can run the script by executing the following in your terminal:
41
 
42
  ```
43
  /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/synthetic-patients/install/main/run.sh)"
 
45
 
46
  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.
47
 
48
+ ### Notes
49
 
50
  - Because of docker's audio limitations, voice-recognition has been disabled. You will need to input text through a text field.
51
  - Depending on the computer running the server, response times may be quite slow (20-30 seconds on our consumer-grade machines).
52
 
53
+ ### Contact us
54
+
55
+ - Reach us at [[email protected]](mailto:[email protected]).
56
+ - We are looking for collaborators, investors, and implementation partners!