Add schema versioning documentation to README
Browse filesAdded comprehensive documentation about the annotation schema versioning system:
- Current schema version (1.0.0) with release date
- Semantic versioning explanation (MAJOR.MINOR.PATCH)
- Schema evolution benefits (tracking, compatibility, migration)
- Complete schema coverage breakdown:
- 31 classification categories
- 10 audio defect types
- 5 content issue types
- 7 supported languages
- 5 transcription quality levels
- Updated data organization tree to include schema/ directory
- References to schema documentation files (README, CHANGELOG)
This makes the dataset's annotation methodology transparent and helps
users understand how annotations may evolve over time.
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
|
@@ -67,9 +67,12 @@ Voice-Note-Audio/
|
|
| 67 |
│ ├── uncorrected/ # AI-generated transcripts from STT
|
| 68 |
│ └── ground_truths/ # Manually corrected transcripts
|
| 69 |
├── annotations/ # JSON metadata for each recording
|
|
|
|
|
|
|
|
|
|
|
|
|
| 70 |
├── STATS.md # Auto-generated dataset statistics
|
| 71 |
-
|
| 72 |
-
└── annotation_schema_v1.json # JSON schema specification
|
| 73 |
```
|
| 74 |
|
| 75 |
Files are numbered sequentially (e.g., `1.mp3`, `1.txt`, `1.json`) for easy cross-referencing.
|
|
@@ -105,31 +108,69 @@ Study code-switching and multilingual speech patterns in authentic voice recordi
|
|
| 105 |
|
| 106 |
## Annotation Schema
|
| 107 |
|
| 108 |
-
The dataset uses a comprehensive annotation schema
|
| 109 |
-
|
| 110 |
-
|
| 111 |
-
|
| 112 |
-
|
| 113 |
-
|
| 114 |
-
|
| 115 |
-
|
| 116 |
-
-
|
| 117 |
-
-
|
| 118 |
-
|
| 119 |
-
|
| 120 |
-
|
| 121 |
-
|
| 122 |
-
-
|
| 123 |
-
-
|
| 124 |
-
|
| 125 |
-
|
| 126 |
-
|
| 127 |
-
-
|
| 128 |
-
-
|
| 129 |
-
|
| 130 |
-
|
| 131 |
-
|
| 132 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 133 |
|
| 134 |
## Recording Equipment
|
| 135 |
|
|
|
|
| 67 |
│ ├── uncorrected/ # AI-generated transcripts from STT
|
| 68 |
│ └── ground_truths/ # Manually corrected transcripts
|
| 69 |
├── annotations/ # JSON metadata for each recording
|
| 70 |
+
├── schema/ # Annotation schema (versioned)
|
| 71 |
+
│ ├── annotation_schema_v1.json # Schema definition v1.0.0
|
| 72 |
+
│ ├── README.md # Schema documentation
|
| 73 |
+
│ └── CHANGELOG.md # Version history
|
| 74 |
├── STATS.md # Auto-generated dataset statistics
|
| 75 |
+
└── README.md # This file
|
|
|
|
| 76 |
```
|
| 77 |
|
| 78 |
Files are numbered sequentially (e.g., `1.mp3`, `1.txt`, `1.json`) for easy cross-referencing.
|
|
|
|
| 108 |
|
| 109 |
## Annotation Schema
|
| 110 |
|
| 111 |
+
The dataset uses a comprehensive, versioned annotation schema to ensure consistency and enable schema evolution over time.
|
| 112 |
+
|
| 113 |
+
**Current Schema Version: 1.0.0** (Released: 2025-10-26)
|
| 114 |
+
|
| 115 |
+
### Schema Versioning
|
| 116 |
+
|
| 117 |
+
The annotation schema follows [Semantic Versioning](https://semver.org/) (MAJOR.MINOR.PATCH):
|
| 118 |
+
- **MAJOR**: Incompatible schema changes
|
| 119 |
+
- **MINOR**: Backward-compatible additions
|
| 120 |
+
- **PATCH**: Backward-compatible bug fixes
|
| 121 |
+
|
| 122 |
+
Each annotation automatically includes a `schema_version` field, enabling:
|
| 123 |
+
- Tracking which schema version was used for each annotation
|
| 124 |
+
- Backward compatibility as the schema evolves
|
| 125 |
+
- Migration paths when schema updates occur
|
| 126 |
+
- Historical analysis of annotation practices
|
| 127 |
+
|
| 128 |
+
Schema files and documentation are maintained in the `schema/` directory:
|
| 129 |
+
- `annotation_schema_v1.json` - Current schema definition
|
| 130 |
+
- `README.md` - Schema usage and documentation
|
| 131 |
+
- `CHANGELOG.md` - Version history and changes
|
| 132 |
+
|
| 133 |
+
### Schema Coverage
|
| 134 |
+
|
| 135 |
+
#### Classification (31 categories)
|
| 136 |
+
Comprehensive note type classification including:
|
| 137 |
+
- **Communication**: Email drafts, replies
|
| 138 |
+
- **Task Management**: To-do lists, reminders, shopping lists
|
| 139 |
+
- **Content Creation**: Blog posts, articles, social media, scripts, presentations
|
| 140 |
+
- **Development**: Prompts (general, development, creative), documentation, code comments, bug reports, feature requests
|
| 141 |
+
- **Personal & Professional**: Journal entries, memos, ideas, meeting notes, research notes, project planning
|
| 142 |
+
- **General**: Questions, other
|
| 143 |
+
|
| 144 |
+
#### Audio Defects (10 categories)
|
| 145 |
+
Real-world audio challenges for STT evaluation:
|
| 146 |
+
- Background noise, music, conversations
|
| 147 |
+
- Crying baby, traffic sounds
|
| 148 |
+
- Poor quality (distortion, clipping)
|
| 149 |
+
- Multiple speakers, wind noise, echo
|
| 150 |
+
- Phone ringing/notifications
|
| 151 |
+
|
| 152 |
+
#### Content Issues (5 categories)
|
| 153 |
+
Recording-level problems:
|
| 154 |
+
- Side conversations, partial content
|
| 155 |
+
- False starts, thinking aloud
|
| 156 |
+
- Self-correction during recording
|
| 157 |
+
|
| 158 |
+
#### Languages (7 supported)
|
| 159 |
+
Multi-language support for:
|
| 160 |
+
- English, Hebrew, Arabic
|
| 161 |
+
- Russian, French, Spanish, German
|
| 162 |
+
|
| 163 |
+
#### Transcription Quality (5 levels)
|
| 164 |
+
STT output assessment:
|
| 165 |
+
- Excellent, Good, Fair, Poor, Unusable
|
| 166 |
+
|
| 167 |
+
#### Additional Metadata
|
| 168 |
+
- **Audio Quality Indicators**: Quality ratings, noise types, environmental factors
|
| 169 |
+
- **Technical Specifications**: Microphone types, Bluetooth codecs, audio formats
|
| 170 |
+
- **Text Analysis**: Word/character counts, lexical diversity, speaking rate (WPM)
|
| 171 |
+
- **Context**: Recording location, time of day, multi-language indicators
|
| 172 |
+
|
| 173 |
+
See `schema/README.md` and `schema/CHANGELOG.md` for complete schema documentation and version history.
|
| 174 |
|
| 175 |
## Recording Equipment
|
| 176 |
|