Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

The second revision #9

Merged
merged 3 commits into from
Mar 1, 2025
Merged

The second revision #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fb06202
The second revision
habedi Mar 1, 2025
cb4c799
WIP
habedi Mar 1, 2025
f0e15e5
WIP
habedi Mar 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions .github/workflows/publish.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@ name: Publish to PyPI

on:
workflow_dispatch: # Enable manual runs
tag:
- 'v*' # Run on version tags
push:
tags:
- 'v*' # Trigger on version tags

jobs:

Expand Down
11 changes: 6 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,15 @@ The main idea is to speed up the process of writing application letters by not s
Instead, an applicant could generate a draft letter that can be used as a starting point and customized as needed
to make the final letter.

The diagram below shows the high-level workflow of how Easy Letters can be used to generate draft application
letters.
The diagram below shows the workflow of the naive RAG pipeline that the current version of Easy Letters can be used
to implement.

![Easy Letters Workflow](assets/workflow.svg)

> [!NOTE]
> At the moment, Easy Letters only supports text generation and text embedding models from OpenAI.
> However, the library is designed to be extensible, so more features and models can be added in the future versions.

### Installation

```bash
Expand Down Expand Up @@ -69,9 +73,6 @@ Easy Letters currently supports the following models:
| Text Embedding 3 (Small Variant) | Text Embedding | OpenAI |
| Text Embedding 3 (Large Variant) | Text Embedding | OpenAI |

> [!NOTE]
> At the moment, Easy Letters only supports text generation and text embedding models from OpenAI.

### License

Easy Letters is available under the MIT license ([LICENSE](LICENSE)).