Open
Conversation
Collaborator
napetrov
requested review from
antonwolfy,
ndgrigorian and
vlad-perevezentsev
as code owners
There was a problem hiding this comment.
Pull request overview
This PR introduces comprehensive AI agent documentation (AGENTS.md files) across the dpctl repository to guide AI assistants in understanding the codebase structure, conventions, and patterns. It also adds corresponding GitHub Copilot instruction files to enforce these patterns during code review and generation.
Changes:
- Added AGENTS.md files documenting architecture, patterns, and conventions for each major component (core bindings, tensor operations, C++ kernels, memory management, testing, and C API layer)
- Created GitHub-specific instruction files that reference the AGENTS.md documentation for automated code review guidance
- Established a root-level AGENTS.md that provides project overview and links to component-specific documentation
Reviewed changes
Copilot reviewed 17 out of 17 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| AGENTS.md | Root documentation providing project overview, architecture diagram, and directory guide |
| dpctl/AGENTS.md | Documentation for core SYCL bindings covering Cython conventions and extension type patterns |
| dpctl/tensor/AGENTS.md | Guide for Array API tensor operations and elementwise wrapper patterns |
| dpctl/tensor/libtensor/AGENTS.md | Documentation for C++ SYCL kernel implementations including functor and factory patterns |
| dpctl/memory/AGENTS.md | USM memory management documentation covering memory types and lifetime rules |
| dpctl/program/AGENTS.md | SYCL kernel compilation documentation and usage patterns |
| dpctl/utils/AGENTS.md | Utility functions documentation focusing on queue validation |
| dpctl/tests/AGENTS.md | Test suite patterns and coverage requirements |
| libsyclinterface/AGENTS.md | C API layer documentation covering naming conventions and memory ownership |
| .github/instructions/*.instructions.md | GitHub Copilot instruction files referencing AGENTS.md for each component |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
2 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.
This PR introducing initial version of AGENTS.md and instructions for copilot