yapocis 1.0.0__tar.gz

yapocis-1.0.0/.gitignore

@@ -0,0 +1,48 @@
+\#*
+*.pyc
+*.ocl
+*.swp
+*.pyd
+*.so
+*.o
+*.lo
+*.la
+*~
+*.bak
+*.swp
+*.png
+*.svg
+.\#*
+*.log
+.deps
+.libs
+__pycache__
+#*
+/.claude
+.env
+/src/yapocis/mako_modules
+/queue
+/opencl_cache
+/prof
+/.idea
+/build
+/dist
+/scipy.egg-info
+/site.cfg
+/docs/_build/
+/docs/frontpage/build
+/docs/source/generated
+/yapocis.egg-info/
+/.pydevproject
+/.project
+/src/yapocis/icons/*/*
+/performance
+/performance/reports/
+/code_cache
+/claude-debug/*
+*#checkin.txt*
+env
+pyproject.toml.example
+scripts/release.py
+segment.py
+test_vad_yapocis.py

yapocis-1.0.0/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "external"]
+	path = external
+	url = git@github.com:seantrue/yapocis-external.git

yapocis-1.0.0/.python-version

@@ -0,0 +1 @@
+3.13

yapocis-1.0.0/.readthedocs.yml

@@ -0,0 +1,26 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+build:
+   os: ubuntu-24.04
+   tools:
+      python: "3.13"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+# Optionally build your docs in additional formats such as PDF
+formats:
+   - pdf
+
+# Install yapocis itself so autodoc can import it, then the Sphinx tooling
+python:
+   install:
+   - method: pip
+     path: .
+   - requirements: docs/requirements.txt

yapocis-1.0.0/.settings/org.eclipse.core.resources.prefs

@@ -0,0 +1,3 @@
+#Sun Aug 21 10:33:41 EDT 2011
+eclipse.preferences.version=1
+encoding//doc/conf.py=utf-8

yapocis-1.0.0/AGENTS.md

@@ -0,0 +1,45 @@
+# Repository Guidelines
+
+## Project Structure & Module Organization
+- `yapocis/` – core package:
+  - `ocl/` OpenCL devices, buffers, kernel build (`DeviceManager`, `KernelManager`).
+  - `core/` shared utilities (backend selection, autotune, tunecache, interface parsing).
+  - `cu/` and `cukernels/` CUDA support via CuPy and Mako templates.
+  - `interfaces/`, `kernels/` interface DSL and Mako kernel templates.
+- `tests/` – pytest suite (`test_*.py`).
+- `examples/` – runnable demos and performance scripts.
+- `docs/` – documentation (Read the Docs).
+- `scripts/` – helper utilities (e.g., `scripts/imagewatcher.py`).
+
+## Build, Test, and Development Commands
+- Create env + install:
+  - `make install-dev` (recommended)
+  - Or manually: `uv venv .venv && source .venv/bin/activate && uv pip install -e ".[dev]"`
+- Run tests:
+  - `make test` (all available backends)
+  - `make test-ocl` (OpenCL only)
+  - `make test-metal` (Metal only)
+  - `pytest -q` (direct pytest, example: `pytest tests/backend/test_smoke.py -q`)
+- Run examples: `python examples/matplotlib_median_performance.py`.
+
+## Coding Style & Naming Conventions
+- Python, 4‑space indentation, PEP 8. Use type hints where practical.
+- Names: modules/files `snake_case.py`; functions/vars `snake_case`; classes `PascalCase`; constants `UPPER_SNAKE`.
+- Keep functions small and documented; module/class/function docstrings use triple quotes with a one‑line summary.
+- Prefer explicit imports within the `yapocis` namespace.
+
+## Testing Guidelines
+- Framework: pytest. Place tests in `tests/` named `test_*.py` with clear arrange/act/assert sections.
+- Include GPU/CPU expectations and deterministic assertions. Add a focused test for each new kernel or interface.
+- Quick loop: `pytest -k <keyword> -q`.
+
+## Commit & Pull Request Guidelines
+- Commits: concise, imperative subject (≤72 chars). Example: `Add CUDA tunecache path handling`.
+- Reference issues: `Fixes #123` or `Refs #123` when applicable.
+- PRs must include: summary, rationale, affected modules, how to test (commands), and backend/hardware tested (e.g., `OpenCL CPU`, `CUDA RTX 3060`). Add screenshots/SVGs if output changes; update docs/examples when behavior or APIs change.
+
+## Security & Configuration Tips
+- Do not commit secrets or large artifacts. Prefer sample data in `examples/`.
+- Useful env vars: `YAPOCIS_BACKEND` (`ocl`|`cuda`), `YAPOCIS_DEVICE` (device name/index), `YAPOCIS_CACHE` (kernel cache dir), `YAPOCIS_TUNECACHE` (autotune JSON path), `YAPOCIS_PROJECT` (extra asset root), `YAPOCIS_VIEWER` (image viewer).
+- See `OVERVIEW.md` for architecture details and asset lookup behavior.
+