Keep anomalib model READMEs, docs pages, image assets, and benchmark/result references in sync
Use this skill when updating model documentation, benchmark tables, sample-result images, or docs reference pages for an anomalib model.
Use this skill to keep model READMEs, docs pages, images, and benchmark/sample references aligned.
src/anomalib/models/**/README.mddocs/source/markdown/guides/reference/models/**docs/source/images/**results/src/anomalib/models/image/<model>/README.md.src/anomalib/models/video/<model>/README.md.src/anomalib/models/image/README.md and src/anomalib/models/video/README.md.docs/source/markdown/guides/reference/models/image/<model>.md.docs/source/markdown/guides/reference/models/video/<model>.md.docs/source/markdown/guides/reference/models/**/index.md up-to-date.docs/source/images/<model>/.architecture.* and results/0.png, results/1.png, results/2.png.docs/source/images/cs_flow/.results/<ModelName>/....results/ as evidence for benchmark/sample claims, not as a place to invent values from partial runs.For the target model:
docs/source/images/<model>/ or the repo-specific variant actually used.results/.Never update only one of README or docs when both exist.
If present in the README, verify that the docs page and assets do not contradict it:
Docs pages do not need to duplicate the full README, but they must stay consistent with it.
tools/experimental/benchmarking/.results/.docs/source/images/... location./docs/source/images/<model>/... when the README already uses that pattern.Before finishing:
csflow vs cs_flow.results/ without a fully synced docs surface yet.