Skip to content

readme: add ACKNOWLEDGEMENTS.md references in three places #35

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.

Sign up for GitHub

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

Merged
ashwinma merged 1 commit into from
May 26, 2026
Merged

readme: add ACKNOWLEDGEMENTS.md references in three places #35

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,7 @@ Agents read these files to understand the repo:
|------|---------|
| [`models.yaml`](models.yaml) | Index of all 15 models across 5 domains |
| `<model>/model.yaml` | Per-model manifest: HF id, license, recipes, env vars, hardware |
| [`ACKNOWLEDGEMENTS.md`](ACKNOWLEDGEMENTS.md) | Per-model attribution: upstream authors, papers, ROCm blog credits |
| `.cursor/skills/` | Agent skills for Cursor (run models, discover, domain conventions) |
| `.cursor/rules/` | Contextual rules that fire when editing specific file types |
| `.claude/commands/` | Slash commands for Claude Code |
Expand Down Expand Up @@ -172,7 +173,8 @@ If you prefer to do it manually:
2. Copy [`_template/`](_template/) to your domain and model folder.
3. Fill in the model README, create a `model.yaml`, and add at minimum one runnable recipe.
4. Add the model to [`models.yaml`](models.yaml).
5. Open a pull request.
5. Add an entry to [`ACKNOWLEDGEMENTS.md`](ACKNOWLEDGEMENTS.md) crediting the upstream authors, paper, and any ROCm blog post.
6. Open a pull request.

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

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