-
Notifications
You must be signed in to change notification settings - Fork 49
docs: harden datastore PR review workflow #241
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.
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
base: main
Are you sure you want to change the base?
Changes from all commits
d7704e4
1dbac8d
3d09249
68eed5c
5f861a5
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| ## `<YYYY-MM-DD>` — `<short decision title>` | ||
|
|
||
| - PR: `<discussion URL>` | ||
| - Pre-edit head: `<40-character SHA>` | ||
| - Scope: `<record/result/model counts and repo-relative paths or compact groups>` | ||
| - Approved proposal: `<relative path or n/a>` | ||
| - Proposal SHA-256: `<full digest or n/a>` | ||
| - Approval: `<approver, timestamp, and exact approved head or n/a>` | ||
| - Local verification: `<validator and duplicate-check receipts>` | ||
| - Matching bot receipt: `<event/run/fingerprint or pending>` | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. RAV-RUN1-R1-F001 [medium] audit-closure — The append-only record can remain at |
||
|
|
||
| ### Decisions | ||
|
|
||
| - `<field or issue>`: `<source-backed old → new value and concise reason>` (`<source ids>`) | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. RAV-RUN1-R1-F002 [medium] evidence-resolution — These source IDs have no resolver when |
||
|
|
||
| ### Follow-ups | ||
|
|
||
| - `<adapter, registry, unresolved provenance, or none>` | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| # EEE deployment metadata proposal | ||
|
|
||
| - PR: `<discussion URL>` | ||
| - PR head: `<40-character commit SHA>` | ||
| - Schema version: `<version>` | ||
| - Scope: `<model count> models / <file count> files` | ||
| - Status: **PENDING HUMAN APPROVAL** | ||
|
|
||
| | model_id | proposed deployment_type | proposed model_availability | confidence | source(s) | | ||
| |---|---|---|---|---| | ||
| | `<exact model_info.id>` | `<self_deployed / externally_managed / unknown>` | `<open_weights / closed_weights / unknown>` | `<D: high/medium/low; A: high/medium/low>` | `<D:S1; A:S2,S3>` | | ||
|
|
||
| Repeat the exact model id with a scope tag such as `[G1]` only when its submitted files | ||
| have distinct run evidence. Multiple citations or generation settings alone do not | ||
| create a group. | ||
|
|
||
| ## Scope manifest | ||
|
|
||
| - **G1** — `<exact evaluation_id(s) or repo-relative file path(s)>` — `<why this is a distinct evidence group>` | ||
|
|
||
| ## Sources | ||
|
|
||
| - **S1** — [`<source title>`](<URL>), `<revision or access date>` — `<what it establishes>` | ||
|
|
||
| ## Unknown rationale | ||
|
|
||
| Complete one row for every `unknown` cell. Do not finalize this proposal while any | ||
| axis is `research_incomplete`. | ||
|
|
||
| Coverage codes: `R` record/run artifacts, `A` adapter/config, `E` eval card/README/ | ||
| methodology/leaderboard, `M` exact model card/release, `P` official provider/API, | ||
| `W` paper/repository/archive. | ||
|
|
||
| | model_id | axis | status/reason | checked | confusion or evidence gap | evidence needed to resolve | | ||
| |---|---|---|---|---|---| | ||
| | `<exact model_info.id>` | `<deployment_type / model_availability>` | `<conflicting_sources / unavailable_after_search>: <reason code>` | `<R:S1; A:S2; E:none; M:S3; P:n/a; W:S4>` | `<concise explanation>` | `<specific artifact or statement>` | | ||
|
|
||
| ## Other unresolved questions | ||
|
|
||
| - None. | ||
|
|
||
| ## Approval | ||
|
|
||
| Approve only the completed proposal's reported SHA-256 at the PR head above. Any | ||
| change to the head, table, or evidence invalidates approval. | ||
|
|
||
| After approval, preserve this file byte-for-byte at | ||
| `data/<collection>/deployment-metadata-proposal-<first-12-SHA256>.md` and record the | ||
| approval receipt in that collection's `REVIEW_DECISIONS.md`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: do we mean model card or similar artifacts when we say "eval card" in these files