Spaces:
Build error
Build error
docs: add more info for running locally
Browse files
README.md
CHANGED
@@ -81,17 +81,21 @@ This project uses **Streamlit** to provide a simple frontend to the system. Run
|
|
81 |
|
82 |
`streamlit run app.py`
|
83 |
|
|
|
|
|
|
|
|
|
84 |
Alternatively run everything manually:
|
85 |
|
86 |
1. **Preprocessing**: Run the preprocessing scripts to convert raw data into a format suitable for analysis.
|
87 |
```bash
|
88 |
-
python planning_ai
|
89 |
-
python planning_ai
|
90 |
```
|
91 |
|
92 |
2. **Run Graph**: Execute the main script to process the documents and generate Summary documents.
|
93 |
```bash
|
94 |
-
python planning_ai
|
95 |
```
|
96 |
|
97 |
## Configuration
|
@@ -101,6 +105,12 @@ Alternatively run everything manually:
|
|
101 |
- `AZURE_API_KEY` and `AZURE_API_ENDPOINT` needed to process `.pdfs`
|
102 |
- **Constants**: Adjust `Consts` in `planning_ai/common/utils.py` to modify token limits and other settings.
|
103 |
- The document output format may be altered using files in `planning_ai/document`
|
|
|
|
|
|
|
|
|
|
|
|
|
104 |
|
105 |
## Workflow
|
106 |
|
|
|
81 |
|
82 |
`streamlit run app.py`
|
83 |
|
84 |
+
The project is hosted on HuggingFace Spaces, to push new updates you must run:
|
85 |
+
|
86 |
+
`git push hf main`
|
87 |
+
|
88 |
Alternatively run everything manually:
|
89 |
|
90 |
1. **Preprocessing**: Run the preprocessing scripts to convert raw data into a format suitable for analysis.
|
91 |
```bash
|
92 |
+
python -m planning_ai.preprocessing.gcpt3
|
93 |
+
python -m planning_ai.preprocessing.azure_doc
|
94 |
```
|
95 |
|
96 |
2. **Run Graph**: Execute the main script to process the documents and generate Summary documents.
|
97 |
```bash
|
98 |
+
python -m planning_ai.main
|
99 |
```
|
100 |
|
101 |
## Configuration
|
|
|
105 |
- `AZURE_API_KEY` and `AZURE_API_ENDPOINT` needed to process `.pdfs`
|
106 |
- **Constants**: Adjust `Consts` in `planning_ai/common/utils.py` to modify token limits and other settings.
|
107 |
- The document output format may be altered using files in `planning_ai/document`
|
108 |
+
- There are several dependencies that are required to run this project locally:
|
109 |
+
- texlive-latex-extra
|
110 |
+
- texlive-fonts-extra
|
111 |
+
- cm-super
|
112 |
+
- dvipng
|
113 |
+
- pandoc
|
114 |
|
115 |
## Workflow
|
116 |
|