flashspec 0.1.0__tar.gz

flashspec-0.1.0/.github/workflows/benchmark.yml

@@ -0,0 +1,76 @@
+name: Performance Benchmark
+
+on:
+  push:
+    branches: [main]
+  schedule:
+    - cron: "0 4 * * *"  # Nightly at 04:00 UTC
+  workflow_dispatch:
+
+jobs:
+  # ── Job: bench-full ──────────────────────────────────────────────────────────
+  bench-full:
+    name: bench-full
+    runs-on: [self-hosted, gpu, H100]
+    timeout-minutes: 240
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          # Need push access for committing results back to main.
+          token: ${{ secrets.BENCHMARK_COMMIT_TOKEN }}
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+          cache: pip
+
+      - name: Install bench dependencies
+        run: pip install -e ".[bench]"
+
+      - name: Build Docker image
+        run: docker build -t flashspec:latest -f deploy/Dockerfile .
+
+      - name: Trivy image scan — CRITICAL CVEs block build (§15)
+        uses: aquasecurity/trivy-action@master
+        with:
+          image-ref: "flashspec:latest"
+          format: "table"
+          exit-code: "1"
+          severity: "CRITICAL"
+          ignore-unfixed: true
+
+      - name: Run full benchmark suite (make bench)
+        run: make bench
+        env:
+          HF_TOKEN: ${{ secrets.HF_TOKEN }}
+
+      - name: Validate and commit results
+        run: python scripts/update_benchmark_results.py
+        env:
+          GIT_AUTHOR_NAME: "FlashSpec Benchmark Bot"
+          GIT_AUTHOR_EMAIL: "ci@flashspec"
+          GIT_COMMITTER_NAME: "FlashSpec Benchmark Bot"
+          GIT_COMMITTER_EMAIL: "ci@flashspec"
+
+      - name: Check performance regression
+        run: python scripts/check_regression.py --threshold 0.05
+
+      - name: Upload result artifacts
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: benchmark-results-${{ github.sha }}
+          path: benchmarks/results/
+          retention-days: 90
+
+      - name: Notify on failure
+        if: failure()
+        uses: slackapi/slack-github-action@v1.26.0
+        with:
+          payload: |
+            {
+              "text": ":red_circle: FlashSpec nightly benchmark FAILED on `${{ github.sha }}`.\n<${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}|View run>"
+            }
+        env:
+          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
+          SLACK_WEBHOOK_TYPE: INCOMING_WEBHOOK

flashspec-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,139 @@
+name: CI
+
+on:
+  push:
+    branches: [main, dev]
+  pull_request:
+    branches: [main, dev]
+
+concurrency:
+  group: ci-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  # ── Job 1: lint ──────────────────────────────────────────────────────────────
+  lint:
+    name: lint
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+          cache: pip
+      - name: Install dev dependencies
+        run: pip install -e ".[dev]" --extra-index-url https://download.pytorch.org/whl/cpu
+      - name: make lint
+        run: make lint
+      - name: pip-audit (fail on CRITICAL CVE — §15)
+        run: |
+          pip install pip-audit
+          pip-audit --strict --vulnerability-service pypi -r <(pip freeze) 2>&1 | tee pip-audit.txt
+          # Exit non-zero only on CRITICAL severity
+          grep -q "CRITICAL" pip-audit.txt && exit 1 || true
+
+  # ── Job 2: test-cpu ──────────────────────────────────────────────────────────
+  test-cpu:
+    name: test-cpu
+    runs-on: ubuntu-22.04
+    needs: lint
+    env:
+      TRITON_CPU_BACKEND: "1"
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+          cache: pip
+      - name: Install
+        run: pip install -e ".[dev]" --extra-index-url https://download.pytorch.org/whl/cpu
+      - name: make test
+        run: make test
+      - name: Upload coverage XML
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-cpu
+          path: coverage.xml
+          retention-days: 7
+
+  # ── Job 3: test-chaos ────────────────────────────────────────────────────────
+  test-chaos:
+    name: test-chaos
+    runs-on: ubuntu-22.04
+    needs: lint
+    env:
+      TRITON_CPU_BACKEND: "1"
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+          cache: pip
+      - name: Install
+        run: pip install -e ".[dev]" --extra-index-url https://download.pytorch.org/whl/cpu
+      - name: make test-chaos
+        run: make test-chaos
+
+  # ── Job 4: coverage ──────────────────────────────────────────────────────────
+  coverage:
+    name: coverage
+    runs-on: ubuntu-22.04
+    needs: test-cpu
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+          cache: pip
+      - name: Install
+        run: pip install -e ".[dev]" --extra-index-url https://download.pytorch.org/whl/cpu
+      - name: Download coverage artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: coverage-cpu
+      - name: Fail if coverage < 95%
+        run: |
+          pip install coverage --break-system-packages 2>/dev/null || pip install coverage
+          python -m coverage report --fail-under=95 --rcfile=pyproject.toml
+      - name: Upload to Codecov
+        uses: codecov/codecov-action@v4
+        with:
+          files: coverage.xml
+          flags: cpu
+          fail_ci_if_error: false
+
+  # ── Job 5: onnx-parity ───────────────────────────────────────────────────────
+  onnx-parity:
+    name: onnx-parity
+    runs-on: ubuntu-22.04
+    needs: test-cpu
+    env:
+      TRITON_CPU_BACKEND: "1"
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+          cache: pip
+      - name: Install with ONNX extras
+        run: |
+          pip install -e ".[dev,onnx]" \
+            --extra-index-url https://download.pytorch.org/whl/cpu
+      - name: Run ONNX parity tests
+        run: pytest tests/integration/test_onnx_parity.py -v
+
+  # ── Job 6: docs-build ────────────────────────────────────────────────────────
+  docs-build:
+    name: docs-build
+    runs-on: ubuntu-22.04
+    needs: lint
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+          cache: pip
+      - name: Install docs dependencies
+        run: pip install -e ".[docs]" --extra-index-url https://download.pytorch.org/whl/cpu
+      - name: make docs
+        run: make docs

flashspec-0.1.0/.github/workflows/gpu_tests.yml

@@ -0,0 +1,54 @@
+name: GPU Tests
+
+on:
+  pull_request:
+    branches: [main]
+  schedule:
+    - cron: "0 2 * * *"  # Nightly at 02:00 UTC
+  workflow_dispatch:
+
+jobs:
+  # ── Job 1: test-gpu ──────────────────────────────────────────────────────────
+  test-gpu:
+    name: test-gpu
+    runs-on: [self-hosted, gpu, A10G]
+    timeout-minutes: 90
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+          cache: pip
+      - name: Install
+        run: pip install -e ".[dev]"
+      - name: make test-gpu
+        run: make test-gpu
+      - name: Run slow distribution tests (N=10,000 KS gate)
+        run: pytest tests/integration/test_e2e_sampling.py -m slow -x -v
+      - name: Upload coverage
+        uses: codecov/codecov-action@v4
+        with:
+          files: coverage.xml
+          flags: gpu
+          fail_ci_if_error: false
+
+  # ── Job 2: bench-quick ───────────────────────────────────────────────────────
+  bench-quick:
+    name: bench-quick
+    runs-on: [self-hosted, gpu, A10G]
+    needs: test-gpu
+    timeout-minutes: 30
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+          cache: pip
+      - name: Install bench dependencies
+        run: pip install -e ".[bench]"
+      - name: make bench-quick
+        run: make bench-quick
+      - name: Assert throughput ≥ 1.5× AR
+        # The toy benchmark prints pass/fail; exit code 1 on failure.
+        run: |
+          python benchmarks/run_all.py --config benchmarks/configs/ --toy

flashspec-0.1.0/.gitignore

@@ -0,0 +1,80 @@
+# Python
+__pycache__/
+*.py[cod]
+*.pyo
+*.pyd
+.Python
+*.egg-info/
+dist/
+build/
+*.egg
+*.whl
+
+# Virtual environments
+.venv/
+venv/
+env/
+.env
+
+# Testing & coverage
+.pytest_cache/
+.coverage
+htmlcov/
+coverage.xml
+*.cover
+
+# Mypy
+.mypy_cache/
+
+# Ruff
+.ruff_cache/
+
+# MkDocs build output (never commit)
+site/
+
+# Triton cache
+.triton/
+triton_cache/
+
+# Model weights (NEVER commit)
+*.bin
+*.safetensors
+*.pt
+*.pth
+*.gguf
+*.ggml
+hf_cache/
+models/
+
+# Benchmark results (committed selectively)
+benchmarks/results/*.json
+!benchmarks/results/baseline.json
+!benchmarks/results/.gitkeep
+
+# Jupyter
+*.ipynb
+.ipynb_checkpoints/
+
+# Paper build artefacts
+paper/*.aux
+paper/*.bbl
+paper/*.blg
+paper/*.log
+paper/*.out
+paper/*.pdf
+paper/figures/*.pdf
+paper/figures/*.png
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+.DS_Store
+Thumbs.db
+
+# Secrets
+.env
+*.key
+*.pem
+secrets/

flashspec-0.1.0/.readthedocs.yaml

@@ -0,0 +1,26 @@
+# Read the Docs configuration file
+# Required for all projects since September 2023.
+# See https://docs.readthedocs.com/platform/stable/config-file/index.html
+
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+  jobs:
+    pre_install:
+      # Install MkDocs Material and mkdocstrings before the main install step.
+      - pip install mkdocs-material mkdocstrings[python] pymdown-extensions
+
+# MkDocs configuration: point to the file at the repo root.
+mkdocs:
+  configuration: mkdocs.yml
+
+# Install the flashspec package so mkdocstrings can import it for API docs.
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs