# Overview
<div align="left">
<a href="https://pypi.org/project/graphfleet/">
<img alt="Pepy Total Downlods" src="https://img.shields.io/pepy/dt/graphfleet">
</a>
<img alt="GitHub License" src="https://img.shields.io/github/license/qredence/graphfleet">
<img alt="GitHub forks" src="https://img.shields.io/github/forks/qredence/graphfleet">
<img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/qredence/graphfleet">
</div>
https://github.com/user-attachments/assets/ac3271fa-cab5-412f-a441-bbedfe4a009f
GraphFleet is an advanced implementation of [GraphRAG from Microsoft](https://github.com/microsoft/graphrag), designed to enhance large language models' ability to reason about complex information and private datasets. It builds upon GraphRAG (Retrieval Augmented Generation using Graph structures) and will gradually adopt its own path to fulfill our roadmap at Qredence.
## 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:
## Roadmap
- [ ] Provide a FleetUI Design Kit and a quicker way of starting GraphFleet locally.
- [ ] Provide a Toddle interface ready to use for GraphFleet
- [ ] Add integrations of Composio
- [ ] Add integrations of LangSmith
- [ ] Add few selfhosting one click deploy solutions.
- [ ] Access GraphFleet through a secure and enterprise-ready Azure Cloud hosting version.
- [ ] And way more... 👀
## Key Features
- Structured, hierarchical approach to Retrieval Augmented Generation.
- Knowledge graph extraction from raw text.
- Community hierarchy building.
- Hierarchical summarization.
- Enhanced reasoning capabilities for LLMs on private datasets.
## Contribute
- Leave us a star ♥
- Fork and contribute to the project
- <a href="https://discord.gg/BD8MPgzEJc">
<img alt="Discord" src="https://img.shields.io/discord/1053300403149733969?style=for-the-badge&logo=discord">
</a>
<img alt="X (formerly Twitter) Follow" src="https://img.shields.io/twitter/follow/agenticfleet?style=for-the-badge&logo=x&logoColor=white&labelColor=blue&link=https%3A%2F%2Fx.com%2Fagenticfleet">
## Getting Started
### Prerequisites
- Python 3.11
- Poetry
- Make sure to have a virtual environment manager such as `virtualenv` installed
### Installation
1. Clone the repository:
```bash
git clone https://github.com/Qredence/GraphFleet.git
cd GraphFleet
```
2. Install the dependencies:
```bash
poetry shell
poetry install
```
### 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:
Fill in the .env file in the root folder and the one in the graphfleet folder.
```sh
export GRAPHRAG_API_KEY="your_api_key_here"
export GRAPHRAG_API_BASE="<https://your-azure-openai-resource.openai.azure.com/>"
export GRAPHRAG_API_VERSION=""
export GRAPHRAG_DEPLOYMENT_NAME="your_deployment_name"
export GRAPHRAG_API_TYPE="azure_openai"
export GRAPHRAG_EMBEDDING_MODEL="text-embedding-ada-002"
export GRAPHRAG_LLM_MODEL="gpt-4"
export GRAPHRAG_DATA_PATH="./your_data_directory"
export GRAPHRAG_EMBEDDING_TYPE="azure_openai_embedding"
export GRAPHRAG_EMBEDDING_KEY="your_embedding_key_here"
export GRAPHRAG_EMBEDDING_ENDPOINT="<https://your-azure-openai-embedding-resource.openai.azure.com/>"
export GRAPHRAG_EMBEDDING_DEPLOYMENT_NAME="your_embedding_deployment_name"
```
settings.yaml: Customize GraphFleet's behavior further by modifying the settings.yaml file within the graphfleet directory.
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.
1. Interacting with GraphFleet:
Jupyter Notebooks: Explore GraphFleet's capabilities with the provided notebooks:
get-started-graphfleet.ipynb: A comprehensive guide to indexing your data and running basic queries.
Local Search Notebook.ipynb: Demonstrates local search techniques.
app.py (FastAPI Application): Run a Streamlit-powered web interface to interact with GraphFleet using a user-friendly chat-like interface.
### Add your text files in ./graphfleet/input/ and run the auto_prompt function
``` bash
!python -m graphrag.prompt_tune \
--config ./graphfleet/settings.yaml \
--root ./graphfleet \
--no-entity-types \
--output ./graphfleet/prompts
```
### 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.
``` bash
! python -m graphrag.index \
--verbose \
--root ./graphfleet \
--config ./graphfleet/settings.yaml
```
## IMPORTANT : Run these notebook to get started with GraphFleet:
Jupyter Notebooks: Explore GraphFleet's capabilities with the provided notebooks:
([Get Started Quickly.ipynb](https://github.com/Qredence/GraphFleet/blob/a67eaeb295d99dd2ef48bcdd8f8a719b830ffb7d/notebook/Get%20Started%20Quickly.ipynb)): A comprehensive guide to indexing your data and running basic queries.
([Local Search Notebook.ipynb:](https://github.com/Qredence/GraphFleet/blob/a67eaeb295d99dd2ef48bcdd8f8a719b830ffb7d/notebook/Local%20Search%20Notebook.ipynb)) Demonstrates local search techniques.
([Global Search Notebook](https://github.com/Qredence/GraphFleet/blob/a67eaeb295d99dd2ef48bcdd8f8a719b830ffb7d/notebook/Global%20Search%20Notebook.ipynb))
### Running the API only (or run CLI commands for local search or global search)
To run the API, save the code in a file named api.py and execute the following command in your terminal:
``` bash
uvicorn app:main --reload --port 8001
```
### Run the CLI commands to query the graph (Follow the get-started-graphfleet.ipynb notebook)
``` bash
! python -m graphrag.query \
--root ./graphfleet \
--method global \
--streaming \ #stream the response
"Language Agent Tree Search?"
```
``` bash
! python -m graphrag.query \
--root ./graphfleet \
--method global \
--streaming \ #stream the response
"What are the key features of GraphRAG ??"
```
### Running Streamlit
To run the API, save the code in a file named api.py and execute the following command in your terminal:
``` bash
streamlit run app/streamlit_app.py
```
## Security
For details about our security policy, please see [Security](SECURITY.md) or [Security](docs/SECURITY.md).
## License
This project is licensed under the Apache License 2.0. For the full license text, please see [License](LICENSE) or [License](docs/LICENSE).
## Star History
[](https://star-history.com/#Qredence/GraphFleet&Date)
# Security Policy
## Supported Versions
Use this section to tell people about which versions of your project are
currently being supported with security updates.
| Version | Supported |
| ------- | ------------------ |
| 5.1.x | :white_check_mark: |
| 5.0.x | :x: |
| 4.0.x | :white_check_mark: |
| < 4.0 | :x: |
## Reporting a Vulnerability
Use this section to tell people how to report a vulnerability.
Tell them where to go, how often they can expect to get an update on a
reported vulnerability, what to expect if the vulnerability is accepted or
declined, etc.
# Contributing to GraphFleet
First off, thank you for considering contributing to GraphFleet! It's people like you that make GraphFleet such a great tool.
## Code of Conduct
By participating in this project, you are expected to uphold our [Code of Conduct](CODE_OF_CONDUCT.md).
## How Can I Contribute?
### Reporting Bugs
This section guides you through submitting a bug report for GraphFleet. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.
- Use a clear and descriptive title for the issue to identify the problem.
- Describe the exact steps which reproduce the problem in as many details as possible.
- Provide specific examples to demonstrate the steps.
### Suggesting Enhancements
This section guides you through submitting an enhancement suggestion for GraphFleet, including completely new features and minor improvements to existing functionality.
- Use a clear and descriptive title for the issue to identify the suggestion.
- Provide a step-by-step description of the suggested enhancement in as many details as possible.
- Provide specific examples to demonstrate the steps.
### Pull Requests
The process described here has several goals:
- Maintain GraphFleet's quality
- Fix problems that are important to users
- Engage the community in working toward the best possible GraphFleet
- Enable a sustainable system for GraphFleet's maintainers to review contributions
Please follow these steps to have your contribution considered by the maintainers:
1. After you submit your pull request, verify that all [status checks](https://help.github.com/articles/about-status-checks/) are passing
## Styleguides
### Git Commit Messages
- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
- Limit the first line to 72 characters or less
- Reference issues and pull requests liberally after the first line
### Python Styleguide
All Python code must adhere to the [PEP 8 style guide](https://www.python.org/dev/peps/pep-0008/).
### Documentation Styleguide
- Use [Markdown](https://daringfireball.net/projects/markdown/) for documentation.
- Reference functions and classes in backticks.
## Additional Notes
### Issue and Pull Request Labels
This section lists the labels we use to help us track and manage issues and pull requests.
* `bug` - Issues for bugs in the codebase.
* `enhancement` - Issues for new features or improvements.
* `documentation` - Issues related to documentation.
* `help-wanted` - Issues where we need help from the community.
## Thank You!
Your contributions to open source, large or small, make projects like this possible. Thank you for taking the time to contribute.
Raw data
{
"_id": null,
"home_page": "https://github.com/Qredence/GraphFleet",
"name": "graphfleet",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.11.2",
"maintainer_email": null,
"keywords": "knowledge, graph, rag, agentic, agent",
"author": "Zachary",
"author_email": "zachary@qredence.ai",
"download_url": "https://files.pythonhosted.org/packages/eb/03/1ecc888aa967f67e77cac5d0f5dcaf488c0901b334a14ec8de06e3ad4f7f/graphfleet-0.5.40.tar.gz",
"platform": null,
"description": "# Overview\n\n<div align=\"left\">\n<a href=\"https://pypi.org/project/graphfleet/\">\n <img alt=\"Pepy Total Downlods\" src=\"https://img.shields.io/pepy/dt/graphfleet\">\n </a>\n <img alt=\"GitHub License\" src=\"https://img.shields.io/github/license/qredence/graphfleet\">\n <img alt=\"GitHub forks\" src=\"https://img.shields.io/github/forks/qredence/graphfleet\">\n <img alt=\"GitHub Repo stars\" src=\"https://img.shields.io/github/stars/qredence/graphfleet\">\n\n</div>\n\n\nhttps://github.com/user-attachments/assets/ac3271fa-cab5-412f-a441-bbedfe4a009f\n\n\n\nGraphFleet is an advanced implementation of [GraphRAG from Microsoft](https://github.com/microsoft/graphrag), designed to enhance large language models' ability to reason about complex information and private datasets. It builds upon GraphRAG (Retrieval Augmented Generation using Graph structures) and will gradually adopt its own path to fulfill our roadmap at Qredence.\n\n## GraphFleet\n\nGraphFleet uses knowledge graphs to provide substantial improvements in question-and-answer performance when reasoning about complex information. It addresses limitations of traditional RAG approaches:\n\n## Roadmap\n\n- [ ] Provide a FleetUI Design Kit and a quicker way of starting GraphFleet locally.\n- [ ] Provide a Toddle interface ready to use for GraphFleet\n- [ ] Add integrations of Composio\n- [ ] Add integrations of LangSmith\n- [ ] Add few selfhosting one click deploy solutions.\n- [ ] Access GraphFleet through a secure and enterprise-ready Azure Cloud hosting version.\n- [ ] And way more... \ud83d\udc40\n\n## Key Features\n\n- Structured, hierarchical approach to Retrieval Augmented Generation.\n- Knowledge graph extraction from raw text.\n- Community hierarchy building.\n- Hierarchical summarization.\n- Enhanced reasoning capabilities for LLMs on private datasets.\n\n## Contribute\n\n- Leave us a star \u2665\n- Fork and contribute to the project\n- <a href=\"https://discord.gg/BD8MPgzEJc\">\n <img alt=\"Discord\" src=\"https://img.shields.io/discord/1053300403149733969?style=for-the-badge&logo=discord\">\n </a>\n <img alt=\"X (formerly Twitter) Follow\" src=\"https://img.shields.io/twitter/follow/agenticfleet?style=for-the-badge&logo=x&logoColor=white&labelColor=blue&link=https%3A%2F%2Fx.com%2Fagenticfleet\">\n\n## Getting Started\n\n### Prerequisites\n\n- Python 3.11\n\n- Poetry\n- Make sure to have a virtual environment manager such as `virtualenv` installed\n\n### Installation\n\n1. Clone the repository:\n\n ```bash\n git clone https://github.com/Qredence/GraphFleet.git\n cd GraphFleet\n ```\n\n2. Install the dependencies:\n\n ```bash\n poetry shell\n poetry install\n ```\n\n### Usage\n\n1. Configuration:\nEnvironment Variables: Set up your environment variables in a .env file (refer to the .env.example file for available options). Key variables include:\n\nFill in the .env file in the root folder and the one in the graphfleet folder.\n\n ```sh\nexport GRAPHRAG_API_KEY=\"your_api_key_here\"\nexport GRAPHRAG_API_BASE=\"<https://your-azure-openai-resource.openai.azure.com/>\"\nexport GRAPHRAG_API_VERSION=\"\"\nexport GRAPHRAG_DEPLOYMENT_NAME=\"your_deployment_name\"\nexport GRAPHRAG_API_TYPE=\"azure_openai\"\nexport GRAPHRAG_EMBEDDING_MODEL=\"text-embedding-ada-002\"\nexport GRAPHRAG_LLM_MODEL=\"gpt-4\"\nexport GRAPHRAG_DATA_PATH=\"./your_data_directory\"\nexport GRAPHRAG_EMBEDDING_TYPE=\"azure_openai_embedding\"\nexport GRAPHRAG_EMBEDDING_KEY=\"your_embedding_key_here\"\nexport GRAPHRAG_EMBEDDING_ENDPOINT=\"<https://your-azure-openai-embedding-resource.openai.azure.com/>\"\nexport GRAPHRAG_EMBEDDING_DEPLOYMENT_NAME=\"your_embedding_deployment_name\"\n\n```\n\n settings.yaml: Customize GraphFleet's behavior further by modifying the settings.yaml file within the graphfleet directory.\n\n1. Data Indexing:\nJupyter 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.\n\n1. Interacting with GraphFleet:\nJupyter Notebooks: Explore GraphFleet's capabilities with the provided notebooks:\n\n get-started-graphfleet.ipynb: A comprehensive guide to indexing your data and running basic queries.\n\n Local Search Notebook.ipynb: Demonstrates local search techniques.\n\n app.py (FastAPI Application): Run a Streamlit-powered web interface to interact with GraphFleet using a user-friendly chat-like interface.\n\n### Add your text files in ./graphfleet/input/ and run the auto_prompt function\n\n``` bash\n!python -m graphrag.prompt_tune \\\n --config ./graphfleet/settings.yaml \\\n --root ./graphfleet \\\n --no-entity-types \\\n --output ./graphfleet/prompts\n```\n\n\n\n### Data Indexing:\n\nJupyter 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.\n\n``` bash\n! python -m graphrag.index \\\n --verbose \\\n --root ./graphfleet \\\n --config ./graphfleet/settings.yaml\n```\n\n\n## IMPORTANT : Run these notebook to get started with GraphFleet:\nJupyter Notebooks: Explore GraphFleet's capabilities with the provided notebooks:\n\n([Get Started Quickly.ipynb](https://github.com/Qredence/GraphFleet/blob/a67eaeb295d99dd2ef48bcdd8f8a719b830ffb7d/notebook/Get%20Started%20Quickly.ipynb)): A comprehensive guide to indexing your data and running basic queries.\n([Local Search Notebook.ipynb:](https://github.com/Qredence/GraphFleet/blob/a67eaeb295d99dd2ef48bcdd8f8a719b830ffb7d/notebook/Local%20Search%20Notebook.ipynb)) Demonstrates local search techniques.\n\n([Global Search Notebook](https://github.com/Qredence/GraphFleet/blob/a67eaeb295d99dd2ef48bcdd8f8a719b830ffb7d/notebook/Global%20Search%20Notebook.ipynb))\n\n\n### Running the API only (or run CLI commands for local search or global search)\n\nTo run the API, save the code in a file named api.py and execute the following command in your terminal:\n\n``` bash\nuvicorn app:main --reload --port 8001 \n```\n\n### Run the CLI commands to query the graph (Follow the get-started-graphfleet.ipynb notebook)\n\n``` bash\n! python -m graphrag.query \\\n--root ./graphfleet \\\n--method global \\\n--streaming \\ #stream the response\n\"Language Agent Tree Search?\"\n```\n\n``` bash\n! python -m graphrag.query \\\n--root ./graphfleet \\\n--method global \\\n--streaming \\ #stream the response\n\"What are the key features of GraphRAG ??\"\n```\n\n### Running Streamlit\n\nTo run the API, save the code in a file named api.py and execute the following command in your terminal:\n\n``` bash\nstreamlit run app/streamlit_app.py\n```\n\n## Security\n\nFor details about our security policy, please see [Security](SECURITY.md) or [Security](docs/SECURITY.md).\n\n## License\n\nThis project is licensed under the Apache License 2.0. For the full license text, please see [License](LICENSE) or [License](docs/LICENSE).\n\n## Star History\n\n[](https://star-history.com/#Qredence/GraphFleet&Date)\n\n# Security Policy\n\n## Supported Versions\n\nUse this section to tell people about which versions of your project are\ncurrently being supported with security updates.\n\n| Version | Supported |\n| ------- | ------------------ |\n| 5.1.x | :white_check_mark: |\n| 5.0.x | :x: |\n| 4.0.x | :white_check_mark: |\n| < 4.0 | :x: |\n\n## Reporting a Vulnerability\n\nUse this section to tell people how to report a vulnerability.\n\nTell them where to go, how often they can expect to get an update on a\nreported vulnerability, what to expect if the vulnerability is accepted or\ndeclined, etc.\n\n# Contributing to GraphFleet\n\nFirst off, thank you for considering contributing to GraphFleet! It's people like you that make GraphFleet such a great tool.\n\n## Code of Conduct\n\nBy participating in this project, you are expected to uphold our [Code of Conduct](CODE_OF_CONDUCT.md).\n\n## How Can I Contribute?\n\n### Reporting Bugs\n\nThis section guides you through submitting a bug report for GraphFleet. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.\n\n- Use a clear and descriptive title for the issue to identify the problem.\n- Describe the exact steps which reproduce the problem in as many details as possible.\n- Provide specific examples to demonstrate the steps.\n\n### Suggesting Enhancements\n\nThis section guides you through submitting an enhancement suggestion for GraphFleet, including completely new features and minor improvements to existing functionality.\n\n- Use a clear and descriptive title for the issue to identify the suggestion.\n- Provide a step-by-step description of the suggested enhancement in as many details as possible.\n- Provide specific examples to demonstrate the steps.\n\n\n\n### Pull Requests\n\nThe process described here has several goals:\n\n- Maintain GraphFleet's quality\n- Fix problems that are important to users\n- Engage the community in working toward the best possible GraphFleet\n- Enable a sustainable system for GraphFleet's maintainers to review contributions\n\nPlease follow these steps to have your contribution considered by the maintainers:\n\n1. After you submit your pull request, verify that all [status checks](https://help.github.com/articles/about-status-checks/) are passing\n\n## Styleguides\n\n### Git Commit Messages\n\n- Use the present tense (\"Add feature\" not \"Added feature\")\n- Use the imperative mood (\"Move cursor to...\" not \"Moves cursor to...\")\n- Limit the first line to 72 characters or less\n- Reference issues and pull requests liberally after the first line\n\n### Python Styleguide\n\nAll Python code must adhere to the [PEP 8 style guide](https://www.python.org/dev/peps/pep-0008/).\n\n### Documentation Styleguide\n\n- Use [Markdown](https://daringfireball.net/projects/markdown/) for documentation.\n- Reference functions and classes in backticks.\n\n## Additional Notes\n\n### Issue and Pull Request Labels\n\nThis section lists the labels we use to help us track and manage issues and pull requests.\n\n* `bug` - Issues for bugs in the codebase.\n* `enhancement` - Issues for new features or improvements.\n* `documentation` - Issues related to documentation.\n* `help-wanted` - Issues where we need help from the community.\n\n## Thank You!\n\nYour contributions to open source, large or small, make projects like this possible. Thank you for taking the time to contribute.\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Advanced implementation of GraphRAG for enhanced LLM reasoning",
"version": "0.5.40",
"project_urls": {
"Homepage": "https://github.com/Qredence/GraphFleet",
"Repository": "https://github.com/Qredence/GraphFleet"
},
"split_keywords": [
"knowledge",
" graph",
" rag",
" agentic",
" agent"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6da4e5de13b3702c4b05d9ae9bb9c95a7b3bdcab743004a4ab18e2d380b2a122",
"md5": "5e39a6f6945adc3bddcc76afcda1a326",
"sha256": "1a7f64e29cbc61b81969f837895d3de41298e7f8972dfb699b43cf04cda3b9bf"
},
"downloads": -1,
"filename": "graphfleet-0.5.40-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5e39a6f6945adc3bddcc76afcda1a326",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.11.2",
"size": 102035833,
"upload_time": "2024-09-01T04:16:23",
"upload_time_iso_8601": "2024-09-01T04:16:23.182043Z",
"url": "https://files.pythonhosted.org/packages/6d/a4/e5de13b3702c4b05d9ae9bb9c95a7b3bdcab743004a4ab18e2d380b2a122/graphfleet-0.5.40-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "eb031ecc888aa967f67e77cac5d0f5dcaf488c0901b334a14ec8de06e3ad4f7f",
"md5": "e748e5501a98b543051c5e911331c472",
"sha256": "f929883601dc01fdc5ef3152fd07f1f530663b31f10e23c2f2493fd5846cae00"
},
"downloads": -1,
"filename": "graphfleet-0.5.40.tar.gz",
"has_sig": false,
"md5_digest": "e748e5501a98b543051c5e911331c472",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.11.2",
"size": 101978887,
"upload_time": "2024-09-01T04:16:31",
"upload_time_iso_8601": "2024-09-01T04:16:31.738147Z",
"url": "https://files.pythonhosted.org/packages/eb/03/1ecc888aa967f67e77cac5d0f5dcaf488c0901b334a14ec8de06e3ad4f7f/graphfleet-0.5.40.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-01 04:16:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Qredence",
"github_project": "GraphFleet",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "graphfleet"
}
JSON
