Skip to content

docs: clarify installation, compatibility, and Hugging Face troubleshooting#138

Open
khanfs wants to merge 1 commit into
evo-design:mainfrom
khanfs:docs/evo-setup-troubleshooting
Open

docs: clarify installation, compatibility, and Hugging Face troubleshooting#138
khanfs wants to merge 1 commit into
evo-design:mainfrom
khanfs:docs/evo-setup-troubleshooting

Conversation

@khanfs
Copy link
Copy Markdown

@khanfs khanfs commented Apr 8, 2026

Summary

This PR improves the setup and onboarding experience by clarifying installation constraints and documenting common setup and model-loading issues.

Changes

  • add a Known working setup section consolidating FlashAttention and PyTorch compatibility
  • add a Common setup issues section covering recurring errors:
    • NameError: MHA is not defined
    • AssertionError: rotary_emb is not installed
    • Hugging Face module loading issues
  • expand Hugging Face usage guidance with a short checklist

Why

Several setup and model-loading issues appear repeatedly in the issue tracker. These changes aim to:

  • reduce friction for new users
  • surface known compatibility constraints more clearly
  • provide actionable guidance for common failure modes

Notes

This PR focuses on documentation only and does not modify any core functionality.

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