corrections and docs

AstraBert · Dec 10, 2024 · 50ed2a0 · 50ed2a0
1 parent 1db4596
commit 50ed2a0
Show file tree

Hide file tree

Showing 26 changed files with 82 additions and 568 deletions.
diff --git a/.gitpod.yml b/.gitpod.yml
diff --git a/...rch Query/41ddcc66f19720a7c3bd/Components-of-a-nuclear-power-plant-1400x803.png b/...rch Query/41ddcc66f19720a7c3bd/Components-of-a-nuclear-power-plant-1400x803.png
diff --git a/.gradio/flagged/dataset1.csv b/.gradio/flagged/dataset1.csv
@@ -0,0 +1,20 @@
+Search Query,Image Search Query,Maximum Number of Search Results,Enable RAG,Debug,Search Results,timestamp
+,.gradio\flagged\Image Search Query\41ddcc66f19720a7c3bd\Components-of-a-nuclear-power-plant-1400x803.png,3,false,true,"### Understanding Nuclear Power Plants and Reactors
+
+Nuclear power plants generate electricity through controlled nuclear fission in large, specialized facilities. These systems consist of multiple components including nuclear reactors which convert uranium or other fissile materials into usable energy.
+
+#### Key Components:
+- **Reactor Core**: The heart of any nuclear power plant where the actual reaction takes place.
+    - *Bangombe Deposit*: A notable location for potential future use as an additional source of fuel.
+
+- **Heat Transfer Fluids**: Various types such as heavy water (deuterium oxide) and light water (ordinary H₂O), depending on specific designs like RBMK reactors mentioned here.
+
+- **Power Outputs**: Units can produce significant amounts of electrical output; e.g., one reactor might be rated at around 150 MWe (Megawatts Electrical).
+
+- **Safety Measures & Regulations**: Strict guidelines ensure safety during operation by managing coolant flow rates carefully (""Follow Loads Reasonably Easily Without Burning"").
+
+- **Fuel Cycle Management**: Ensures smooth transition between different phases of operations using detailed guides available online.
+
+This type of technology has been extensively studied over decades leading up to today's advanced models. For instance, there have been numerous reports documenting its development process from early stages all the way to current state-of-the-art technologies.
+
+If interested further details about individual aspects could refer directly to World-Nuclear Organization resources linked within this summary. They provide comprehensive documentation covering everything from theoretical principles down to practical applications across diverse contexts worldwide.",2024-12-10 16:31:14.503594
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,4 +1,4 @@
-# Contributing to SearchPhi
+# Contributing to PrAIvateSearch
 
 Do you want to contribute to this project? Make sure to read this guidelines first :)
 
@@ -32,15 +32,15 @@ Do you want to contribute to this project? Make sure to read this guidelines fir
 3. Submit pull request (make sure to provide a thorough description of the changes)
 
 
-## Showcase your SearchPhi
+## Showcase your PrAIvateSearch
 
 **When to do it**:
 
-- You modified the base application with new features but you don't want/can't merge them with the original SearchPhi
+- You modified the base application with new features but you don't want/can't merge them with the original PrAIvateSearch
 
 **How to do it**:
 
-- Go to [_GitHub Discussions > Show and tell_](https://github.com/AstraBert/SearchPhi/discussions/categories/show-and-tell) page
-- Open a new discussion there, describing your SearchPhi application
+- Go to [_GitHub Discussions > Show and tell_](https://github.com/AstraBert/PrAIvateSearch/discussions/categories/show-and-tell) page
+- Open a new discussion there, describing your PrAIvateSearch application
 
 ### Thanks for contributing!
diff --git a/Dockerfile.gitpod b/Dockerfile.gitpod
diff --git a/README.md b/README.md
@@ -1,43 +1,52 @@
-<h1 align="center">SearchPhi</h1>
-<h2 align="center">Open source and AI-powered web search engine🌐</h2>
+<h1 align="center">PrAIvateSearch</h1>
+<h2 align="center">Own your AI, search the web with it🌐😎</h2>
 
 <div align="center">
-    <img src="https://img.shields.io/github/languages/top/AstraBert/SearchPhi" alt="GitHub top language">
-   <img src="https://img.shields.io/github/commit-activity/t/AstraBert/SearchPhi" alt="GitHub commit activity">
-   <img src="https://img.shields.io/badge/Status-stable_beta-green" alt="Static Badge">
-   <img src="https://img.shields.io/badge/Release-v0.0_beta.0-purple" alt="Static Badge">
-   <img src="https://img.shields.io/docker/image-size/astrabert/searchphi
-   " alt="Docker image size">
-   <img src="https://img.shields.io/badge/Supported_platforms-Windows/POSIX-brown" alt="Static Badge">
    <div>
-        <img src="./imgs/SearchPhi_logo.png" alt="Logo" align="center">
+        <img src="./imgs/PrAIvateSearch_logo.png" alt="Logo" align="center">
    </div>
 </div>
 
-> **_DOCS TO BE UPDATED SOON!_**
 
-## About SearchPhi
+## About PrAIvateSearch
 
-SearchPhi is a Streamlit application that aims to implement similar features to SearchGPT, but in an open-source, local and private way. 
+PrAIvateSearch is a Gradio application that aims to implement similar features to SearchGPT, but in an open-source, local and private way. 
+
+## Flowchart
+
+<div align="center">
+    <img src="./imgs/PrAIvateSearch_Flowchart.png" alt="Logo" align="center">
+    <p><i>Flowchart for PrAIvateSearch</i></p>
+</div>
+
+The process of creating and the functioning of PrAIvateSearch is explained in this [blog post on HuggingFace](https://huggingface.co/blog/as-cle-bert/build-an-ai-powered-search-engine-from-scratch).
 
 ## Installation and usage
 
-### Source code
 
 1. Clone the repository:
 
 ```bash
-git clone https://github.com/AstraBert/SearchPhi.git
-cd SearchPhi
+git clone https://github.com/AstraBert/PrAIvateSearch.git
+cd PrAIvateSearch
+```
+
+2. Move `.env.example` to `.env`...
+
+```bash
+mv .env.example .env
 ```
 
-2. Create a `model` folder, download [this GGUF file](https://huggingface.co/microsoft/Phi-3-mini-4k-instruct-gguf/blob/main/Phi-3-mini-4k-instruct-q4.gguf) and move the GGUF file in the `model` folder:
+...and specify PostgreSQL related variables:
 
 ```bash
-mkdir model
-mv /path/to/Downloads/Phi-3-mini-4k-instruct-q4.gguf model/
+# .env file
+PG_DB="postgres"
+PG_USER="pgql_usr"
+PG_PASSWORD="pgql_psw"
 ```
 
+
 3. Install necessary dependencies:
   - Linux:
 ```bash
@@ -57,59 +66,32 @@ source c:\path\to\SearchPhi\Scripts\activate  # For Git
 python3 -m pip install -r requirements.txt
 ```
 
-
-4. Run the application:
+4. Start third-party services:
 
 ```bash
-python3 -m streamlit run app.py
+docker compose up -d
 ```
 
-You'll see the application on `http://localhost:8501`.
-
-**PROs**: You can customize the application code (change the GGUF model, change CPU/GPU settings, change generation kwargs, modify the app interface...)
-
-**CONs**: Longer and more complex installation process
-
-### Docker
-
-1. Pull the image
+5. Run the application:
 
 ```bash
-docker pull astrabert/searchphi:latest
+python3 scripts/app.py
 ```
 
-2. Run the container:
-
-```bash
-docker run -p 8501:8501 astrabert/searchphi:latest
-```
-
-Shortly after you submit the `docker run` command, the container logs will tell you that the application is up and running on `http://localhost:8501`.
-
-**PROs**: Shorter and simpler installation process
+Once the models will be downloaded and loaded on your hardware, you'll see the application on `http://localhost:7860`.
 
-**CONs**: You cannot customize the application code
+**PROs**: You can customize the application code (change the model, change CPU/GPU settings, change generation kwargs, modify the app interface...)
 
-### Run in cloud
-
-- **GitPod workspaces**: Click [here](https://gitpod.io/#https://github.com/AstraBert/SearchPhi) to open the GitPod workspace
-
-**PROs**: No local installation and you can exploit better hardwares
-
-**CONs**: Limited resources
+**CONs**: Longer and more complex installation process
 
 ### Usage note
 
-> ⚠️ _The Streamlit application was successfully developed and tested on a Windows 10.0.22631 machine, with 32GB RAM, 16 core CPU and Nvidia GEFORCE RTX4050 GPU (6GB, cuda version 12.3), python version 3.11.9_
-
-> ⚠️ _The Docker container was successfully tested on a Windows 10.0.22631 machine and on a Ubuntu 22.04.3 machine_ 
+> ⚠️ _The Gradio application was successfully developed and tested on a Windows 10.0.22631 machine, with 32GB RAM, 16 core CPU and Nvidia GEFORCE RTX4050 GPU (6GB, cuda version 12.3), python version 3.11.9_
 
 Although being at a good stage of development, the application is a `beta` and might still contain bugs and have OS/hardware/python version incompatibilities.
 
 ## Demo
 
-You can try out SearchPhi on [this HuggingFace Space](https://huggingface.co/spaces/as-cle-bert/SearchPhi). 
-
 Here's a video demo of what it can do:
 
 ![Video demo for SearechPhi](./imgs/demo.gif)

diff --git a/compose.custom.yaml b/compose.custom.yaml
diff --git a/compose.yaml b/compose.yaml
@@ -11,9 +11,9 @@ services:
     networks:
       - mynet
     environment:
-      POSTGRES_DB: pgql_usr
-      POSTGRES_USER: pgql_psw
-      POSTGRES_PASSWORD: pgql_psw
+      POSTGRES_DB: $PG_DB
+      POSTGRES_USER: $PG_USER
+      POSTGRES_PASSWORD: $PG_PASSWORD
     volumes:
       - pgdata:/var/lib/postgresql/data 
 
@@ -27,15 +27,7 @@ services:
       - mynet
     volumes:
       - "./qdrant_storage:/qdrant/storage"
-
-  praivatesearch:
-    image: astrabert/praivatesearch:latest
-    restart: always
-    ports:
-      - "7860:7860"
-    networks:
-      - mynet
-
+
   adminer:
     image: adminer
     restart: always

diff --git a/imgs/PrAIvateSearch_Flowchart.png b/imgs/PrAIvateSearch_Flowchart.png
diff --git a/imgs/PrAIvateSearch_logo.png b/imgs/PrAIvateSearch_logo.png
diff --git a/imgs/SearchPhi_logo.png b/imgs/SearchPhi_logo.png
diff --git a/imgs/demo.gif b/imgs/demo.gif
diff --git a/lib/docker/Dockerfile b/lib/docker/Dockerfile
diff --git a/lib/docker/app.py b/lib/docker/app.py
diff --git a/lib/docker/image_gen.py b/lib/docker/image_gen.py