Spaces:
Build error
Build error
fix installation instructions
Browse files
README.md
CHANGED
@@ -20,9 +20,9 @@ Planning AI is a sophisticated tool designed to process and analyze responses to
|
|
20 |
To set up the project, ensure you have Python 3.8 or higher installed. Then, clone the repository and install the required dependencies:
|
21 |
|
22 |
```bash
|
23 |
-
git clone
|
24 |
cd planning_ai
|
25 |
-
pip install
|
26 |
```
|
27 |
|
28 |
## Usage
|
@@ -34,7 +34,7 @@ pip install -r requirements.txt
|
|
34 |
python planning_ai/preprocessing/web_comments.py
|
35 |
```
|
36 |
|
37 |
-
2. **Run
|
38 |
```bash
|
39 |
python planning_ai/main.py
|
40 |
```
|
@@ -44,7 +44,7 @@ pip install -r requirements.txt
|
|
44 |
1. **Data Loading**: Documents are loaded from the staging directory using the `DirectoryLoader`.
|
45 |
2. **Text Splitting**: Documents are split into manageable chunks using `CharacterTextSplitter`.
|
46 |
3. **Graph Processing**: The `StateGraph` orchestrates the flow of data through various nodes, including mapping and reducing summaries.
|
47 |
-
4. **
|
48 |
5. **Output**: Final summaries and thematic breakdowns are printed and can be exported for further analysis.
|
49 |
|
50 |
## Configuration
|
|
|
20 |
To set up the project, ensure you have Python 3.8 or higher installed. Then, clone the repository and install the required dependencies:
|
21 |
|
22 |
```bash
|
23 |
+
git clone https://github.com/cjber/planning-ai.git
|
24 |
cd planning_ai
|
25 |
+
pip install . (or uv sync)
|
26 |
```
|
27 |
|
28 |
## Usage
|
|
|
34 |
python planning_ai/preprocessing/web_comments.py
|
35 |
```
|
36 |
|
37 |
+
2. **Run Graph**: Execute the main script to process the documents and generate a Quarto summary document.
|
38 |
```bash
|
39 |
python planning_ai/main.py
|
40 |
```
|
|
|
44 |
1. **Data Loading**: Documents are loaded from the staging directory using the `DirectoryLoader`.
|
45 |
2. **Text Splitting**: Documents are split into manageable chunks using `CharacterTextSplitter`.
|
46 |
3. **Graph Processing**: The `StateGraph` orchestrates the flow of data through various nodes, including mapping and reducing summaries.
|
47 |
+
4. **Summarisation**: The `map_chain` and `reduce_chain` are used to generate and refine summaries.
|
48 |
5. **Output**: Final summaries and thematic breakdowns are printed and can be exported for further analysis.
|
49 |
|
50 |
## Configuration
|