Skip to content

Commit 11e624e

Browse files
committed
update agent instructions
1 parent edcde38 commit 11e624e

4 files changed

Lines changed: 19 additions & 8 deletions

File tree

.github/AGENTS.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,10 @@ CI/CD workflows, automation, security scanning, and package distribution.
44

55
## Workflows
66
- **conda-package.yml** — main build/test pipeline (Linux/Windows, Python 3.10-3.14)
7+
- **conda-package-cf.yml** — build/test using only conda-forge channel (Linux/Windows, Python 3.10-3.14)
78
- **build-with-clang.yml** — Linux Clang compiler compatibility validation
9+
- **build-with-standard-clang.yml** — standard Clang compiler compatibility validation
10+
- **build_pip.yml** — validates editable build
811
- **pre-commit.yml** — code quality checks (flake8, etc.)
912
- **openssf-scorecard.yml** — security posture scanning
1013

.github/copilot-instructions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Higher-precedence file overrides; lower must not restate overridden guidance.
3737
- Build/config: `pyproject.toml`, `setup.py`
3838
- Recipe/deps: `conda-recipe/meta.yaml`, `conda-recipe/conda_build_config.yaml`
3939
- CI: `.github/workflows/*.{yml,yaml}`
40-
- API contracts: `mkl/__init__.py`, `mkl/_mkl_service.pyx`
40+
- API contracts: `mkl/__init__.py`, `mkl/_py_mkl_service.pyx`
4141
- Tests: `mkl/tests/test_mkl_service.py`
4242

4343
## MKL-specific constraints

AGENTS.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,29 +15,35 @@ Originally part of Intel® Distribution for Python*, now a standalone package av
1515

1616
## Key components
1717
- **Python interface:** `mkl/__init__.py` — public API surface
18-
- **Cython wrapper:** `mkl/_mkl_service.pyx` — wraps MKL support functions
18+
- **Cython wrapper:** `mkl/_py_mkl_service.pyx` — wraps MKL support functions
1919
- **C init module:** `mkl/_mklinitmodule.c` — Linux-side MKL runtime preloading / initialization
2020
- **Helper:** `mkl/_init_helper.py` — Windows venv DLL loading helper
21-
- **Build system:** setuptools + Cython
21+
- **Build system:** meson-python + Cython
2222

2323
## Build dependencies
2424
**Required:**
2525
- Intel® oneMKL
26+
- meson-python
27+
- CMake
28+
- Ninja
2629
- Cython
2730
- Python 3.10+
2831

2932
**Conda environment:**
3033
```bash
31-
conda install -c conda-forge mkl-devel cython
32-
python setup.py install
34+
conda install -c conda-forge mkl-devel cython meson-python cmake ninja
35+
python -m pip install --no-deps --no-build-isolation .
3336
```
3437

3538
## CI/CD
3639
- **Platforms in CI workflows:** Linux, Windows
3740
- **Python versions:** 3.10, 3.11, 3.12, 3.13, 3.14
3841
- **Workflows:** `.github/workflows/`
3942
- `conda-package.yml` — main conda build/test pipeline
43+
- `conda-package-cf.yml — conda build/test using only conda-forge channel
4044
- `build-with-clang.yml` — Linux Clang compatibility
45+
- `build-with-standard-clang.yml` — standard Clang compiler compatibility validation
46+
- `build_pip` — validates editable build
4147
- `pre-commit.yml` — code quality checks
4248
- `openssf-scorecard.yml` — security scanning
4349

@@ -85,4 +91,6 @@ Below directories have local `AGENTS.md` for deeper context:
8591
For broader IntelPython ecosystem context, see:
8692
- `mkl_umath` (MKL-backed NumPy ufuncs)
8793
- `mkl_random` (MKL-based random number generation)
94+
- `mkl_fft` (MKL-based fast fourier transform functions)
8895
- `dpnp` (Data Parallel NumPy)
96+
- `dpctl` (Data Parallel Control)

mkl/AGENTS.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ Core Python/Cython implementation: MKL support function wrappers and runtime con
44

55
## Structure
66
- `__init__.py` — public API, RTLD_GLOBAL context manager, module initialization
7-
- `_mkl_service.pyx` — Cython wrappers for MKL support functions
8-
- `_mkl_service.pxd` — Cython declarations (C function signatures)
7+
- `_py_mkl_service.pyx` — Cython wrappers for MKL support functions
8+
- `_py_mkl_service.pxd` — Cython declarations (C function signatures)
99
- `_mklinitmodule.c` — C extension for Linux-side MKL runtime preloading/init
1010
- `_init_helper.py` — Windows loading helper (DLL path setup in venv)
1111
- `_version.py` — version string (dynamic via setuptools)
@@ -41,7 +41,7 @@ Core Python/Cython implementation: MKL support function wrappers and runtime con
4141
- **RTLD_GLOBAL preload path:** Linux preload is handled in `_mklinitmodule.c`; Windows DLL setup is in `_init_helper.py`
4242

4343
## Cython details
44-
- `_mkl_service.pyx` → generates `_py_mkl_service` extension module
44+
- `_py_mkl_service.pyx` → generates `_py_mkl_service` extension module
4545
- `.pxd` file declares external C functions from MKL headers
4646
- Cython build requires MKL headers (`mkl-devel`)
4747

0 commit comments

Comments
 (0)