You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-6
Original file line number
Diff line number
Diff line change
@@ -46,7 +46,9 @@ Try out open-text-embeddings in your browser:
46
46
47
47
[](https://colab.research.google.com/drive/1wfgfkt6xk3meSF5jWHDMqo6mL0ZvPw2f?usp=sharing)
48
48
49
-
## 🖥️ Standalone FastAPI Server
49
+
## 🖥️ On-Premise Deployment
50
+
51
+
### Standalone FastAPI Server
50
52
51
53
To run the embeddings endpoint locally as a standalone FastAPI server, follow these steps:
52
54
@@ -97,15 +99,22 @@ To run the embeddings endpoint locally as a standalone FastAPI server, follow th
97
99
INFO: Uvicorn running on http://0.0.0.0:8000 (Press CTRL+C to quit)
98
100
```
99
101
100
-
## ☁️ AWS Lambda Function
102
+
## ☁️ Cloud Deployment
103
+
To deploy the embeddings endpoint to the cloud platform using GitHub Actions, [fork](https://github.com/limcheekin/open-text-embeddings/fork) the repo first, then follow these steps for:
104
+
105
+
106
+
### AWS Lambda Function
107
+
108
+
1. Add your AWS credentials (`AWS_KEY` and `AWS_SECRET`) to the repository secrets. You can do this by navigating to [https://github.com/your-username/open-text-embeddings/settings/secrets/actions]().
109
+
110
+
2. Manually trigger the `Deploy Dev` or `Remove Dev` GitHub Actions to deploy or remove the AWS Lambda Function.
101
111
102
-
To deploy the embeddings endpoint as an AWS Lambda Function using GitHub Actions, follow these steps:
112
+
### Modal
103
113
104
-
1.[Fork](https://github.com/limcheekin/open-text-embeddings/fork) the repo.
114
+
1.Add your Modal credentials (`MODAL_TOKEN_ID`, `MODAL_TOKEN_SECRET` and `MODAL_USERNAME`) to the repository secrets. You can do this by navigating to [https://github.com/your-username/open-text-embeddings/settings/secrets/actions]().
105
115
106
-
2.Add your AWS credentials (`AWS_KEY` and `AWS_SECRET`) to the repository secrets. You can do this by navigating to [https://github.com/your-username/open-text-embeddings/settings/secrets/actions]().
116
+
2.Manually trigger the `Deploy Modal` GitHub Actions to deploy the Modal web endpoints.
107
117
108
-
3. Manually trigger the `Deploy Dev` or `Remove Dev` GitHub Actions to deploy or remove the AWS Lambda Function.
0 commit comments