bilalb/Philosophy-RAG-demo
1
0
Fork 0
forked from AI_team/Philosophy-RAG-demo
Code Pull Requests Activity

📝 Add separate project env setup section

Browse Source
This commit is contained in:
Ruben Lucas 2025-04-17 13:47:36 +02:00
parent adcaceab8a
commit 6b4dfa13b6
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -8,6 +8,7 @@ A generic Retrieval Augmented Generation (RAG) demo from Sogeti Netherlands buil
- [Table of Contents](#table-of-contents) - [Table of Contents](#table-of-contents)
- [Features](#features) - [Features](#features)
- [Getting started](#getting-started) - [Getting started](#getting-started)
- [Project Environment Setup](#project-environment-setup)
- [Installation of system dependencies](#installation-of-system-dependencies) - [Installation of system dependencies](#installation-of-system-dependencies)
- [Unstructered PDF loader (optional)](#unstructered-pdf-loader-optional) - [Unstructered PDF loader (optional)](#unstructered-pdf-loader-optional)
- [Local LLM (optional)](#local-llm-optional) - [Local LLM (optional)](#local-llm-optional)
@ -25,7 +26,7 @@ A generic Retrieval Augmented Generation (RAG) demo from Sogeti Netherlands buil
## Getting started ## Getting started
### Installation of system dependencies ### Project Environment Setup
This project leverages a modern packaging method defined in `pyproject.toml`. After cloning the repository, you can install the project along with its dependencies. You have two options: This project leverages a modern packaging method defined in `pyproject.toml`. After cloning the repository, you can install the project along with its dependencies. You have two options:
1. Using uv 1. Using uv
@ -44,6 +45,10 @@ source .venv/bin/activate # Activate the virtual environment (use ".venv\Scrip
pip install . # Install the project and its dependencies pip install . # Install the project and its dependencies
``` ```
### Installation of system dependencies
Some optional features require additional system applications to be installed.
#### Unstructered PDF loader (optional) #### Unstructered PDF loader (optional)
If you would like to run the application using the unstructered PDF loader (`pdf.unstructured` setting) you need to install two system dependencies. If you would like to run the application using the unstructered PDF loader (`pdf.unstructured` setting) you need to install two system dependencies.