Merge pull request #14 from AstraBert/bugfixes

Fixes for missing dependencies troubles
AstraBert · Jan 10, 2025 · 1b29f54 · 1b29f54
2 parents 378dc22 + 75c0a0b
commit 1b29f54
Show file tree

Hide file tree

Showing 7 changed files with 40 additions and 19 deletions.
diff --git a/.gitignore b/.gitignore
@@ -12,3 +12,4 @@ lib/docker/labse/
 qwen-on-api/__pycache__/
 chatbot-ui/.next/
 chatbot-ui/node_modules/
+site/
diff --git a/README.md b/README.md
@@ -72,6 +72,8 @@ docker compose up -d
 5. Run `Qwen-2.5-1.5B-Instruct` on API with FastAPI/Uvicorn:
 
 ```bash
+conda activate praivatesearch
+cd qwen-on-api/
 uvicorn main:app --host 0.0.0.0 --port 8000
 ```
 

diff --git a/docs/explanation.md b/docs/explanation.md
@@ -152,6 +152,9 @@ We can head over to the *conda* environment we set up in the first steps, and la
 # activate the environment
 conda activate praivatesearch
 
+# head over to the folder where the app is stored
+cd qwen-on-api/
+
 # launch the application
 uvicorn main:app --host 0.0.0.0 --port 8000
 ```

diff --git a/docs/index.md b/docs/index.md
@@ -70,10 +70,13 @@ docker compose up -d
 
 5. Run `Qwen-2.5-1.5B-Instruct` on API with FastAPI/Uvicorn:
 
+5. Run `Qwen-2.5-1.5B-Instruct` on API with FastAPI/Uvicorn:
+
 ```bash
+conda activate praivatesearch
+cd qwen-on-api/
 uvicorn main:app --host 0.0.0.0 --port 8000
 ```
-
 You can access the application from `http://localhost:3000` and chat with it!
 
 ### Usage note

diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md
@@ -0,0 +1,28 @@
+# Troubleshooting
+
+## `pip` dependencies not installed
+
+You could run into an issue which is similar to [this one](https://github.com/AstraBert/PrAIvateSearch/issues/13): it will seem that the pip dependencies were not installed. Make sure to:
+
+1. Install the latest version of `conda`:
+
+```bash
+curl -O https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh
+bash Miniconda3-latest-Linux-x86_64.sh
+# make sure to run `source ~/.bashrc` if your Linux distro requires it!
+```
+
+2. Remove the `praivatesearch` environment and re-build it following the suggested installation:
+
+```bash
+conda env remove -n praivatesearch
+conda env create -f conda_environment.yaml
+```
+
+3. Activate the conda environment and make sure that the activation is smooth:
+
+```bash
+conda activate praivatesearch
+```
+
+You should now be all set and ready to launch the application!🎉
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,4 +1,4 @@
-site_name: Academic Notes
+site_name: PrAIvateSearch
 theme:
   name: material
   features:
@@ -30,3 +30,4 @@ nav:
 - Explanation: explanation.md 
 - About: about.md
 - Contributing: contributing.md
+- Troubleshooting: troubleshooting.md
diff --git a/requirements.txt b/requirements.txt