Merge pull request #38 from Qredence/0.4.1

0.4.1

README.md

@@ -7,7 +7,7 @@ GraphFleet is an advanced implementation of [GraphRAG from Microsoft](https://gi
 ## GraphFleet
 
 GraphFleet uses knowledge graphs to provide substantial improvements in question-and-answer performance when reasoning about complex information. It addresses limitations of traditional RAG approaches:
-<<<<<<< HEAD
+
 
 ## Roadmap
 
@@ -38,14 +38,11 @@ GraphFleet uses knowledge graphs to provide substantial improvements in question
 
 ### Prerequisites
 
-<<<<<<< HEAD
+
 - Python 3.10
 - Poetry
 - Make sure to have a virtual environment manager such as `virtualenv` installed
-=======
-- Python 3.11 
-- Make sure to have a virtual environment manager such as `virtualenv` installed 
->>>>>>> origin/main
+
 
 ### Installation
 
@@ -57,12 +54,6 @@ GraphFleet uses knowledge graphs to provide substantial improvements in question
 ```
 
 
-   ``` bash
-   git clone https://github.com/Qredence/GraphFleet.git
-   cd GraphFleet
-   ```
-
-
 2. Simply run these in your terminal:
 
    ``` bash
@@ -71,26 +62,12 @@ GraphFleet uses knowledge graphs to provide substantial improvements in question
    ```
 
 
-2. Create a virtual environment and activate it:
-
-``` bash
-python3.11 -m venv gfleetenv
-source gfleetenv/bin/activate
-```
-
-3. Install dependencies:
-
-```
-pip install -r requirements.txt
-```
-
 
 ### Usage
 
 1. Configuration:
 Environment Variables: Set up your environment variables in a .env file (refer to the .env.example file for available options). Key variables include:
 
-
    ```sh
    export GRAPHRAG_API_KEY="<apikey>"
    export GRAPHRAG_API_BASE="custom base api url"
@@ -114,25 +91,17 @@ Jupyter Notebooks: Explore GraphFleet's capabilities with the provided notebooks
 
    app.py (FastAPI Application): Run a Streamlit-powered web interface to interact with GraphFleet using a user-friendly chat-like interface.
 
-### Start the application
+### Start the application API only
 
+``` bash
+uvicorn graphfleet.api.api:app --host 0.0.0.0 --port 8001
 ```
-streamlit run app.py
-```
-
-Access the interface in your web browser at the provided URL (usually <http://localhost:8080>).
 
+Access the interface in your web browser at the provided URL  <http://0.0.0.0:8001/docs> .
 
 
-```
-GRAPHRAG_API_KEY
-GRAPHRAG_API_BASE (for Azure OpenAI)
-GRAPHRAG_API_VERSION (for Azure OpenAI)
-Other settings related to your LLM and embedding models.
-settings.yaml: Customize GraphFleet's behavior further by modifying the settings.yaml file within the graphfleet directory.
-```
 
-2. Data Indexing:
+1. Data Indexing:
 
 Jupyter Notebook Guide: Follow the instructions provided in the get-started-graphfleet.ipynb notebook to learn how to index your data with GraphFleet. This notebook provides a hands-on experience for setting up your knowledge base.
 
@@ -144,13 +113,19 @@ Local Search Notebook.ipynb: Demonstrates local search techniques.
 [Add descriptions of other notebooks and their purpose here]
 app.py (FastAPI Application): Run a Streamlit-powered web interface to interact with GraphFleet using a user-friendly chat-like interface:
 
-### Start the application: 
+### Running the API only
 
+To run the API, save the code in a file named api.py and execute the following command in your terminal:
+
+``` bash
+uvicorn api:app --reload --port 8001
 ```
-streamlit run app.py
-```
-Access the interface in your web browser at the provided URL (usually http://localhost:8080).
 
+### Start the application
+
+``` bash
+streamlit run app.py # Access the interface in your web browser at the provided URL (usually http://localhost:8080).
+```
 
 ``` bash
 python -m graphrag.query --root ./graphfleet --method local "What are the key features of GraphRAG ??"
@@ -180,6 +155,4 @@ uvicorn api:app --reload --port 8001
 [text](LICENSE)
 
 ## Star History
-
 [![Star History Chart](https://api.star-history.com/svg?repos=Qredence/GraphFleet&type=Date)](https://star-history.com/#Qredence/GraphFleet&Date)
-

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "graphfleet"
-version = "0.4.0"
+version = "0.4.1"
 description = "Build upon GraphRAG, provide a quick solution setup and is part of the overall Qredence System like AgenticFleet and FleetUI"
 authors = ["Zachary <[email protected]>"]
 license = "Apache-2.0"