Editorial and Normative reference updates - #146
seanmcilroy29 wants to merge 42 commits into
Conversation
Revised the introduction to comply with ISO Signed-off-by: Sean Mcilroy <smcilroy@linuxfoundation.org>
Scope updates in line with ISO requirements Signed-off-by: Sean Mcilroy <smcilroy@linuxfoundation.org>
Normative Reference updated Signed-off-by: Sean Mcilroy <smcilroy@linuxfoundation.org>
Terms and definitions Signed-off-by: Sean Mcilroy <smcilroy@linuxfoundation.org>
Revised the AI lifecycle stages to comply with ISO Signed-off-by: Sean Mcilroy <smcilroy@linuxfoundation.org>
Revised the Terms and definitions to comply with ISO Signed-off-by: Sean Mcilroy <smcilroy@linuxfoundation.org>
Revised the AI lifecycle coverage to comply with ISO Signed-off-by: Sean Mcilroy <smcilroy@linuxfoundation.org>
Revised the Functional units to comply with ISO Signed-off-by: Sean Mcilroy <smcilroy@linuxfoundation.org>
Added definitions for 'gross value' and 'effective value' to the specification. Signed-off-by: Sean Mcilroy <smcilroy@linuxfoundation.org>
Revised the Implementation examples to comply with iso Signed-off-by: Sean Mcilroy <smcilroy@linuxfoundation.org>
Revised the introduction to comply with ISO
Revised the Scope to comply with ISO
Signed-off-by: Sean Mcilroy <smcilroy@linuxfoundation.org>
Added a new section on ISO and IEC terminological databases. Signed-off-by: Sean Mcilroy <smcilroy@linuxfoundation.org>
Removed unnecessary note indicators in definitions for clarity. Signed-off-by: Sean Mcilroy <smcilroy@linuxfoundation.org>
…rence-updated Revised the Normative Reference to comply with ISO
Removed 'Note 1 to entry:' prefix from examples under gross value. Signed-off-by: Sean Mcilroy <smcilroy@linuxfoundation.org>
Signed-off-by: Sean Mcilroy <smcilroy@linuxfoundation.org>
Clarified the reference to table 2 in the provider functional units section. Signed-off-by: Sean Mcilroy <smcilroy@linuxfoundation.org>
Signed-off-by: Sean Mcilroy <smcilroy@linuxfoundation.org>
Signed-off-by: Sean Mcilroy <smcilroy@linuxfoundation.org>
…nitions Revised the Terms and definitions to comply with ISO
Signed-off-by: Sean Mcilroy <smcilroy@linuxfoundation.org>
Signed-off-by: Sean Mcilroy <smcilroy@linuxfoundation.org>
Signed-off-by: Sean Mcilroy <smcilroy@linuxfoundation.org>
Reformat example reporting carbon intensity for clarity. Signed-off-by: Sean Mcilroy <smcilroy@linuxfoundation.org>
Signed-off-by: Sean Mcilroy <smcilroy@linuxfoundation.org>
…rms-and-definitions-to-comply-with-ISO Revised the Terms and definitions to comply with ISO
Signed-off-by: Sean Mcilroy <smcilroy@linuxfoundation.org>
Signed-off-by: Sean Mcilroy <smcilroy@linuxfoundation.org>
Signed-off-by: Sean Mcilroy <smcilroy@linuxfoundation.org>
…patch-1 Revised the AI lifecycle stages to comply with ISO
…ith-ISO Signed-off-by: Sean Mcilroy <smcilroy@linuxfoundation.org>
…-lifecycle-coverage-to-comply-with-ISO Revised the ai lifecycle coverage to comply with iso
Signed-off-by: Sean Mcilroy <smcilroy@linuxfoundation.org>
Revised the Functional units to comply with iso
Signed-off-by: Sean Mcilroy <smcilroy@linuxfoundation.org>
…-examples Revised the Implementation examples to comply with iso
Editorial updates Signed-off-by: Sean Mcilroy <smcilroy@linuxfoundation.org>
Editorial updates
Review: Editorial and Normative reference updatesReviewed against Verified: the arithmetic fixes are correctI recomputed every changed figure and all four now check out — this PR fixes three real errors in the previous text:
Showing the division inline in each EXAMPLE is a good call; it makes future drift detectable. 1. Markdown rendering regression in Terms and definitions (
|
Corrected unit for Consumer SCI from 'million' to 'billion' tokens. Signed-off-by: Sean Mcilroy <smcilroy@linuxfoundation.org>
Correct formatting of CO₂e values in examples for clarity. Signed-off-by: Sean Mcilroy <smcilroy@linuxfoundation.org>
Review: Editorial and Normative reference updates (#146)Reviewed the full Verified correct ✅I re-checked every arithmetic change; the corrections in this PR are right and fix real pre-existing errors:
Also good: adding Issues1. Terms and definitions will render as run-on paragraphs ( The diff removed the trailing two-space hard line breaks after
instead of the three-line ISO term layout. Please restore the two trailing spaces (or use explicit blank lines / 2. ISO/IEC Directives Part 2 requires every entry in Normative references to be cited normatively in the body. 3. Clause numbering was removed — cross-references now have nothing to point at Dropping
Related: terms are numbered 4. Retirement boundary contradiction (pre-existing, but this PR is the natural place to fix it)
Two of three say Provider-only, so the coverage heading looks like the outlier. Per 5. Example magnitudes are now mutually implausible The arithmetic is right, but fixing it surfaced that the input numbers were never calibrated against each other:
A reader comparing the two SPEC examples will assume one is a typo. Suggest reworking the CV example's inputs (e.g. total emissions in the low thousands of kg) so the illustrative figures sit in the same order of magnitude as each other and as the FAQ's GPT-3 anchor. 6. Unit formatting inconsistency
Two smaller ones in the same family:
7. Minor wording (
"following" and "shown in Table 2" are redundant, and the comma splits the verb from its purpose clause. Suggest: "shall be one of the metrics in Table 2, used to normalize carbon emissions during AI model training." Also note the normative asymmetry that this PR preserves: the Consumer table is explicitly "indicative and not exhaustive" while the Provider list is a closed On the review dimensions requestedThis repo is a specification, not code, so performance and security don't apply, and nothing here touches secrets or dependencies. The analogue of test coverage is document consistency, and there is currently no automation for it — Unrelated to this PR: SummaryItems 1 (rendering regression) and 2 (uncited normative reference) should be fixed before merge. 4 and 5 are content questions best settled on the weekly call. Everything else is polish. Nice catch on the arithmetic errors — those were real. |
Review: Editorial and Normative reference updates (#146)Reviewed as an editorial/normative pass on Verified fixes (nice catches)I re-checked every worked example; all four now compute correctly and agree with their "Reporting" subclause:
Two of these repair pre-existing errors that are worth flagging in the weekly call, because they change published numbers:
Also good: Issues to address before merge1. Markdown hard line breaks were dropped in Terms and definitions (
Restore the two-space breaks (or use a trailing 2. 3. T.1 redefines a term imported from a normative reference (
While you are in this clause, it is worth checking T.4 (model training), T.5 (inference), T.6 (token) and T.7 (parameter) against ISO/IEC 22989:2022 now that it is imported at line 58. Where 22989 already defines a concept, ISO drafting practice is to cite it rather than define a local variant. 4. The NOTE at 5. Nothing states the verbal-form convention. Replacing 6. Removing clause numbering removes the ability to cross-reference. ISO documents are numbered (Scope = 1, Normative references = 2, Terms and definitions = 3), and the consequences already show in this diff: Consistency items (mostly pre-existing, but this is the editorial pass)
Process and validation
SummaryThe arithmetic and terminology fixes are real improvements and should land. I would treat items 1-4 as merge blockers (a rendering regression, an uncited normative reference, a redefined imported term, and a recommendation demoted into a NOTE), and items 5-6 plus the Retirement contradiction as decisions for the weekly call rather than for the author alone. |
Dev branch updated with Editorial and Normative reference updates in line with ISO requirements