add: installation instructions

README.md

@@ -1,40 +1,3 @@
 # MedRAG Multi-Modal
 
 Multi-modal RAG for medical docmain.
-
-## Installation
-
-### For Development
-
-For MacOS, you need to run
-
-```bash
-brew install poppler
-```
-
-For Debian/Ubuntu, you need to run
-
-```bash
-sudo apt-get install -y poppler-utils
-```
-
-Then, you can install the dependencies using uv in the virtual environment `.venv` using
-
-```bash
-git clone https://github.com/soumik12345/medrag-multi-modal
-cd medrag-multi-modal
-pip install -U pip uv
-uv sync
-```
-
-After this, you need to activate the virtual environment using
-
-```bash
-source .venv/bin/activate
-```
-
-In the activated virtual environment, you need to install Flash Attention using
-
-```bash
-uv pip install flash-attn --no-build-isolation
-```

docs/index.md

@@ -33,7 +33,7 @@ After this, you need to activate the virtual environment using
 source .venv/bin/activate
 ```
 
-In the activated virtual environment, you need to install Flash Attention using
+In the activated virtual environment, you can optionally install Flash Attention (required for ColPali) using
 
 ```bash
 uv pip install flash-attn --no-build-isolation

docs/installation/development.md

@@ -0,0 +1,40 @@
+# Setting up the development environment
+
+## Install Poppler
+
+For MacOS, you need to run
+
+```bash
+brew install poppler
+```
+
+For Debian/Ubuntu, you need to run
+
+```bash
+sudo apt-get install -y poppler-utils
+```
+
+## Install the dependencies
+
+Then, you can install the dependencies using uv in the virtual environment `.venv` using
+
+```bash
+git clone https://github.com/soumik12345/medrag-multi-modal
+cd medrag-multi-modal
+pip install -U pip uv
+uv sync
+```
+
+After this, you need to activate the virtual environment using
+
+```bash
+source .venv/bin/activate
+```
+
+## [Optional] Install Flash Attention
+
+In the activated virtual environment, you can optionally install Flash Attention (required for ColPali) using
+
+```bash
+uv pip install flash-attn --no-build-isolation
+```

docs/installation/install.md

@@ -0,0 +1,9 @@
+# Installation
+
+You just need to clone the repository and run the install.sh script
+
+```bash
+git clone https://github.com/soumik12345/medrag-multi-modal
+cd medrag-multi-modal
+sh install.sh
+```

mkdocs.yml

@@ -59,6 +59,9 @@ extra_javascript:
 
 nav:
   - Home: 'index.md'
+  - Setup:
+    - Installation: 'installation/install.md'
+    - Development: 'installation/development.md'
   - Document Loader:
     - Text Loader: 'document_loader/load_text.md'
     - Text and Image Loader: 'document_loader/load_text_image.md'