Skip to content

Convert any text to a graph of knowledge. This can be used for Graph Augmented Generation or Knowledge Graph based QnA

HTML

Update README.md

Matt Bernier116a1eabb7dc
diff --git a/README.md b/README.md
index 5830ca4..8de403d 100644
--- a/README.md
+++ b/README.md
@@ -56,6 +56,44 @@ Additional it also calculates the Degree of each node, and Communities of nodes,
**[Here is a Medium article explaining the method in detail ](https://medium.com/towards-data-science/how-to-convert-any-text-into-a-graph-of-concepts-110844f22a1a)**
+---
+## Installing Locally
+
+### Prerequisites
+- Python 3.11 or higher
+- Poetry (recommended) or pip
+
+### Using Poetry (Recommended)
+1. Clone the repository:
+ ```bash
+ git clone https://github.com/rahulnyk/knowledge_graph.git
+ cd knowledge_graph
+ ```
+
+2. Install dependencies and the package:
+ ```bash
+ poetry install
+ ```
+
+### Using pip
+1. Clone the repository:
+ ```bash
+ git clone https://github.com/rahulnyk/knowledge_graph.git
+ cd knowledge_graph
+ ```
+
+2. Install in editable mode:
+ ```bash
+ pip install -e .
+ ```
+
+### Verifying Installation
+After installation, you can verify everything is working by running the tests:
+```bash
+poetry run pytest
+# or if using pip:
+pytest
+```
---
## Tech Stack