Skip to content

Commit

Permalink
doc: restructured section heading and added modal deployment steps
Browse files Browse the repository at this point in the history
  • Loading branch information
limcheekin committed Jul 13, 2024
1 parent 8208d00 commit cac1138
Showing 1 changed file with 15 additions and 6 deletions.
21 changes: 15 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,9 @@ Try out open-text-embeddings in your browser:

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

## 🖥️ Standalone FastAPI Server
## 🖥️ On-Premise Deployment

### Standalone FastAPI Server

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

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

## ☁️ AWS Lambda Function
## ☁️ Cloud Deployment
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:


### AWS Lambda Function

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

2. Manually trigger the `Deploy Dev` or `Remove Dev` GitHub Actions to deploy or remove the AWS Lambda Function.

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

1. [Fork](https://github.com/limcheekin/open-text-embeddings/fork) the repo.
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]().

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]().
2. Manually trigger the `Deploy Modal` GitHub Actions to deploy the Modal web endpoints.

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

## 🧪 Testing the Embeddings Endpoint

Expand Down

0 comments on commit cac1138

Please sign in to comment.