Merge pull request #397 from egraphs-good/polynomials

Add polynomials example

Author: saulshanabrook

.github/AGENTS.md

@@ -58,20 +58,22 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v6
         with:
-          python-version-file: ".python-version"
+          # Work around import-time SciPy/sklearn segfaults on the codspeed ARM64 Python 3.13 runner.
+          python-version: "3.12"
       - uses: astral-sh/setup-uv@v7
         with:
           enable-cache: true
+          python-version: "3.12"
       - uses: dtolnay/rust-toolchain@1.79.0
       - uses: Swatinem/rust-cache@v2
       - run: |
           export UV_PROJECT_ENVIRONMENT="${pythonLocation}"
-          uv sync --extra test --locked
-      - uses: CodSpeedHQ/action@v4.3.1
+          uv sync --extra test --locked --python 3.12
+      - uses: CodSpeedHQ/action@v4.11.1
         with:
           token: ${{ secrets.CODSPEED_TOKEN }}
           # allow updating snapshots due to indeterministic benchmarks
-          run: pytest -vvv --snapshot-update --durations=10
+          run: pytest -vvv --snapshot-update --durations=10 --codspeed-max-rounds=10 python/tests/test_array_api.py -k "test_jit or test_run_lda"
           mode: ${{ matrix.runner == 'ubuntu-latest' && 'instrumentation' || 'walltime' }}
 
   docs:

.github/workflows/CI.yml

@@ -0,0 +1,46 @@
+# Repo Guidance
+
+## Overview
+
+- This repo combines the high-level Python bindings in `python/egglog/`, the Rust extension in `src/`, and the Sphinx docs in `docs/`.
+- Public Python APIs are exported from `python/egglog/__init__.py`.
+- The compiled `python/egglog/bindings.cpython-*.so` artifact is generated and should not be edited directly.
+
+## Common Commands
+
+- `uv sync --all-extras` installs the full dev environment.
+- `uv sync --reinstall-package egglog --all-extras` rebuilds the Rust extension after changes in `src/`.
+- `uv run pytest --benchmark-disable -q` runs the Python tests without benchmark calibration.
+- `make mypy` runs the type checker.
+- `make stubtest` checks the runtime against the type stubs.
+- `make docs` builds the docs.
+
+## Docs
+
+- Use the Context7 MCP server for egglog documentation instead of copying external doc summaries into this file.
+- Keep general workflows in the how-to guides, and keep Python-specific runtime/reference examples in `docs/reference/python-integration.md`.
+- If a PR adds or updates a changelog entry in `docs/changelog.md`, keep it aligned with the final code changes.
+- For a clean docs rebuild, clear `docs/_build/`; the MyST-NB execution cache lives in `docs/_build/.jupyter_cache`.
+
+## Python bindings
+
+- Prefer relative imports inside `python/egglog`.
+- When changing public high-level APIs, update the public docs, stubs, and pretty/freeze round-trip expectations together.
+- Higher-order callable type probing should stay isolated from the live ruleset: copy declarations and run with no current ruleset so inference does not register temporary unnamed functions or rewrites.
+
+## Array API
+
+- Start with `python/egglog/exp/array_api.py` and `python/tests/test_array_api.py`.
+- `Vec[...]` is a primitive sort; avoid rewrites or unions that merge distinct vec values.
+- Guard vector indexing rewrites with explicit bounds checks.
+
+## CI
+
+- When debugging GitHub Actions logs, prefer the private `$github-actions-rest-logs` skill or the equivalent REST API flow with `GITHUB_PAT_TOKEN`.
+
+## Verification
+
+- Prefer the minimal code change and the minimal diff that solves the task; only broaden the change if the smaller fix is not sufficient.
+- Run `make mypy` for typing changes.
+- Run targeted pytest for touched modules.
+- Run `make docs` for docs or public API changes.