Skip to content

Commit 32b6268

Browse files
ashwinmaclaude
andauthored
readme: add ACKNOWLEDGEMENTS.md references in three places (#35)
- Metadata table: add ACKNOWLEDGEMENTS.md as a discoverable repo file - Contributing: require an ACKNOWLEDGEMENTS.md entry when adding a model - Disclaimers: link to ACKNOWLEDGEMENTS.md for full upstream attribution Co-authored-by: Claude Sonnet 4 <noreply@anthropic.com>
1 parent ad756de commit 32b6268

1 file changed

Lines changed: 4 additions & 1 deletion

File tree

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,7 @@ Agents read these files to understand the repo:
135135
|------|---------|
136136
| [`models.yaml`](models.yaml) | Index of all 15 models across 5 domains |
137137
| `<model>/model.yaml` | Per-model manifest: HF id, license, recipes, env vars, hardware |
138+
| [`ACKNOWLEDGEMENTS.md`](ACKNOWLEDGEMENTS.md) | Per-model attribution: upstream authors, papers, ROCm blog credits |
138139
| `.cursor/skills/` | Agent skills for Cursor (run models, discover, domain conventions) |
139140
| `.cursor/rules/` | Contextual rules that fire when editing specific file types |
140141
| `.claude/commands/` | Slash commands for Claude Code |
@@ -172,7 +173,8 @@ If you prefer to do it manually:
172173
2. Copy [`_template/`](_template/) to your domain and model folder.
173174
3. Fill in the model README, create a `model.yaml`, and add at minimum one runnable recipe.
174175
4. Add the model to [`models.yaml`](models.yaml).
175-
5. Open a pull request.
176+
5. Add an entry to [`ACKNOWLEDGEMENTS.md`](ACKNOWLEDGEMENTS.md) crediting the upstream authors, paper, and any ROCm blog post.
177+
6. Open a pull request.
176178

177179
See each domain's `models/README.md` for slug conventions and domain-specific notes.
178180

@@ -182,3 +184,4 @@ See each domain's `models/README.md` for slug conventions and domain-specific no
182184
- Each model is under its **upstream license**; check the model card on Hugging Face before use.
183185
- **Healthcare & Life Sciences** content is for research and engineering only. Do not commit patient-identifiable data or PHI.
184186
- AMD/ROCm notes in individual recipes reflect what maintainers have tested—they do not replace upstream install matrices or official product documentation.
187+
- Full attribution for upstream authors, papers, and ROCm blog contributors is in [`ACKNOWLEDGEMENTS.md`](ACKNOWLEDGEMENTS.md).

0 commit comments

Comments
 (0)