Add AGENTS.md and GitHub Copilot instructions#91
Open
Conversation
Introduce structured AI agent instructions following Intel's AGENTS spec v4: - AGENTS.md: project context (RNG interface, archetype, structure, source-of-truth) - .github/copilot-instructions.md: agent behavior policy Key guidance: - Preserve numpy.random API compatibility - RNG specifics: BRNG selection, statistical properties - Cython: release GIL for MKL RNG calls (thread-safe) - Local dev: conda env + pip install -e . - Statistical validation required for RNG changes Token budget: 217 words (AGENTS.md) + copilot-instructions Based on mkl_fft pattern
napetrov
requested review from
antonwolfy,
jharlow-intel,
ndgrigorian and
xaleryb
as code owners
Author
|
Updated PR with a more useful multi-level AGENTS hierarchy (commit b0e4a38):
This keeps instructions concise at root and more actionable in each working directory. |
antonwolfy
reviewed
Mar 5, 2026
| ## Key components | ||
| - **Python package:** `mkl_random/` | ||
| - **Cython layer:** `mkl_random/mklrand.pyx` | ||
| - **C backend/templates:** `mkl_random/src/` |
Collaborator
There was a problem hiding this comment.
I guess there is no templates in mkl_random, but .cpp and .h files only in src folder
Collaborator
|
@napetrov RandomState in numpy_random interface aligned to numpy's numpy.random.RandomState, and mkl_random.interfaces.numpy_random is fully aligned to numpy.random namespace (aside from get_state and set_state, which cannot be) patch will also be coming soon otherwise if above comment fixed, LGTM |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Add structured AI agent instructions following Intel's AGENTS spec v4:
AGENTS.md— project context for agents (RNG interface, archetype, structure, source-of-truth mapping).github/copilot-instructions.md— agent behavior policy (precedence, contribution expectations, Intel-specific constraints)Why
Standardizes how AI coding assistants (GitHub Copilot, Claude, etc.) understand and work with this repo, reducing hallucinations and enforcing Intel engineering standards automatically.
Key guidance added
numpy.randomAPI compatibility by defaultwith nogil:) for MKL RNG calls (thread-safe in MKL)__init__.pyconda create -n dev python numpy cython mkl-devel pytest && pip install -e .Token budget
AGENTS.md: 217 words (limit 220)Checklist