Your First Timeline - Complete Walkthrough¶
A comprehensive step-by-step guide to creating, validating, and customizing your first timeline in ChronoScope.
Overview¶
This tutorial covers the complete timeline creation workflow:
- Document preparation
- Upload and processing
- Reviewing extracted events
- Quality validation
- Customization and filtering
- Adding personal insights
- Export options
Time Required: 15-20 minutes
Phase 1: Preparing Your Document¶
What Makes a Good Source Document?¶
ChronoScope works best with documents that have:
✅ Clear Dates
✅ Structured Information
✓ Good: Resume with sections (Experience, Education)
✗ Poor: Unstructured narrative without headings
✅ Specific Details
✓ Good: "Senior Developer at TechCorp, San Francisco"
✗ Poor: "Worked at a company doing tech stuff"
Recommended Document Types¶
Why it works well:
- Chronological structure
- Clear date ranges
- Explicit positions and locations
- Education and certifications
Example sections:
Why it works:
- Career narrative with timeline
- Specific achievements with dates
- Clear transitions and milestones
Example content:
Why it works:
- Academic/professional journey
- Research projects with timeframes
- Publications and presentations
Can work if:
- Contains explicit dates
- Has clear event descriptions
- Structured paragraphs
May struggle with:
- Vague timeframes
- Implicit connections
- Stream-of-consciousness writing
Document Checklist¶
Before uploading, ensure your document has:
- Clear dates (month/year or specific dates)
- Event titles or descriptions
- Locations (if applicable)
- Structured format (headings, bullets, sections)
- Readable text (not scanned images)
- Supported format (PDF, TXT, DOCX)
Phase 2: Upload and Processing¶
Step 1: Access Upload Tab¶
- Launch ChronoScope:
streamlit run timeline-mvp-pipeline.py - Navigate to "📤 Upload & Process" tab
- Ensure you see the file uploader
Step 2: Configure Processing (Optional)¶
For most users, default settings work well. Advanced users can:
Advanced Processing Settings
Access Advanced Settings:
- Look for "⚙️ Advanced Settings" toggle in sidebar
- Enable to see expert options
Available options:
-
AI Model Selection
gpt-3.5-turbo(default) - Fast, cost-effectivegpt-4- Higher accuracy, slower, more expensive
-
Temperature (0.0 - 1.0)
0.3(default) - Consistent, factual extraction- Higher values - More creative interpretation
-
Max Tokens
2000(default) - Suitable for most documents- Increase for very long documents
Step 3: Upload Document¶
Method 1: Drag and Drop
┌────────────────────────────┐
│ Drop file here │
│ │
│ or click to browse │
└────────────────────────────┘
Method 2: File Browser
- Click "Browse files"
- Navigate to your document
- Select and click "Open"
Step 4: Initiate Processing¶
- Verify file is uploaded (you'll see filename)
- Click "🚀 Process Documents"
- Watch progress indicator
Processing Steps:
📄 Reading document...
🔍 Detecting document type... (Resume detected)
🤖 Extracting events with AI...
✅ Processing complete!
Timing:
- Short resume (1-2 pages): 5-10 seconds
- Long CV (10+ pages): 20-30 seconds
- Multiple documents: ~10s per document
Phase 3: Reviewing Extracted Events¶
Understanding Event Structure¶
Navigate to "📈 Timeline" tab. Each event contains:
| Field | Description | Example |
|---|---|---|
| Title | Event name | "Senior Developer at TechCorp" |
| Start Date | Beginning date | 2020-01-15 |
| End Date | Ending date (if applicable) | 2023-03-20 |
| Description | Details | "Led team of 5, built ML pipeline" |
| Location | Place | "San Francisco, CA" |
| Tags | Categories | work, engineering, leadership |
| People | Associated individuals | John Smith, Jane Doe |
| Priority | Importance (1-10) | 8 |
| Confidence | AI certainty (0-1) | 0.85 |
| Source | Origin document | resume_2023.pdf |
Event Display Table¶
The timeline tab shows events in a sortable table:
┌─────────────────────────────────────────────────────────────────┐
│ Title | Start Date | End Date | Confidence │
├─────────────────────────────────────────────────────────────────┤
│ Senior Developer │ 2020-01-15 │ 2023-03-20 │ 85% │
│ BS Computer Sci │ 2016-09-01 │ 2020-05-15 │ 92% │
│ AWS Certification │ 2021-06-10 │ - │ 78% │
└─────────────────────────────────────────────────────────────────┘
Quick Actions¶
- 🔍 Hover - See full details in tooltip
- 📋 Sort - Click column headers
- ✏️ Edit - Inline editing (select cell)
- 🗑️ Delete - Click X icon
- 📥 Export - Download as CSV/JSON
Phase 4: Quality Validation¶
Running Validation¶
- Navigate to "✅ Validation" tab
- Click "Run Validation" button
- Review metrics dashboard
Understanding Metrics¶
Precision (Accuracy)
- How many extracted events are correct?
- High (>80%): Excellent accuracy
- Medium (60-80%): Good, few errors
- Low (<60%): Many incorrect events
Recall (Completeness)
- How many real events were captured?
- High (>80%): Comprehensive extraction
- Medium (60-80%): Missing some events
- Low (<60%): Many events missed
F1-Score (Overall Quality)
- Balanced measure of quality
- 80%+: Excellent
- 60-80%: Acceptable
- <60%: Needs improvement
Validation Results Example¶
┌──────────────────────────────────────┐
│ Quality Metrics │
├──────────────────────────────────────┤
│ Precision: 78.5% │
│ Recall: 65.2% │
│ F1-Score: 71.2% │
│ │
│ Events Extracted: 14 │
│ Gold Standard: 28 │
│ Matched Events: 11 │
│ Missing Events: 17 │
│ Extra Events: 3 │
└──────────────────────────────────────┘
Improving Quality¶
If validation scores are low:
1. Check Source Document - Are dates explicit and clear? - Is information structured? - Try reformatting for clarity
2. Adjust AI Settings
# Try GPT-4 for better accuracy
Model: gpt-4
Temperature: 0.2 (more deterministic)
Max Tokens: 3000 (for longer docs)
3. Manual Review - Check low-confidence events - Verify dates against source - Add missing events manually
Phase 5: Customization and Filtering¶
Applying Filters¶
Sidebar Filter Options:
Filter events by timeframe:
Use cases: - Focus on recent career - Examine specific period - Exclude old events
Filter by category:
Use cases: - Show only work history - Academic timeline - Professional development
Filter by AI certainty:
Use cases: - Show high-quality events only - Review uncertain extractions - Quality assurance
Visualization Options¶
Timeline Chart
- Gantt-style chronological view
- Color-coded by event type
- Interactive hover tooltips
Priority Matrix
- Scatter plot: Confidence vs Priority
- Identify high-value events
- Spot low-confidence, high-priority items
Distribution Chart
- Events over time histogram
- Identify busy periods
- Visualize career density
Phase 6: Adding Personal Insights¶
Using the Notes Feature¶
Scroll below the tabs to find "📝 User Notes":
Creating a Note:
- Enter note name (e.g., "Career Reflections")
- Type your thoughts in text area
- Click "💾 Save Note"
Example Uses:
# Career Insights (2020-2023)
## Key Learnings
- Leadership skills grew significantly at TechCorp
- AWS certification opened new opportunities
- Remote work transition in 2020 was challenging but valuable
## Future Goals
- Pursue management track
- Complete advanced ML certification
- Contribute to open source
## Patterns Noticed
- Major role changes every ~2 years
- Education/certification precedes promotions
- Location changes correlate with career growth
Note Features:
- ✍️ Rich text editing
- 💾 Persistent storage (survives sessions)
- 📊 Character count tracking
- 🕒 Last modified timestamp
- 🗑️ Delete with confirmation
Phase 7: Export Options¶
Available Export Formats¶
Use for:
- Presentations
- Social media
- Visual portfolios
Use for:
- Excel analysis
- Data backup
- Integration with tools
=== "PDF Report" (Coming Soon) Will include:
- Timeline visualization
- Event summary table
- Validation metrics
- Notes and insights
Best Practices¶
Do's ✅¶
- Start with clean, structured documents
- Review confidence scores - Focus on >70%
- Run validation regularly after adding documents
- Use filters to focus analysis
- Save notes to capture insights
- Export backups of your timeline data
Don'ts ❌¶
- Don't upload scanned images (use OCR first)
- Don't ignore low confidence events (review them)
- Don't process all documents at once (start small)
- Don't forget to save notes before closing
- Don't share API keys (keep .streamlit/secrets.toml private)
Next Steps¶
🎉 Congratulations! You've created a comprehensive timeline!
Continue Your Journey:¶
- 📤 Upload Best Practices - Optimize extraction
- 📊 Visualization Deep Dive - Advanced charting
- 🔧 Advanced Features - Power user guide
- 🐛 Troubleshooting - Common problems
Community Resources:¶
You're Now a ChronoScope User!
You have all the knowledge needed to create professional timelines. Happy timeline building! 🚀