Skip to content

Commit

Permalink
WIP
Browse files Browse the repository at this point in the history
  • Loading branch information
habedi committed Jun 28, 2024
1 parent 49c40e8 commit accb0b5
Showing 1 changed file with 9 additions and 15 deletions.
24 changes: 9 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,9 @@
[![PyPI version](https://badge.fury.io/py/easy-letters.svg)](https://badge.fury.io/py/easy-letters)
[![Downloads](https://pepy.tech/badge/easy-letters)](https://pepy.tech/project/easy-letters)

Easy Letters is a Python package to help job seekers writing application letters. It uses a simple retrieval
augmented generation (RAG) pipeline to generate the letters. The user can then edit the draft letter to suit their
Easy Letters is a Python package that helps job seekers write application letters. A simple retrieval
augmented generation (RAG) pipeline is used to generate the letters. The user can then edit the draft letter to suit
their
needs.

## Installation
Expand Down Expand Up @@ -42,23 +43,16 @@ Easy Letters currently supports the following models:
| Text Embedding 3 (Small Variant) | Text Embedding |
| Text Embedding 3 (Large Variant) | Text Embedding |

### Installation from Source
### Installing from Source

You can also install Easy Letters from the source code in this repository.
The main benefit of this approach is that you can use run the sample notebooks and modify the code as you wish.
You can also install Easy Letters from the source code in this repository. The main benefit of this approach is that
you might find it easier to run the sample notebooks and modify the code as you wish this way.

To you can follow the steps below:
After cloning this repository, you can navigate to the `easy-letters` directory and install the
dependencies using [Poetry](https://python-poetry.org/):

```bash
git clone https://github.com/habedi/easy-letters.git
```

Then, navigate to the `easy-letters` directory and install the dependencies using [Poetry](https://python-poetry.org/).

```bash

cd easy-letters && poetry install

git clone https://github.com/habedi/easy-letters.git && cd easy-letters
poetry install --with dev
```

Expand Down

0 comments on commit accb0b5

Please sign in to comment.