Yew Chong commited on
Commit
07e97dd
1 Parent(s): fe60fa2

basic README

Browse files
Files changed (3) hide show
  1. .gitignore +1 -1
  2. README.md +23 -0
  3. env.example +3 -0
.gitignore CHANGED
@@ -4,7 +4,7 @@ healthhack-store-firebase-adminsdk-sq7ne-32400d49de.json
4
  /venv
5
 
6
  # notebooks
7
- *.ipynb
8
  /.ipynb_checkpoints
9
 
10
  # docs
 
4
  /venv
5
 
6
  # notebooks
7
+ test*.ipynb
8
  /.ipynb_checkpoints
9
 
10
  # docs
README.md ADDED
@@ -0,0 +1,23 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+
2
+
3
+ ## To test the LLM only
4
+ Download the relevant LLM python notebooks (e.g. `LLM for Patient.ipynb`)
5
+
6
+ Add your own .env file in the same directory as the notebook
7
+
8
+ Run :)
9
+
10
+ ----------------------------------------------------------------
11
+ # How to run locally
12
+
13
+ git pull everything down
14
+
15
+ `python -m pip install -r requirements.txt`
16
+
17
+ Add your own .env file based on the env.example (huggingface, openai, firebase tokens required)
18
+
19
+ ???
20
+
21
+ profit
22
+
23
+ ---------------------------------
env.example ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ HF_TOKEN=hf_XXXXXX
2
+ OPENAI_API_KEY=sk-XXXXXX
3
+ FIREBASE_CREDENTIAL={XXXXXXX}