zeropybench 0.2__tar.gz → 0.4__tar.gz

zeropybench-0.4/.github/workflows/ci.yml

@@ -0,0 +1,82 @@
+name: CI
+
+on:
+  push:
+    branches:
+    - main
+  pull_request:
+    branches:
+    - main
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+
+  pre-commit:
+    name: Pre-commit
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: j178/prek-action@v1
+
+  test:
+    name: Run tests on Python ${{ matrix.python.version }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python:
+        - version: '3.10'
+          jax: '>=0.4,<0.5'
+        - version: '3.11'
+          jax: '>=0.4,<0.5'
+        - version: '3.12'
+          jax: '>=0.5,<0.6'
+        - version: '3.13'
+          jax: '>=0.5,<0.6'
+        - version: '3.14'
+          jax: '>=0.8'
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python.version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python.version }}
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+
+      - name: Build wheel
+        run: uv build --wheel
+
+      - name: Install project's wheel and dependencies
+        run: |
+          uv sync --locked --no-install-project
+          uv pip install dist/zeropybench-*.whl
+          uv pip install "jax${{ matrix.python.jax }}"
+
+      - name: Run unit tests
+        run: uv run pytest -v --cov=zeropybench --cov-report=xml tests
+
+      - name: Install system dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y graphviz
+
+      - name: Run notebook tests
+        if: matrix.python.version == '3.14'
+        run: uv run pytest -v docs
+
+      - name: Upload coverage to Codecov
+        if: matrix.python.version == '3.12'
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: coverage.xml
+          fail_ci_if_error: false

{zeropybench-0.2 → zeropybench-0.4}/.github/workflows/release.yml

@@ -17,22 +17,26 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v4
         with:
-          fetch-depth: 0
+          fetch-depth: 0  # Full history for dynamic versioning
 
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
-          python-version: '3.10'
+          python-version: '3.12'
 
       - name: Install uv
         uses: astral-sh/setup-uv@v6
         with:
           enable-cache: true
 
-      - name: Check tag of last commit
+      - name: Debug Git tags and versioning
         run: |
+          echo "Git tags:"
+          git tag -l
           echo "Current tag:"
-          git describe --tags --exact-match HEAD
+          git describe --tags --exact-match HEAD || echo "No exact tag match"
+          echo "Version info:"
+          git describe --tags --always
 
       - name: Clean uv cache for dynamic versioning
         run: uv cache clean
@@ -40,5 +44,11 @@ jobs:
       - name: Build package
         run: uv build
 
+      - name: Verify build artifacts
+        run: |
+          ls -la dist/
+          echo "Built artifacts:"
+          find dist/ -name "*.whl" -o -name "*.tar.gz" | head -10
+
       - name: Publish to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1

zeropybench-0.4/.gitignore

@@ -0,0 +1,14 @@
+/.idea/
+/.venv/
+/.vscode/
+/build/
+/dist/
+/docs/build/
+
+.ipynb_checkpoints/
+__pycache__/
+
+.coverage
+.DS_Store
+*.py[cod]
+coverage.xml

zeropybench-0.4/.pre-commit-config.yaml

@@ -0,0 +1,46 @@
+repos:
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: "v0.11.8"
+  hooks:
+    - id: ruff
+      name: ruff linting
+    - id: ruff-format
+      name: ruff formatting
+
+- repo: https://github.com/nbQA-dev/nbQA
+  rev: "1.9.1"
+  hooks:
+    - id: nbqa-ruff
+      name: nbqa ruff linting
+      args: [--fix, --ignore=E402]
+    - id: nbqa-ruff-format
+      name: nbqa ruff formatting
+
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: 'v5.0.0'
+  hooks:
+  - id: trailing-whitespace
+  - id: end-of-file-fixer
+  - id: check-merge-conflict
+
+- repo: https://github.com/kynan/nbstripout
+  rev: 0.6.1
+  hooks:
+  - id: nbstripout
+    name: notebook stripping
+    args: [--extra-keys=metadata.language_info.version]
+
+- repo: https://github.com/pre-commit/mirrors-mypy
+  rev: 'v1.15.0'
+  hooks:
+  - id: mypy
+    additional_dependencies:
+    - jax
+    - polars
+    - matplotlib
+    args:
+    - --strict
+    - --show-error-codes
+    - --enable-error-code=ignore-without-code
+    - --allow-untyped-calls
+    files: ^src/zeropybench/

zeropybench-0.4/.readthedocs.yaml

@@ -0,0 +1,28 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version, and other tools you might need
+build:
+  os: ubuntu-24.04
+  apt_packages:
+    - graphviz
+  tools:
+    python: "3.14"
+  jobs:
+    install:
+      - pip install --upgrade pip
+      - pip install --group docs .
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  builder: html
+  configuration: docs/source/conf.py
+  fail_on_warning: false
+
+# Set the version of Python and other tools you might need
+submodules:
+  include: all
+  recursive: true

{zeropybench-0.2 → zeropybench-0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: zeropybench
-Version: 0.2
+Version: 0.4
 Summary: A multidimensional benchmarking library with minimal overhead
 Author: Pierre Chanial
 License-Expression: MIT
@@ -31,6 +31,8 @@ Description-Content-Type: text/markdown
 [![Continuous integration](https://github.com/pchanial/zeropybench/actions/workflows/ci.yml/badge.svg)](https://github.com/pchanial/zeropybench/actions/workflows/ci.yml)
 [![Coverage](https://codecov.io/gh/pchanial/zeropybench/graph/badge.svg)](https://codecov.io/gh/pchanial/zeropybench)
 
+<!-- Start common text with source/index.md -->
+
 **zeropybench** is a Python benchmarking library with zero overhead, designed for multidimensional performance analysis.
 
 ## Features
@@ -84,7 +86,7 @@ print(bench)
 
 ## JAX Support
 
-zeropybench automatically detects JAX arrays and optimizes benchmarking accordingly:
+ZeroPyBench automatically detects JAX arrays and optimizes benchmarking accordingly:
 
 ```python
 import jax.numpy as jnp
@@ -145,6 +147,8 @@ Benchmark(
 )
 ```
 
+<!-- End common text with source/index.md -->
+
 ## License
 
 MIT

{zeropybench-0.2 → zeropybench-0.4}/README.md

@@ -10,6 +10,8 @@
 [![Continuous integration](https://github.com/pchanial/zeropybench/actions/workflows/ci.yml/badge.svg)](https://github.com/pchanial/zeropybench/actions/workflows/ci.yml)
 [![Coverage](https://codecov.io/gh/pchanial/zeropybench/graph/badge.svg)](https://codecov.io/gh/pchanial/zeropybench)
 
+<!-- Start common text with source/index.md -->
+
 **zeropybench** is a Python benchmarking library with zero overhead, designed for multidimensional performance analysis.
 
 ## Features
@@ -63,7 +65,7 @@ print(bench)
 
 ## JAX Support
 
-zeropybench automatically detects JAX arrays and optimizes benchmarking accordingly:
+ZeroPyBench automatically detects JAX arrays and optimizes benchmarking accordingly:
 
 ```python
 import jax.numpy as jnp
@@ -124,6 +126,8 @@ Benchmark(
 )
 ```
 
+<!-- End common text with source/index.md -->
+
 ## License
 
 MIT

zeropybench-0.4/docs/source/api/index.md

@@ -0,0 +1,10 @@
+# API Reference
+
+## Benchmark
+
+```{eval-rst}
+.. autoclass:: zeropybench.Benchmark
+   :members:
+   :undoc-members:
+   :show-inheritance:
+```

zeropybench-0.4/docs/source/conf.py

@@ -0,0 +1,91 @@
+"""Sphinx configuration file for zeropybench documentation."""
+
+import sys
+from importlib.metadata import version as get_version
+from pathlib import Path
+
+# Add the src directory to the Python path
+src_path = Path(__file__).parent.parent.parent / 'src'
+sys.path.insert(0, str(src_path))
+
+# Project information
+project = 'zeropybench'
+copyright = '2025, Pierre Chanial'
+author = 'Pierre Chanial'
+release = get_version('zeropybench')
+version = '.'.join(release.split('.')[:2])  # Major.minor
+
+# General configuration
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.napoleon',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.mathjax',
+    'myst_parser',
+    'nbsphinx',
+]
+
+templates_path = ['_templates']
+exclude_patterns = []
+
+# HTML output configuration
+html_theme = 'furo'
+html_static_path = ['_static']
+html_title = f'{project} v{version}'
+html_theme_options = {
+    'light_css_variables': {
+        'color-brand-primary': '#2EBF4F',
+        'color-brand-content': '#2EBF4F',
+    },
+    'dark_css_variables': {
+        'color-brand-primary': '#34D058',
+        'color-brand-content': '#34D058',
+    },
+}
+
+# Extension configuration
+autodoc_default_options = {
+    'members': True,
+    'undoc-members': True,
+    'show-inheritance': True,
+    'special-members': '__init__',
+}
+autodoc_typehints = 'description'  # Show type hints in parameter descriptions
+
+# Napoleon settings
+napoleon_google_docstring = True
+napoleon_numpy_docstring = True
+napoleon_include_init_with_doc = False
+napoleon_include_private_with_doc = False
+
+# MyST parser configuration
+myst_enable_extensions = [
+    'colon_fence',
+    'deflist',
+    'dollarmath',
+    'html_admonition',
+    'html_image',
+    'linkify',
+    'replacements',
+    'smartquotes',
+    'substitution',
+    'tasklist',
+]
+
+# Intersphinx mapping
+intersphinx_mapping = {
+    'python': ('https://docs.python.org/3', None),
+    'jax': ('https://jax.readthedocs.io/en/latest/', None),
+    'numpy': ('https://numpy.org/doc/stable/', None),
+    'polars': ('https://docs.pola.rs/api/python/stable/', None),
+}
+
+# nbsphinx configuration
+nbsphinx_execute = 'always'  # Execute notebooks during build
+nbsphinx_allow_errors = True  # Continue building even if there are errors
+nbsphinx_timeout = 300  # Timeout for notebook execution in seconds
+
+# Additional nbsphinx settings
+nbsphinx_execute_arguments = []

zeropybench-0.4/docs/source/developer-guide.md

@@ -0,0 +1,124 @@
+# Development
+
+## Development Setup
+
+1. Clone the repository:
+```bash
+git clone https://github.com/pchanial/zeropybench.git
+cd zeropybench
+```
+
+2. Install in development mode:
+```bash
+pip install --group dev -e .
+or
+uv sync
+```
+3. Install `pre-commit` (or equivalently `prek`):
+```bash
+pipx --user install pre-commit
+or
+uv tool install pre-commit
+```
+The pre-commit hooks need to be installed (see more details in the section [Code Quality](#code-quality)). After doing so, they will be run at each commit.
+```
+pre-commit install
+```
+
+## Running Tests
+
+The project uses pytest for testing:
+
+```bash
+# Run all tests
+pytest
+
+# Run with verbose output
+pytest -v
+
+# Run notebook tests
+pytest docs/source/user-guide/
+
+# Run specific test file
+pytest tests/test_jax.py
+```
+
+The test suite includes:
+- **Unit tests**: Individual function testing
+- **JAX tests**: JAX-specific benchmarking tests
+- **Functional tests**: The documentation notebooks
+
+## Code Quality
+
+The project uses several pre-commit hooks for code quality. They include
+- ruff (linting and formatting)
+- mypy (type checking)
+- and others
+
+The pre-commit will be run against the files that are part of a Git commit. To run against all files
+(modified but not added or already committed):
+```bash
+pre-commit run --all-files
+```
+
+## Documentation
+
+Build documentation locally:
+The dependencies required to build the documentation have already been installed through `uv sync`. If you prefer using
+pip, this extra step is required:
+```bash
+pip install --group docs .
+```
+
+Then, the HTML documentation is built and inspected by:
+```
+cd docs
+make html
+firefox build/html/index.html
+```
+
+The documentation uses:
+- **Sphinx**: Documentation generator
+- **MyST**: Markdown support in Sphinx
+- **Furo**: Clean, responsive theme
+- **nbsphinx**: Jupyter notebook support
+
+
+## Project Structure
+
+```
+zeropybench/
+├── src/zeropybench/          # Main package
+│   ├── __init__.py            # Public API exports
+│   ├── _benchmark.py          # Benchmark class
+│   └── _jax.py                # JAX code transformation utilities
+├── tests/                  # Test suite
+│   ├── test_benchmark.py      # Benchmark tests
+│   └── test_jax.py            # JAX-specific tests
+├── docs/                   # Documentation
+│   └── source/
+│       ├── user-guide/        # User guide and examples
+│       ├── api/               # API reference
+│       └── developer-guide.md # This file
+├── .github/                # CI/CD workflows
+└── pyproject.toml          # Project configuration
+```
+
+## Contributing
+
+1. Fork the repository
+2. Install pre-commit
+3. Create a feature branch: `git checkout -b feature-name`
+4. Make your changes
+5. Add tests for new functionality
+6. Ensure all tests pass: `pytest`
+7. Submit a pull request
+
+## Release Process
+
+Releases are automated through GitHub Actions:
+
+1. Create a new tag: `git tag v0.x.x`
+2. Push the tag: `git push origin v0.x.x`
+3. Create a GitHub release
+4. The CI will automatically build and publish to PyPI

zeropybench-0.4/docs/source/index.md

@@ -0,0 +1,47 @@
+<div align="center">
+<img src="_static/logo.svg" alt="zeropybench" width="100%">
+</div>
+
+
+# Documentation
+
+[![PyPI version](https://img.shields.io/pypi/v/zeropybench?color=%232EBF4F)](https://pypi.org/project/zeropybench)
+[![Python versions](https://img.shields.io/pypi/pyversions/zeropybench.svg?color=%232EBF4F)](https://pypi.org/project/zeropybench)
+
+```{include} ../../README.md
+---
+start-after: "<!-- Start common text with source/index.md -->"
+end-before: "<!-- End common text with source/index.md -->"
+---
+```
+
+## Content
+
+```{toctree}
+:maxdepth: 2
+:caption: User Guide
+
+user-guide/installation
+user-guide/getting-started
+user-guide/jax-examples
+```
+
+```{toctree}
+:maxdepth: 2
+:caption: API Reference
+
+api/index
+```
+
+```{toctree}
+:maxdepth: 1
+:caption: Developer Guide
+
+developer-guide
+```
+
+## Indices and tables
+
+- {ref}`genindex`
+- {ref}`modindex`
+- {ref}`search`