Add production infrastructure: documentation, testing, CI/CD, and examples

.github/workflows/tests.yml

@@ -0,0 +1,70 @@
+name: Tests
+
+on:
+  push:
+    branches: [ main, develop ]
+  pull_request:
+    branches: [ main, develop ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.8', '3.9', '3.10', '3.11']
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install pytest pytest-cov pyyaml numpy matplotlib
+        # Install CPU-only PyTorch for CI (no GPU required for basic tests)
+        pip install torch torchvision --index-url https://download.pytorch.org/whl/cpu
+
+    - name: Run config tests
+      run: |
+        pytest tests/test_config.py -v
+
+    - name: Run mask tests (CPU only)
+      run: |
+        pytest tests/test_masks.py -v
+
+    - name: Test imports
+      run: |
+        python -c "from src import config, distributed, logging_utils, metrics, workloads"
+        python -c "from src.sparsity import masks, semistructured"
+        python -c "from src.methods import dense_single, dense_tp, block_shock, masked_split_dense"
+
+    - name: Test main --help
+      run: |
+        python -m src.main --help
+
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.10'
+
+    - name: Install linting tools
+      run: |
+        python -m pip install --upgrade pip
+        pip install flake8
+
+    - name: Lint with flake8
+      run: |
+        # Stop the build if there are Python syntax errors or undefined names
+        flake8 src/ --count --select=E9,F63,F7,F82 --show-source --statistics
+        # Exit-zero treats all errors as warnings. Line length set to 100
+        flake8 src/ --count --exit-zero --max-complexity=10 --max-line-length=100 --statistics

.gitignore

@@ -3,6 +3,78 @@ results/raw/
 results/tables/
 results/plots/
 
-# Python bytecode
+# Python bytecode and cache
 __pycache__/
-*.pyc
+*.py[cod]
+*$py.class
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+*.manifest
+*.spec
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Virtual environments
+venv/
+ENV/
+env/
+.venv
+
+# IDEs
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+.DS_Store
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# Environment variables
+.env
+.env.local
+
+# PyTorch
+*.pth
+*.pt
+
+# Temporary files
+*.log
+*.tmp
+tmp/
+temp/