Skip to content
Open
Changes from all commits
Commits
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
45 changes: 12 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,21 @@
# mini-rag

This is a minimal implementation of the RAG model for question answering.
# Mini-rag
this is a minimal implementation of the Rag model for question and Answer

## Requirements
# requirements
python 3.8 or later

- Python 3.8 or later
## installing python using miniconda

#### Install Python using MiniConda
download and install Miniconda
2-create a new environment using the following command:

1) Download and install MiniConda from [here](https://docs.anaconda.com/free/miniconda/#quick-command-line-install)
2) Create a new environment using the following command:
```bash
$ conda create -n mini-rag python=3.8
```
3) Activate the environment:
```bash
$ conda activate mini-rag
``` bash
$ conda creat -n mini-rag app1 python=3.8
```

### (Optional) Setup you command line interface for better readability

3- activate environment
```bash
export PS1="\[\033[01;32m\]\u@\h:\w\n\[\033[00m\]\$ "
```

## Installation

### Install the required packages

```bash
$ pip install -r requirements.txt
```

### Setup the environment variables

```bash
$ cp .env.example .env
```
$ conda activate mini-rag-app1
````

Set your environment variables in the `.env` file. Like `OPENAI_API_KEY` value.