Spaces:
Sleeping
Sleeping
arslan-ahmed
commited on
Commit
•
9da33d2
1
Parent(s):
57397f0
Update README.md
Browse files
README.md
CHANGED
@@ -1,4 +1,4 @@
|
|
1 |
-
---
|
2 |
title: Talk To Your Docs
|
3 |
emoji: 📚
|
4 |
colorFrom: purple
|
@@ -10,18 +10,36 @@ pinned: false
|
|
10 |
license: apache-2.0
|
11 |
---
|
12 |
|
13 |
-
Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
|
14 |
|
15 |
|
16 |
-
For users
|
|
|
17 |
https://huggingface.co/spaces/arslan-ahmed/talk-to-your-docs
|
18 |
|
19 |
|
20 |
-
For developers
|
21 |
-
Source code
|
22 |
https://huggingface.co/spaces/arslan-ahmed/talk-to-your-docs/tree/main
|
23 |
|
24 |
-
|
25 |
-
|
26 |
-
|
|
|
|
|
27 |
docker run --rm -d -p 7860:7860 --env-file ./.env arslan2k12/arslanbot
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
<!-- ---
|
2 |
title: Talk To Your Docs
|
3 |
emoji: 📚
|
4 |
colorFrom: purple
|
|
|
10 |
license: apache-2.0
|
11 |
---
|
12 |
|
13 |
+
Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference -->
|
14 |
|
15 |
|
16 |
+
### For users
|
17 |
+
You can use this app via Hugging Face where it is already deployed:<br/>
|
18 |
https://huggingface.co/spaces/arslan-ahmed/talk-to-your-docs
|
19 |
|
20 |
|
21 |
+
### For developers
|
22 |
+
Source code:<br/>
|
23 |
https://huggingface.co/spaces/arslan-ahmed/talk-to-your-docs/tree/main
|
24 |
|
25 |
+
You can develop and deploy your own personal chatbot (similar to https://huggingface.co/spaces/arslan-ahmed/talk-to-arslan), with the following three commands:
|
26 |
+
|
27 |
+
|
28 |
+
docker pull arslan2k12/ttyd_base (https://hub.docker.com/r/arslan2k12/ttyd_base) <br/>
|
29 |
+
docker pull arslan2k12/arslanbot (https://hub.docker.com/r/arslan2k12/arslanbot)<br/>
|
30 |
docker run --rm -d -p 7860:7860 --env-file ./.env arslan2k12/arslanbot
|
31 |
+
|
32 |
+
|
33 |
+
Contents of `.env` file:
|
34 |
+
```
|
35 |
+
TTYD_MODE=personalBot_john
|
36 |
+
#replace john with your name - use only small alphabets, no special characters
|
37 |
+
|
38 |
+
GDRIVE_FOLDER_URL=https://drive.google.com/drive/folders/1ce1n1kleS1FOotdcu5joXeSRu_xnHjDt
|
39 |
+
# replace with your Google Drive folder URL - make sure this folder is publically accessible (everyone with the link)
|
40 |
+
|
41 |
+
OPENAI_API_KEY=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
|
42 |
+
# your OpenAI API Key.
|
43 |
+
```
|
44 |
+
|
45 |
+
|