目录文档-技术白皮书43-EFT.WP.Data.DatasetCards v1.0

第14章 发布与版本化


I. 章节目的与范围

固化数据集卡与数据工件的发布流程、版本号规则、兼容性与弃用策略、撤回与更正机制,以及发布产物与审计轨;保证对外口径一致、可复现与可追溯。所有键名用 snake_case,跨卷引用采用“卷名+版本+锚点”。

II. 术语与依赖


III. 字段与结构(规范性)

release:

channel: "stable" # alpha | beta | rc | stable | yanked

version: "v1.0.0" # 语义化版本:vMAJOR.MINOR.PATCH

date: "2025-09-20"

tag: "eift-foo-v1.0.0" # Git/对象存储标签

compatibility:

baseline: "v1.*" # 对外承诺的稳定线

backwards: "minor" # backwards: none|patch|minor

artifacts: # 与 export_manifest 对表

- {path:"dataset_card.yaml", sha256:"..."}

- {path:"splits/train.index", sha256:"..."}

- {path:"packages/train-000.tgz", sha256:"..."}

checks:

schema_ok: true

lint_ok: true

check_dim_ok: true

quality_gates_ok: true

notices: # 公告口径(撤回/更正/限制说明)

type: "release" # release | correction | withdrawal

summary: "initial stable"

see:

- "EFT.WP.Core.DataSpec v1.0:EXPORT"

- "EFT.WP.Core.Metrology v1.0:check_dim"

versioning:

scheme: "semver" # 语义化版本

stability_line: "v1.*" # 对外引用建议

policy:

major: "breaking" # 断裂变更才提升 MAJOR

minor: "additive" # 向后兼容新增/字段可选化

patch: "fix" # 修复/文案更正,不改语义

deprecation:

announce_in: ["dataset_card.yaml", "export_manifest"]

grace_cycles: 1 # 至少保留一个 MINOR 周期

withdrawal:

allowed: true

reasons: ["legal","safety","integrity","privacy"]

mirror_tombstone: true # 镜像保留墓碑与公告

(release.* 与 versioning.* 字段用于卡片与门户同步,发布产物在 export_manifest 中逐项可验。)


IV. 语义化版本与稳定线

  1. 版本格式:vMAJOR.MINOR.PATCH(如 v1.2.3)。
  2. 提升规则
    • MAJOR:发生断裂变更(必填字段语义改变/删除、分割索引格式变化)。
    • MINOR:向后兼容新增(新增可选字段、补充映射、增加示例/分片)。
    • PATCH:修复与微更正(文本/注释/校验脚本修复),不改语义与结构。
  3. 稳定线:对外引用推荐指向 v1.* 稳定线;论文/基准报告建议固定到 次版本(如 v1.2.*)以确保可复现。

V. 兼容性矩阵与弃用策略

  1. 兼容性矩阵
    • Schema:minor+patch 兼容;major 可能断裂。
    • 指标与评测协议:新增不破坏既有;删除/语义变化需 major。
    • 切分索引:冻结后不可变更;如需变更必须提升 major 并提供迁移脚本。
  2. 弃用(Deprecation):在 dataset_card.yaml 与 export_manifest.references[] 公告弃用条目与替代路径;至少给予 grace_cycles >= 1 的迁移期。

VI. 撤回(Withdrawal)与更正(Correction)


VII. 发布前置检查(Blocking Gates)


VIII. 导出清单对表(规范性)

export_manifest:

version: "v1.0.0"

artifacts:

- {path:"dataset_card.yaml", sha256:"..."}

- {path:"splits/train.index", sha256:"..."}

- {path:"packages/train-000.tgz", sha256:"..."}

- {path:"quality/summary.csv", sha256:"..."}

references:

- "EFT.WP.Core.DataSpec v1.0:EXPORT"

- "EFT.WP.Core.Metrology v1.0:check_dim"

notices:

- {type:"release", summary:"initial stable", date:"2025-09-20"}

(所有工件必须逐项可验;引用携带卷名+版本+锚点;禁止短码/别名。)


IX. 发布渠道与镜像


X. 机器可读片段(可直接嵌入卡片)

release:

channel: "rc"

version: "v1.1.0-rc1"

date: "2025-10-01"

tag: "eift-foo-v1.1.0-rc1"

compatibility: {baseline:"v1.*", backwards:"minor"}

artifacts:

- {path:"dataset_card.yaml", sha256:"..."}

- {path:"packages/train-000.tgz", sha256:"..."}

checks: {schema_ok:true, lint_ok:true, check_dim_ok:true, quality_gates_ok:true}

notices: {type:"release", summary:"release candidate for v1.1.0"}

versioning:

scheme: "semver"

stability_line: "v1.*"

policy: {major:"breaking", minor:"additive", patch:"fix"}

deprecation: {announce_in:["dataset_card.yaml","export_manifest"], grace_cycles:1}

(与 export_manifest、第11–13章约束及计量/不确定度口径一致。)


XI. 本章合规自检


版权与许可(CC BY 4.0)

版权声明:除另有说明外,《能量丝理论》(含文本、图表、插图、符号与公式)的著作权由作者(“屠广林”先生)享有。
许可方式:本作品采用 Creative Commons 署名 4.0 国际许可协议(CC BY 4.0)进行许可;在注明作者与来源的前提下,允许为商业或非商业目的进行复制、转载、节选、改编与再分发。
署名格式(建议):作者:“屠广林”;作品:《能量丝理论》;来源:energyfilament.org;许可证:CC BY 4.0。

首次发布: 2025-11-11|当前版本:v5.1
协议链接:https://creativecommons.org/licenses/by/4.0/