Skip to content

Docs/votelle research formalization - #1

Merged
justinrm merged 3 commits into
mainfrom
docs/votelle-research-formalization
Oct 11, 2026
Merged

justinrm merged 3 commits into
mainfrom
docs/votelle-research-formalization

Conversation

@justinrm

Copy link
Copy Markdown
Owner

No description provided.

justinrm and others added 3 commits October 10, 2026 20:35
The package and CLI already use the Votelle identifiers, and nothing in this tree publishes the old exception.

Co-authored-by: Cursor <cursoragent@cursor.com>
…ents.

The seven superseded notes stay archived as historical evidence, and navigation now points at the consolidated governance, listening, encoder, training, and MVP documents.

Co-authored-by: Cursor <cursoragent@cursor.com>
The paragraph that says no weights were downloaded describes that register, not the later single-clip probe.

Co-authored-by: Cursor <cursoragent@cursor.com>
@sourcery-ai

sourcery-ai Bot commented Oct 11, 2026

Copy link
Copy Markdown

Sorry @justinrm, your pull request is larger than the review limit of 150,000 diff characters

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 11, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-11T15:56:42.671060Z 209f024 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@justinrm
justinrm merged commit 9de67dd into main Oct 11, 2026
1 of 2 checks passed

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 209f024631

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

| `ingest` | `--config`, `--source-uri`, `--raw`, `--decoded`, `--acquired-at`, `--decode-tool`, `--decode-version`, `--decode-command`; optional `--rights-record-id`, `--family-review` | `AcquisitionReceipt` as canonical JSON on stdout. Files under the dataset root as in section 7 | `VotelleError` JSON on stderr, exit 1. The decode command is stored and not executed. Missing local files are not fetched |
| `prepare` | `--config`, `--asset-id`, `--clip-id`, `--start`, `--end` | `QCSidecar` as canonical JSON. A prepared WAV. A `clips.jsonl` row only for `primary_level_matched` | Same error JSON. Requires `gain_lufs_v1` with `level_matched` true. Staged assets, bad bounds, and overwrites fail. Brief text is not invented |

On ingest, prepare, and split failures, stderr is a JSON object with `code` and `remediation`. The exception also carries `record_id` and `field`. The CLI does not print those two fields and does not print the class name. Config parse failures use `code` `schema_invalid` and put the parser message in `remediation`.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Document the split validation-report shape

When split fails because dataset validation reports errors, main writes report_bytes(report) directly to stderr (cli.py lines 77–80), so the top-level object contains schema_version, policy, provenance, and issues, rather than code and remediation. Clients following this newly documented universal failure shape will therefore fail on the most common invalid-dataset path; document both response forms or normalize the CLI output.

AGENTS.md reference: AGENTS.md:L56-L58

Useful? React with 👍 / 👎.

| Code | Where it is raised or reported | What it means |
|---|---|---|
| `schema_invalid` | CLI config parse; JSONL; family review; receipt JSON; feature cache | The payload does not match the schema, or a cache file is unreadable, pickled, or the wrong dtype |
| `schema_version` | `validate` | Config schema is not `0.1` |

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Align the documented config-version error code

When a normal CLI config supplies a schema_version other than 0.1, FoundationConfig rejects it during load_config, and the config exception handler emits schema_invalid; the later validate branch that emits schema_version cannot be reached through ordinary parsing. This row therefore gives callers the wrong error code for the stated scenario; describe schema_version as a manifest-validation code or change config parsing to preserve that distinction.

AGENTS.md reference: AGENTS.md:L56-L58

Useful? React with 👍 / 👎.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant