Skip to content

Commit 384c696

Browse files
committed
doc: updated readme and release note
1 parent 2a06925 commit 384c696

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,7 @@ To run the embeddings endpoint locally as a standalone FastAPI server, follow th
2525
1. Install the dependencies by executing the following commands:
2626

2727
```bash
28-
pip install --no-cache-dir -r server-requirements.txt
29-
pip install --no-cache-dir uvicorn
28+
pip install --no-cache-dir open-text-embeddings[server]
3029
```
3130

3231
2. Run the server with the desired model using the following command which enabled normalize embeddings (Omit the `NORMALIZE_EMBEDDINGS` if the model don't support normalize embeddings):
@@ -56,20 +55,22 @@ To run the embeddings endpoint locally as a standalone FastAPI server, follow th
5655

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

59-
1. Add your AWS credentials (`AWS_KEY` and `AWS_SECRET`) to the repository secrets. You can do this by navigating to https://github.com/username/open-text-embeddings/settings/secrets/actions.
58+
1. [Fork](https://github.com/limcheekin/open-text-embeddings/fork) the repo.
6059

61-
2. Manually trigger the `Deploy Dev` or `Remove Dev` GitHub Actions to deploy or remove the AWS Lambda Function.
60+
2. Add your AWS credentials (`AWS_KEY` and `AWS_SECRET`) to the repository secrets. You can do this by navigating to https://github.com/username/open-text-embeddings/settings/secrets/actions.
61+
62+
3. Manually trigger the `Deploy Dev` or `Remove Dev` GitHub Actions to deploy or remove the AWS Lambda Function.
6263

6364
## Testing the Embeddings Endpoint
6465

65-
To test the embeddings endpoint, this repository includes an `embeddings.ipynb` notebook with a LangChain-compatible `OpenAIEmbeddings` class.
66+
To test the embeddings endpoint, the repository includes an [embeddings.ipynb](https://github.com/limcheekin/open-text-embeddings/blob/main/embeddings.ipynb) notebook with a LangChain-compatible `OpenAIEmbeddings` class.
6667

6768
To get started:
6869

6970
1. Install the dependencies by executing the following command:
7071

7172
```bash
72-
pip install --no-cache-dir -r test-requirements.txt
73+
pip install --no-cache-dir open-text-embeddings openai tiktoken
7374
```
7475

7576
2. Execute the cells in the notebook to test the embeddings endpoint.

release.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
1.0.0 released.
1+
1.0.1 released.
22

3-
Thank you very much for the following contributions:
4-
[Vokturz](https://github.com/Vokturz) contributed [#2](https://github.com/limcheekin/open-text-embeddings/pull/2): support for CPU/GPU choice and initialization before starting the app.
3+
Fixed readme and package publishing workflow, no changes to code.

0 commit comments

Comments
 (0)