Skip to content

Docs: clearer end-to-end installation & troubleshooting for Transformer Engine / Vortex #192

@aymaneVXx

Description

@aymaneVXx

Summary

Several users including myself encounter installation issues related to transformer_engine and vortex when following the README. Common errors include:

  • ModuleNotFoundError: No module named 'transformer_engine'
  • ModuleNotFoundError: No module named 'vortex'
  • Import errors from transformer_engine.common caused by missing CUDA / NVRTC libraries

Multiple issues in the repo show the same pattern, but the README does not explain how to build a clean, reproducible environment.

Environment (example)

  • OS: Ubuntu 22.04 (WSL2)
  • GPU: NVIDIA (CUDA 12.1+)
  • Python: 3.12 (conda)
  • Evo2 version: 0.3.0 (PyPI)

Steps to Reproduce

  1. Create a clean Python 3.12 environment.

  2. Install Evo2 from PyPI or source.

  3. Run:

    python -m evo2.test.test_evo2_generation --model_name evo2_7b
  4. On some machines, installation fails due to missing transformer_engine or vortex, or CUDA-related import errors.

Actual Behavior

  • No single, “known good” environment configuration exists.
  • No troubleshooting section for common import errors.
  • Users must search through scattered GitHub issues to fix installation problems.

Expected Behavior

  • A documented environment that reliably works with Evo2.
  • Clear instructions for solving common import-time issues.
  • A troubleshooting section with concrete fixes.

Suggested Improvements

  1. Provide a reference environment.yml describing a working conda setup.
  2. Add a troubleshooting section addressing:
    • Missing transformer_engine
    • Missing vortex
    • CUDA / NVRTC import failures
  3. Document the environment used by the development team (GPU type, Python version, dependency versions).

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions