Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Environment Setup

1. Clone the Repository

git clone https://github.com/yourusername/Mini-YAIE.git
cd Mini-YAIE

2. Python Environment

It is highly recommended to use a virtual environment.

python -m venv venv
source venv/bin/activate
pip install -r requirements.txt
pip install -e .

3. CUDA Requirements (Optional)

To build and run the CUDA kernels, you need:

  • NVIDIA GPU (Compute Capability 7.0+)
  • CUDA Toolkit 11.8+
  • PyTorch with CUDA support

If you do not have a GPU, you can still implement the Python logic and the CPU fallback kernels.

4. Documentation Setup

To serve this documentation locally:

  1. Install mdbook:

    # If you have Rust/Cargo installed:
    cargo install mdbook
    
    # Or download the binary from their GitHub releases.
    
  2. Serve the docs:

    mdbook serve docs
    

    Navigate to http://localhost:3000 in your browser.