From fde5fa96e528ac824c186ed6d401d7d7124c18bc Mon Sep 17 00:00:00 2001 From: Zachary BENSALEM Date: Wed, 14 Aug 2024 23:52:56 +0200 Subject: [PATCH] Update README.md Signed-off-by: Zachary BENSALEM --- README.md | 27 ++++++++++----------------- 1 file changed, 10 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 8b3a146f0..72f475f00 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ GraphFleet uses knowledge graphs to provide substantial improvements in question - Leave us a star ♥ - Fork and contribute to the project -- [![Join the discord](https://api.star-history.com/svg?repos=Qredence/GraphFleet&type=Date)](https://star-history.com/#Qredence/GraphFleet&Date) +- [![Join the discord](https://discord.gg/BD8MPgzEJc) ## Getting Started @@ -50,21 +50,19 @@ GraphFleet uses knowledge graphs to provide substantial improvements in question ### Installation 1. Clone the repository: -<<<<<<< HEAD -======= ``` bash git clone https://github.com/Qredence/GraphFleet.git cd GraphFleet ``` ->>>>>>> origin/main + ``` bash git clone https://github.com/Qredence/GraphFleet.git cd GraphFleet ``` -<<<<<<< HEAD + 2. Simply run these in your terminal: ``` bash @@ -72,7 +70,7 @@ GraphFleet uses knowledge graphs to provide substantial improvements in question poetry install ``` -======= + 2. Create a virtual environment and activate it: ``` bash @@ -85,13 +83,13 @@ source gfleetenv/bin/activate ``` pip install -r requirements.txt ``` ->>>>>>> origin/main + ### 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: -<<<<<<< HEAD + ```sh export GRAPHRAG_API_KEY="" @@ -124,7 +122,7 @@ streamlit run app.py Access the interface in your web browser at the provided URL (usually ). -======= + ``` GRAPHRAG_API_KEY @@ -153,7 +151,7 @@ streamlit run app.py ``` Access the interface in your web browser at the provided URL (usually http://localhost:8080). ->>>>>>> origin/main + ``` bash python -m graphrag.query --root ./graphfleet --method local "What are the key features of GraphRAG ??" ``` @@ -163,10 +161,8 @@ For Global query mode : ``` bash python -m graphrag.query --root ./graphfleet --method global "What are the top main features of GraphRAG" ``` -<<<<<<< HEAD -======= ->>>>>>> origin/main + ### 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: @@ -185,8 +181,5 @@ uvicorn api:app --reload --port 8001 ## Star History -<<<<<<< HEAD -[![Star History Chart](https://api.star-history.com/svg?repos=Qredence/GraphFleet&type=Date)](https://star-history.com/#Qredence/GraphFleet&Date) -======= [![Star History Chart](https://api.star-history.com/svg?repos=Qredence/GraphFleet&type=Date)](https://star-history.com/#Qredence/GraphFleet&Date) ->>>>>>> origin/main +