Skip to content

README: reflect raw/derived transcript design #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hollygrimm merged 1 commit into from
Jul 18, 2026
Merged

README: reflect raw/derived transcript design #16

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 13 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ alongside, e.g. `data/video/<other-channel>/…` or `data/<other-type>/<source>/

```
data/video/activeinferenceinstitute/<Series>/<item>/
metadata.json # canonical: series, item, parts[{video_id, url, title, duration, upload_date}]
transcript.txt # clean text (part-tagged when multi-part)
transcript.json # timestamped segments (where available)
captions/ # original-language .srt
metadata.json # canonical: series, item, parts[{video_id, url, title, duration, upload_date, speakers}]
transcript.txt # derived speaker-labeled text (part-tagged when multi-part)
transcript.json # raw diarized segments — immutable, SPEAKER_NN labels (where available)
captions/ # original-language .srt (+ youtube_captions.txt where captions predate diarization)
translations/ # translated .srt (per language)
assets/ # images, html, prose, appendices, bibliography, …
README.md # human nav: titles, links, contents
Expand All @@ -42,6 +42,12 @@ is represented (uncategorized videos live under `Other/`).
## Provenance

Transcripts and metadata are pulled completely and idempotently from the Institute
YouTube channel (captions, or local Whisper where captions are absent) by
[Journal-Utilities](https://github.com/ActiveInferenceInstitute/Journal-Utilities)
(`scripts/refactor_journal.py`, `scripts/download_channel.py`). See [`docs/SCHEMA.md`](docs/SCHEMA.md).
YouTube channel by
[Journal-Utilities](https://github.com/ActiveInferenceInstitute/Journal-Utilities).
Most transcripts are WhisperX-diarized: `transcript.json` holds the immutable raw
segments (`SPEAKER_NN`), human speaker identifications are recorded in
`metadata.json` `parts[].speakers`, and `transcript.txt` is regenerated from the
two (`scripts/apply_speaker_names.py`). Items without diarization yet carry
YouTube-caption text; original captions always remain under `captions/`.
Private/unlisted videos are not transcribed. See [`docs/SCHEMA.md`](docs/SCHEMA.md)
("Transcripts — raw vs derived").