Repository navigation
Improve agent documentation - #3435
ethanglaser wants to merge 8 commits into
Conversation
…ctions - Root AGENTS.md: replace stale version-support claims with pointers to the checks in setup.py; add build/test commands and cross-cutting change rules. - New onedal/datatypes/AGENTS.md: Python C-API reference ownership rules. - tests/, sklearnex/, doc/, src/, daal4py/: add rules drawn from recurring review comments; close an unclosed code fence in tests/AGENTS.md; correct daal4py guidance that suggested editing generated sources. - .github/instructions: add applyTo frontmatter so Copilot loads them, and fix the AGENTS.md links, which resolved under .github/. - Add .github/copilot-instructions.md routing to the nested AGENTS.md files. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Drop user-facing install, GPU troubleshooting, algorithm and speedup lists that an agent cannot act on or that were unverified; keep architecture, build/test commands, version floors and rules. ASCII only. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests.
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
Unresolved review comments identify documentation accuracy and consistency issues.
Get a fresh assessment by requesting another Copilot review.
Review effort: Lite
Findings: 2
Open (2)
What changed in this PR
This PR improves repository and Copilot guidance through consolidated AGENTS.md files, testing documentation, and instruction wiring.
Changes:
- Streamlined repository and subsystem guidance.
- Added testing, compatibility, ownership, and documentation rules.
- Enabled scoped Copilot instructions and corrected links.
| File | Summary |
|---|---|
tests/AGENTS.md |
Adds test matrix and deselection guidance. |
src/AGENTS.md |
Adds C++ error-reporting guidance. |
sklearnex/AGENTS.md |
Adds compatibility guidance. |
onedal/datatypes/AGENTS.md |
Adds C-API ownership and aliasing rules. |
onedal/AGENTS.md |
Links to datatype guidance. |
doc/AGENTS.md |
Adds documentation maintenance rules. |
daal4py/AGENTS.md |
Clarifies generator usage. |
AGENTS.md |
Consolidates repository-wide guidance. |
.github/instructions/tests.instructions.md |
Adds scoped instruction metadata and corrected links. |
.github/instructions/src.instructions.md |
Adds scoped instruction metadata and corrected links. |
.github/instructions/sklearnex.instructions.md |
Adds scoped instruction metadata and corrected links. |
.github/instructions/onedal.instructions.md |
Adds scoped instruction metadata and corrected links. |
.github/instructions/general.instructions.md |
Adds scoped instruction metadata and corrected links. |
.github/instructions/daal4py.instructions.md |
Adds scoped instruction metadata and corrected links. |
.github/instructions/build-config.instructions.md |
Adds scoped instruction metadata and corrected links. |
.github/copilot-instructions.md |
Adds the repository-wide Copilot entry point. |
.github/.licenserc.yaml |
Exempts Copilot instructions from license checks. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Signed-off-by: ethanglaser <ethan.glaser@intel.com>
|
I ran the same base-vs-head analysis I did for oneDAL #3812 on this PR (base 95ad281, head 15ca9e6). Overall this is a clear improvement: the root file is about twice as dense, almost nothing actionable is lost, and most of what was removed was wrong. A few things are worth fixing before merge. Still wrong at head
Checked and correct
What was removed
Does it teach models anything?
Method and dataMechanical claim check with hand adjudication; review comments from the GitHub API (10,364, Copilot excluded); github/docs source and history; gpt-6-luna fact extraction and judge; four answer models, reported per model, never pooled; gpt-6-sol for the retention check. Spend about $10. Not measured: task-level effect on real coding or review runs. |
|
@napetrov thanks for the detailed analysis, I've applied updates based on your feedback |

Description
1. Rules taken from review comments
AGENTS.md: the same core rules as oneDAL #3812, plus type hints and numpydoc on new functions.onedal/datatypes/AGENTS.md: Python C-API reference ownership, based on 9 threads about real leaks and aliasing bugs.onedal/AGENTS.mdnow links to it.tests/AGENTS.md:target_offload; dpnp, torch andarray_api_strict)deselected_tests.yamlentriessklearnex/AGENTS.md: delete version checks that are dead now that the minimum scikit-learn version has moved, and keep scikit-learn conformance logic insklearnex/rather thanonedal/.doc/AGENTS.md: keep docs in sync with the code, and use the Sphinx roles and substitutions reviewers ask for.2. Trimming
AGENTS.md(+48/−143, from 185 lines to about 70): removed install steps for users, algorithm and GPU-support lists, the "up to 100X" claim, GPU troubleshooting, and the list of runtime errors. Kept the architecture, key files, build and test commands (checked againstsetup.pyandrun_test.sh), minimum versions and code generation. It's ASCII only.3. Drop the Copilot instruction files
.github/copilot-instructions.mdand.github/instructions/*. Copilot code review and the coding agent both read AGENTS.md, so they only duplicated it. Onmainthey also lackapplyTo:frontmatter, so Copilot has never loaded them.sklearnex/,onedal/,src/anddaal4py/AGENTS.md, and the in-place rebuild commands in the root file. Adaal4py/sklearn/tests/path that doesn't exist was dropped.AGENTS.md: Rules for Changes and a new Reviewing section now come first, because the root file is the one Copilot code review is documented to read. Two rules were added there: thesklearnex/-vs-onedal/layering andPyObject*ownership..licenserc.yaml: dropped the two exemptions for the removed files.Checklist:
Completeness and readability
Testing
Performance
🤖 Generated with Claude Code