Skip to content

Add root CLAUDE.md and minor setup.py agentic enhancements#3222

Open
ethanglaser wants to merge 3 commits into
uxlfoundation:mainfrom
ethanglaser:dev/eglaser-claude-friendly
Open

Add root CLAUDE.md and minor setup.py agentic enhancements#3222
ethanglaser wants to merge 3 commits into
uxlfoundation:mainfrom
ethanglaser:dev/eglaser-claude-friendly

Conversation

@ethanglaser

@ethanglaser ethanglaser commented May 29, 2026

Copy link
Copy Markdown
Contributor

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

  • I have commented my code, particularly in hard-to-understand areas.
  • I have updated the documentation to reflect the changes or created a separate PR with updates and provided its number in the description, if necessary.
  • Git commit message contains an appropriate signed-off-by string (see CONTRIBUTING.md for details).
  • I have resolved any merge conflicts that might occur with the base branch.

Testing

  • I have run it locally and tested the changes extensively.
  • All CI jobs are green or I have provided justification why they aren't.
  • I have extended testing suite if new functionality was introduced in this PR.

Performance

  • I have measured performance for affected algorithms using scikit-learn_bench and provided at least a summary table with measured data, if performance change is expected.
  • I have provided justification why performance and/or quality metrics have changed or why changes are not expected.
  • I have extended the benchmarking suite and provided a corresponding scikit-learn_bench PR if new measurable functionality was introduced in this PR.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.md with build/test instructions and project conventions for agent workflows.
  • Expand setup.py package keywords to include Intel/oneAPI/oneDAL and acceleration-related terms.
  • Remove the Apache 2.0 Trove license classifier from setup.py classifiers (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.

Comment thread setup.py
@ethanglaser

Copy link
Copy Markdown
Contributor Author

/intelci: run

@codecov

codecov Bot commented May 30, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

Flag Coverage Δ
azure 77.57% <ø> (+0.76%) ⬆️
github 71.66% <ø> (-7.26%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.
see 54 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Comment thread CLAUDE.md
- 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"`

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment thread setup.py Outdated
],
keywords=["machine learning", "scikit-learn", "data science", "data analytics"],
keywords=[
"machine learning",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Be aware that these aren't used for the PyPI packages.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch - looks like GitHub Topics are more relevant for discoverability and keywords are outdated. Reverting.

@napetrov

napetrov commented Jun 1, 2026

Copy link
Copy Markdown
Contributor

what about just linking to agents.md and having single source?

@ethanglaser

Copy link
Copy Markdown
Contributor Author

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?

Comment thread CLAUDE.md

- 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/`

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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/.

@david-cortes-intel

Copy link
Copy Markdown
Contributor

@ethanglaser If it's going to have a CLAUDE.md, might as well as .claude to gitignore.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants