Skip to content

docs: add AMD compute strategy#1

Merged
Ker102 merged 1 commit into
mainfrom
docs/amd-deployment-strategy
May 8, 2026
Merged

docs: add AMD compute strategy#1
Ker102 merged 1 commit into
mainfrom
docs/amd-deployment-strategy

Conversation

@Ker102
Copy link
Copy Markdown
Owner

@Ker102 Ker102 commented May 8, 2026

Summary

  • Document DigitalOcean / AMD Developer Cloud as the primary harder route for the case study.
  • Add Fireworks-compatible managed inference as a contingency path without overclaiming private GPU inference.
  • Add .gitattributes so repo text files normalize to LF.

Test Plan

  • python -m unittest discover -s tests -v
  • python -m ruff check src tests
  • python -m mypy src
  • python -m pip_audit . --skip-editable

Security Impact

  • No secrets added.
  • Documents endpoint exposure risks and evidence labeling.
  • Keeps main protected and uses PR workflow after bootstrap.

Summary by CodeRabbit

  • Documentation

    • Added comprehensive compute strategy documentation covering deployment approaches and contingency paths
    • Updated runbook, case study, and cost report with fallback provider options and detailed contingency planning
    • Enhanced README with new documentation links
  • Chores

    • Configured Git attributes to enforce consistent line-ending behavior across platforms

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 8, 2026

Review Change Stack

📝 Walkthrough

Walkthrough

This PR introduces documentation and Git configuration to support an AMD Developer Cloud/DigitalOcean GPU compute strategy. A new compute-strategy.md file defines execution tracks for baseline setup, AMD GPU inference via ROCm and vLLM, and a Fireworks managed-inference fallback. The strategy is integrated into the README, changelog, runbook with operational steps, case study with contingency rationale, and cost report with fallback pricing. Git attributes enforce consistent line endings.

Changes

Compute Strategy and Documentation

Layer / File(s) Summary
Git Configuration
.gitattributes
Git attributes configured to enforce LF line endings globally with explicit CRLF for PowerShell and Windows batch/cmd files.
Compute Strategy Documentation
docs/compute-strategy.md
New document defining AMD Developer Cloud/DigitalOcean as primary compute path, Fireworks as contingency fallback, three execution tracks (non-GPU baseline, AMD GPU with ROCm/vLLM, and Fireworks contingency), demo positioning narratives, evidence checklist for runs, and risks/mitigation table.
Project Documentation Links
README.md, CHANGELOG.md
README adds documentation link to compute strategy; changelog records AMD/Fireworks compute path as unreleased feature.
Runbook Operational Guidance
docs/runbook.md
Runbook adds AMD Developer Cloud/DigitalOcean deployment steps (baseline first, then MI300X GPU endpoint when available) and Fireworks fallback instructions using NULLSTATE_LLM_BASE_URL environment variable.
Case Study and Cost Integration
docs/case-study.md, docs/cost-report.md
Case study adds contingency rationale for Fireworks due to potential AMD access delays; cost report adds Fireworks fallback row; both reference compute-strategy.md for strategy details.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~7 minutes

Poem

🐰 A hop and a skip through clouds so grand,
AMD and Fireworks, hand in paw—
One path shines bright, one stands at hand,
Computing strategy without a flaw!
Contingency thumper, we salute you!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs: add AMD compute strategy' directly and concisely summarizes the main change: adding documentation for AMD compute strategy. It is clear, specific, and reflects the primary purpose of this changeset.
Description check ✅ Passed The description covers all required template sections: provides a clear summary of changes, documents a test plan with completed checks, addresses security impact, and mentions documentation updates. The content is complete and relevant.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/amd-deployment-strategy

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@Ker102 Ker102 mentioned this pull request May 8, 2026
5 tasks
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/compute-strategy.md`:
- Line 90: The mitigation text for the "Endpoint exposed publicly" row should
follow sentence-style capitalization and punctuation like neighboring rows:
update the string "restrict ingress, use token auth, document network boundary"
to "Restrict ingress, use token auth, and document network boundary." so it
starts with a capital letter, uses "and" for clarity, and ends with a period to
match the surrounding mitigations.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: c985d297-2dff-4143-b099-a06c9a266b2f

📥 Commits

Reviewing files that changed from the base of the PR and between 3027529 and e057bbd.

📒 Files selected for processing (7)
  • .gitattributes
  • CHANGELOG.md
  • README.md
  • docs/case-study.md
  • docs/compute-strategy.md
  • docs/cost-report.md
  • docs/runbook.md

Comment thread docs/compute-strategy.md
@Ker102 Ker102 self-assigned this May 8, 2026
Copy link
Copy Markdown
Owner Author

@Ker102 Ker102 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

all cheks pass

@Ker102 Ker102 merged commit d9a4072 into main May 8, 2026
5 of 7 checks passed
@Ker102 Ker102 deleted the docs/amd-deployment-strategy branch May 8, 2026 15:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant