Skip to content

Commit 9278a6d

Browse files
committed
update README.md
1 parent 3953a91 commit 9278a6d

1 file changed

Lines changed: 62 additions & 0 deletions

File tree

README.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -202,6 +202,61 @@ python incremental_pipeline.py --validate
202202
python incremental_pipeline.py --cleanup
203203
```
204204

205+
#### Summary Generation
206+
Generate executive summaries for regulatory documents:
207+
208+
```bash
209+
cd app/core
210+
211+
# Generate summary for a single file
212+
python incremental_summary.py --files "2024_MPFS_final_2023-24184.xml"
213+
214+
# Generate summaries for multiple files
215+
python incremental_summary.py --files "2024_MPFS_final_2023-24184.xml" "2023_HOSPICE_final_2022-16457.xml"
216+
217+
# Force regenerate existing summaries
218+
python incremental_summary.py --files "2024_MPFS_final_2023-24184.xml" --force
219+
220+
# Process all files without summaries (incremental)
221+
python incremental_summary.py --incremental
222+
```
223+
224+
#### MPFS-Specific Summary Generation
225+
Generate summaries for MPFS documents only:
226+
227+
```bash
228+
cd app/core
229+
230+
# Check MPFS summary status
231+
python mpfs_summary_generator.py --status
232+
233+
# Generate summaries for all MPFS files (incremental)
234+
python mpfs_summary_generator.py --incremental
235+
236+
# Generate summaries for specific MPFS files
237+
python mpfs_summary_generator.py --files "2024_MPFS_final_2023-24184.xml" "2023_MPFS_final_2022-23873.xml"
238+
239+
# Force regenerate all MPFS summaries
240+
python mpfs_summary_generator.py --incremental --force
241+
```
242+
243+
**API Usage:**
244+
```bash
245+
# Get available summaries
246+
curl -X GET http://localhost:8080/api/available-summaries
247+
248+
# Get specific summary
249+
curl -X POST http://localhost:8080/api/get-summary \
250+
-H 'Content-Type: application/json' \
251+
-d '{"doc_name": "2024_MPFS_final_2023-24184"}'
252+
```
253+
254+
**Frontend Usage:**
255+
- Navigate to the **Summary** tab in the web interface
256+
- Browse available summaries by program type and year
257+
- Click on any document to view its detailed summary
258+
- Download or copy summary content as needed
259+
205260
#### Scheduled Updates
206261
For production environments, automated scheduled updates:
207262
```bash
@@ -217,6 +272,12 @@ Regulations are automatically organized by program type:
217272

218273
Each file follows the naming convention: `YYYY_PROGRAM_TYPE_DOC_TYPE_DOC_NUMBER.xml`
219274

275+
### Summary Files Organization
276+
Generated summaries are stored in the `summary_outputs/` directory:
277+
- **Markdown files**: `YYYY_PROGRAM_TYPE_DOC_TYPE_DOC_NUMBER.md` - Human-readable summaries
278+
- **JSON files**: `YYYY_PROGRAM_TYPE_DOC_TYPE_DOC_NUMBER.json` - Structured data for processing
279+
- **Batch cache**: `batch_cache/YYYY_PROGRAM_TYPE_DOC_TYPE_DOC_NUMBER/` - Cached batch results for cost optimization
280+
220281
---
221282

222283
## 🚀 Frontend Setup
@@ -258,6 +319,7 @@ Each file follows the naming convention: `YYYY_PROGRAM_TYPE_DOC_TYPE_DOC_NUMBER.
258319
- **[Chat Filter Implementation](docs/CHAT_FILTER_IMPLEMENTATION.md)**: Implementation of document filtering in chat, including backend, search, and frontend integration.
259320
- **[Summary Implementation](docs/summary_implement.md)**: Summary generation pipeline, incremental summary processing, and frontend-backend coordination.
260321
- **[Federal Register Integration](docs/federal_register.md)**: Details on fetching, classifying, and organizing regulations from the Federal Register API.
322+
- **[Processing Flow Diagram](docs/processing_flow_diagram.md)**: Complete visual flow of download, chunking, embedding, and summary generation processes.
261323

262324
### Deployment & Operations
263325
- **[Local Backend + GitHub Pages Setup](docs/local_backend_github_pages_setup.md)**: Step-by-step deployment guide using ngrok and GitHub Pages.

0 commit comments

Comments
 (0)