Skip to content

Commit cac1138

Browse files
committed
doc: restructured section heading and added modal deployment steps
1 parent 8208d00 commit cac1138

File tree

1 file changed

+15
-6
lines changed

1 file changed

+15
-6
lines changed

Diff for: README.md

+15-6
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,9 @@ Try out open-text-embeddings in your browser:
4646

4747
[![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1wfgfkt6xk3meSF5jWHDMqo6mL0ZvPw2f?usp=sharing)
4848

49-
## 🖥️ Standalone FastAPI Server
49+
## 🖥️ On-Premise Deployment
50+
51+
### Standalone FastAPI Server
5052

5153
To run the embeddings endpoint locally as a standalone FastAPI server, follow these steps:
5254

@@ -97,15 +99,22 @@ To run the embeddings endpoint locally as a standalone FastAPI server, follow th
9799
INFO: Uvicorn running on http://0.0.0.0:8000 (Press CTRL+C to quit)
98100
```
99101

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.
101111

102-
To deploy the embeddings endpoint as an AWS Lambda Function using GitHub Actions, follow these steps:
112+
### Modal
103113

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]().
105115

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.
107117

108-
3. Manually trigger the `Deploy Dev` or `Remove Dev` GitHub Actions to deploy or remove the AWS Lambda Function.
109118

110119
## 🧪 Testing the Embeddings Endpoint
111120

0 commit comments

Comments
 (0)