-
Notifications
You must be signed in to change notification settings - Fork 184
Introducing agents instructions for the repo #2695
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think a lot of what this PR introduces will get outdated as soon as any non-trivial change is made (e.g. additional examples, refactorings that move things across files, new software releases, rewrites of some doc page, among others).
- **Setup**: Requires MPI (Intel MPI or OpenMPI), mpi4py | ||
- **Testing**: `mpirun -n 4` for validation | ||
|
||
**MPI Requirements** (from setup.py): |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This doesn't look relevant.
- **oneDAL**: Downloads nightly builds from upstream oneDAL repo | ||
- **Python**: Matrix testing across Python 3.9-3.13 (verified in .ci/pipeline/ci.yml) | ||
- **sklearn**: Multiple version compatibility (1.0-1.7) | ||
- **GPU Libraries**: dpctl, dpnp for Intel GPU acceleration |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing torch.
## Build Dependencies | ||
- **oneDAL**: Downloads nightly builds from upstream oneDAL repo | ||
- **Python**: Matrix testing across Python 3.9-3.13 (verified in .ci/pipeline/ci.yml) | ||
- **sklearn**: Multiple version compatibility (1.0-1.7) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is bound to get outdated. Perhaps could rephrase it as "all sklearn versions beyond 1.0", or "last 3 releases of sklearn", or something like that.
## Quality Gates | ||
- **Linting**: black, isort, clang-format, numpydoc validation | ||
- **Testing**: pytest with cross-platform compatibility | ||
- **Coverage**: codecov integration with threshold enforcement |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think we have a threshold enforcement from codecov.
|
||
### Platform-Specific Build Commands | ||
|
||
**Linux/macOS** (from .ci/pipeline/build-and-test-lnx.yml): |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We don't support macOS.
|
||
# Set up environment | ||
source /opt/intel/oneapi/compiler/latest/env/vars.sh | ||
export DPCPPROOT=/opt/intel/oneapi/compiler/latest |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is not needed.
- **Statistics**: Basic statistics, covariance | ||
|
||
## For AI Agents | ||
- Use `config_context` for device selection |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is not meant to be used inside onedal/
.
@@ -0,0 +1,80 @@ | |||
# AGENTS.md - Code Generator (generator/) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think this folder warrants a file for agents.
Description