Spaces:
Sleeping
Sleeping
ambrosfitz
commited on
Commit
•
7e56b0a
1
Parent(s):
7361754
Update README.md
Browse files
README.md
CHANGED
@@ -9,4 +9,63 @@ app_file: app.py
|
|
9 |
pinned: false
|
10 |
---
|
11 |
|
12 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
9 |
pinned: false
|
10 |
---
|
11 |
|
12 |
+
# Historical Context Mapper
|
13 |
+
|
14 |
+
This Gradio app generates network visualizations showing the historical context and connections for terms from Unit 5 (1844-1877) of U.S. History.
|
15 |
+
|
16 |
+
## Features
|
17 |
+
|
18 |
+
- Interactive text input for historical terms
|
19 |
+
- Network visualization of related concepts
|
20 |
+
- Color-coded categories for different types of historical elements
|
21 |
+
- Context-based relationship mapping
|
22 |
+
- Dark theme visualization for better readability
|
23 |
+
|
24 |
+
## Setup
|
25 |
+
|
26 |
+
1. Install the required packages:
|
27 |
+
```bash
|
28 |
+
pip install -r requirements.txt
|
29 |
+
python -m spacy download en_core_web_sm
|
30 |
+
```
|
31 |
+
|
32 |
+
2. Ensure the Unit5_OCR.txt file is in the same directory as app.py
|
33 |
+
|
34 |
+
3. Run the app:
|
35 |
+
```bash
|
36 |
+
python app.py
|
37 |
+
```
|
38 |
+
|
39 |
+
## Usage
|
40 |
+
|
41 |
+
1. Enter a historical term from Unit 5 (1844-1877) in the text input
|
42 |
+
2. The app will generate a network visualization showing:
|
43 |
+
- Related people
|
44 |
+
- Connected events
|
45 |
+
- Relevant policies/laws
|
46 |
+
- Thematic connections
|
47 |
+
- Temporal relationships
|
48 |
+
|
49 |
+
## Categories
|
50 |
+
|
51 |
+
- Main Themes (Blue)
|
52 |
+
- Events (Green)
|
53 |
+
- People (Brown)
|
54 |
+
- Laws/Policies (Purple)
|
55 |
+
- Concepts (Dark Red)
|
56 |
+
|
57 |
+
## Deployment
|
58 |
+
|
59 |
+
This app can be deployed on Hugging Face Spaces. To deploy:
|
60 |
+
|
61 |
+
1. Create a new Space on Hugging Face
|
62 |
+
2. Upload these files:
|
63 |
+
- app.py
|
64 |
+
- requirements.txt
|
65 |
+
- Unit5_OCR.txt
|
66 |
+
- README.md
|
67 |
+
3. The app will automatically deploy and be available online
|
68 |
+
|
69 |
+
## Data Source
|
70 |
+
|
71 |
+
The historical data is sourced from Unit 5 of the AP U.S. History curriculum, covering the period 1844-1877.
|