Merge branch 'main' into astroC86/load-store-latency

Author: astroC86

.github/copilot-instructions.md

@@ -0,0 +1,126 @@
+# Iris: Multi-GPU Programming Framework
+
+## Description
+
+Iris is a Triton-based framework for Remote Memory Access (RMA) operations on AMD GPUs. It provides SHMEM-like APIs within Triton for Multi-GPU programming with:
+
+- Clean abstractions with full symmetric heap implementation
+- Pythonic PyTorch-like host APIs for tensor operations  
+- Triton-style device APIs for load, store, and atomic operations
+- Minimal dependencies (Triton, PyTorch, HIP runtime, mpi4py)
+- Comprehensive examples showing communication/computation overlap
+
+**FOLLOW THESE INSTRUCTIONS EXACTLY. Reference these instructions first before using search or bash commands.**
+
+## Prerequisites
+
+- **GPU**: AMD GPUs with ROCm compatibility (tested on MI300X, MI350X & MI355X)
+  > **Note**: See below for instructions on development without AMD GPU access
+- **ROCm/HIP Toolkit**: Required for building C++/HIP components
+- **MPI**: Required for multi-GPU operations
+- **Docker/Apptainer**: Recommended for containerized development
+
+## Build
+
+### Docker Development Environment (Recommended)
+```bash
+# Build and start development container (takes 45-60 minutes - NEVER CANCEL)
+docker compose up --build -d
+
+# Attach to running container
+docker attach iris-dev
+
+# Install Iris in development mode
+cd iris && pip install -e ".[dev]"
+```
+
+### Alternative Docker Setup
+```bash
+# Build Docker image manually
+./docker/build.sh <image-name>  # Takes 45-60 minutes
+
+# Run container
+./docker/run.sh <image-name>
+
+# Install Iris
+cd iris && pip install -e ".[dev]"
+```
+
+### Apptainer Setup
+```bash
+# Build and run Apptainer image
+./apptainer/build.sh
+./apptainer/run.sh
+
+# Install Iris
+pip install -e ".[dev]"
+```
+
+### Local Development (Not Recommended)
+```bash
+# Requires ROCm/HIP toolkit installation
+pip install -e ".[dev]"
+```
+
+### Development Without AMD GPU
+If you don't have access to AMD GPUs, you can still contribute to the project:
+- **Code Editing**: Start editing code directly in your local environment
+- **CI Testing**: The project has comprehensive CI pipelines that will test your changes automatically. You can check the CI logs if your changes fail to understand what went wrong.
+- **Local Validation**: Run linting and formatting locally: `ruff check . --fix && ruff format .`
+
+## Run
+
+### Testing
+```bash
+# Run unit tests
+pytest tests/unittests/
+
+# Run example tests  
+pytest tests/examples/
+
+# Run specific example (requires MPI and GPU)
+mpirun -np 8 python examples/00_load/load_bench.py
+```
+
+### Code Quality
+```bash
+# Linting and formatting
+ruff check .
+ruff format .
+
+# Pre-commit validation (required)
+ruff check . --fix
+ruff format .
+```
+
+## Contributing Guidelines
+
+### Development Workflow
+1. **Setup**: Install with dev dependencies: `pip install -e ".[dev]"`
+2. **Branch**: Create feature branch: `git checkout -b $USER/feature-name`
+3. **Develop**: Follow existing code style, add tests, update docs
+4. **Test**: Run `ruff check .`, `ruff format .`, and `pytest`
+5. **Commit**: Use descriptive commit messages
+6. **PR**: Create pull request with change details
+
+### Code Standards
+- Follow existing code style and patterns
+- Add tests for new functionality
+- Update documentation as needed
+- Ensure all tests pass before submitting PR
+- Run pre-commit validation: `ruff check . --fix && ruff format .`
+
+### Repository Structure
+```
+iris/
+├── iris/                       # Main Python package
+├── csrc/                       # C++/HIP source code
+├── examples/                   # Algorithm implementations
+├── tests/                      # Test suite
+├── docker/                     # Docker configuration
+└── docs/                      # Documentation
+```
+
+## License
+
+MIT License - see [LICENSE](LICENSE) file for details.

.github/workflows/auto-label.yml

@@ -37,7 +37,7 @@ jobs:
 
   # PRs: label so the project rule moves them to In Progress
   label-prs:
-    if: github.event_name == 'pull_request'
+    if: github.event_name == 'pull_request' && !github.event.pull_request.head.repo.fork
     runs-on: ubuntu-latest
     steps:
       - name: Add iris + in-progress labels to PR
@@ -49,4 +49,5 @@ jobs:
               repo: context.repo.repo,
               issue_number: context.payload.pull_request.number,
               labels: ["iris", "in-progress"]
-            });
+            })
+

.github/workflows/iris-tests-apptainer.yml

@@ -0,0 +1,79 @@
+name: Iris Tests with Apptainer
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.ref }}
+  cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
+
+jobs:
+  build-apptainer-image:
+    runs-on: [self-hosted, mi3008x]
+    timeout-minutes: 90
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Apptainer
+        run: |
+          apt-get update && apt-get install -y software-properties-common
+          add-apt-repository -y ppa:apptainer/ppa
+          apt-get update && apt-get install -y apptainer
+
+      - name: Build Iris Apptainer container
+        run: |
+          # Create persistent Apptainer directory
+          mkdir -p ~/apptainer
+
+          # Build Apptainer image from definition file (only if it doesn't exist)
+          if [ ! -f ~/apptainer/iris-dev.sif ]; then
+            echo "Building new Apptainer image..."
+            apptainer build ~/apptainer/iris-dev.sif apptainer/iris.def
+          else
+            echo "Using existing Apptainer image"
+          fi
+  run-tests:
+    name: ${{ matrix.ranks }}-rank Iris Test
+    needs: build-apptainer-image
+    runs-on: [self-hosted, mi3008x]
+    timeout-minutes: 20
+    strategy:
+      matrix:
+        ranks: [1, 2, 4, 8]
+      max-parallel: 1
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Run Iris Tests with ${{ matrix.ranks }} MPI ranks
+        run: |
+          apptainer exec ~/apptainer/iris-dev.sif bash -c "
+            set -e  # Exit on any error
+
+            # Install iris first
+            pip install -e .
+
+            # Create function for mpirun with root permissions
+            mpirun-root() { mpirun --allow-run-as-root \"\$@\"; }
+
+            # Run examples tests one at a time
+            echo 'Running examples tests one at a time...'
+            for test_file in tests/examples/test_*.py; do
+              echo \"Testing: \$test_file with ${{ matrix.ranks }} MPI ranks\"
+              mpirun-root -np ${{ matrix.ranks }} python -m pytest \"\$test_file\" -v --tb=short
+            done
+
+            # Run unit tests one at a time
+            echo 'Running unit tests one at a time...'
+            for test_file in tests/unittests/test_*.py; do
+              echo \"Testing: \$test_file with ${{ matrix.ranks }} MPI ranks\"
+              mpirun-root -np ${{ matrix.ranks }} python -m pytest \"\$test_file\" -v --tb=short
+            done
+          "

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+muhaawad at amd dot com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.