Add root CLAUDE.md and minor setup.py agentic enhancements#3222
Add root CLAUDE.md and minor setup.py agentic enhancements#3222ethanglaser wants to merge 3 commits into
Conversation
There was a problem hiding this comment.
Pull request overview
This PR introduces a repository-root CLAUDE.md to provide agent guidance (build/test conventions and key architecture notes) and makes minor packaging metadata tweaks in setup.py.
Changes:
- Add
CLAUDE.mdwith build/test instructions and project conventions for agent workflows. - Expand
setup.pypackagekeywordsto include Intel/oneAPI/oneDAL and acceleration-related terms. - Remove the Apache 2.0 Trove license classifier from
setup.pyclassifiers (this looks unintentional and should be restored).
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| setup.py | Updates PyPI metadata keywords; license classifier removal needs correction. |
| CLAUDE.md | Adds root-level agent instructions referencing existing AGENTS.md structure. |
|
/intelci: run |
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:
|
| - Build: `python setup.py develop` | ||
| - Fast test subset: `pytest sklearnex/tests/test_<module>.py` | ||
| - Full suite takes ~40 min — don't run without asking | ||
| - GPU tests require dpctl; skip with `pytest -m "not gpu"` |
There was a problem hiding this comment.
Please add it to this file too:
https://github.com/uxlfoundation/scikit-learn-intelex/blob/main/doc/sources/tests.rst
| ], | ||
| keywords=["machine learning", "scikit-learn", "data science", "data analytics"], | ||
| keywords=[ | ||
| "machine learning", |
There was a problem hiding this comment.
Be aware that these aren't used for the PyPI packages.
There was a problem hiding this comment.
Good catch - looks like GitHub Topics are more relevant for discoverability and keywords are outdated. Reverting.
|
what about just linking to agents.md and having single source? |
Currently the CLAUDE.md is a minimal file that mentions AGENTS.md files provide more details. Or were you thinking something like a symlink? |
|
|
||
| - sklearnex estimators must mirror the sklearn API exactly | ||
| - Fallback to sklearn must always be preserved (oneDAL → sklearn → error) | ||
| - Don't modify files under `generator/` — they produce generated code in `daal4py/` |
There was a problem hiding this comment.
Shouldn't this instead instruct not to modify the auto-generated files like build/daal4py_cy.pyx and build/daal4py_cy.cpp? If something is wrong with those, then it should modify the files under generator/.
|
@ethanglaser If it's going to have a |
Description
Adds thin CLAUDE.md which is automatically loaded into claude code context (unlike AGENTS.md) and minor improvements to setup.py with enhancements related to agent discovery
Checklist:
Completeness and readability
Testing
Performance