Introducing AGENTS.md

.github/instructions/cython.instructions.md

@@ -0,0 +1,22 @@
+---
+applyTo:
+ - "dpctl/**/*.pyx"
+ - "dpctl/**/*.pxd"
+ - "dpctl/**/*.pxi"
+---
+
+# Cython Instructions
+
+See `dpctl/AGENTS.md` for full conventions.
+
+## Required Directives (after license)
+```cython
+# distutils: language = c++
+# cython: language_level=3
+# cython: linetrace=True
+```
+
+## Key Rules
+- `cimport` for C-level, `import` for Python-level
+- Store C refs as `_*_ref`, clean up in `__dealloc__` with NULL check
+- Use `with nogil:` for blocking C operations

.github/instructions/dpctl.instructions.md

@@ -0,0 +1,26 @@
+---
+applyTo:
+ - "**/*.py"
+ - "**/*.pyx"
+ - "**/*.pxd"
+ - "**/*.cpp"
+ - "**/*.hpp"
+ - "**/*.h"
+---
+
+# DPCTL General Instructions
+
+See `AGENTS.md` at repository root for project overview and architecture.
+Each major directory has its own `AGENTS.md` with specific conventions.
+
+## Key References
+
+- **Code style:** `.pre-commit-config.yaml`, `.clang-format`, `.flake8`
+- **License:** Apache 2.0 with Intel copyright - match existing file headers
+
+## Critical Rules
+
+1. **Device compatibility:** Not all devices support fp64/fp16 - never assume availability
+2. **Queue consistency:** Memory operations must use compatible queues
+3. **Resource cleanup:** Clean up C resources in `__dealloc__` with NULL check
+4. **NULL checks:** Always check C API returns before use

.github/instructions/libsyclinterface.instructions.md

@@ -0,0 +1,23 @@
+---
+applyTo:
+ - "libsyclinterface/**/*.h"
+ - "libsyclinterface/**/*.hpp"
+ - "libsyclinterface/**/*.cpp"
+---
+
+# C API Instructions
+
+See `libsyclinterface/AGENTS.md` for conventions.
+
+## Naming
+`DPCTL<ClassName>_<MethodName>` (e.g., `DPCTLDevice_Create`)
+
+## Ownership annotations (see `include/syclinterface/Support/MemOwnershipAttrs.h`)
+- `__dpctl_give` - caller must free
+- `__dpctl_take` - function takes ownership
+- `__dpctl_keep` - function only observes
+
+## Key Rules
+- Annotate all parameters and returns
+- Return NULL on failure
+- Use `DPCTL_API` for exports

.github/instructions/memory.instructions.md

@@ -0,0 +1,19 @@
+---
+applyTo:
+ - "dpctl/memory/**"
+ - "**/test_sycl_usm*.py"
+---
+
+# USM Memory Instructions
+
+See `dpctl/memory/AGENTS.md` for details.
+
+## USM Types
+- `MemoryUSMDevice` - device-only (fastest)
+- `MemoryUSMShared` - host and device accessible
+- `MemoryUSMHost` - host memory, device accessible
+
+## Lifetime Rules
+1. Memory is queue-bound
+2. Keep memory alive until operations complete
+3. Views extend base memory lifetime

.github/instructions/testing.instructions.md

@@ -0,0 +1,19 @@
+---
+applyTo:
+ - "dpctl/tests/**/*.py"
+ - "**/test_*.py"
+---
+
+# Testing Instructions
+
+See `dpctl/tests/AGENTS.md` for patterns.
+
+## Essential helpers (from `helper/_helper.py`)
+```python
+get_queue_or_skip() # Create queue or skip
+```
+
+## Focus
+Test SYCL runtime objects (Device, Queue, Context, Event, Platform) and USM memory APIs.
+
+**Note:** The `dpctl/tensor` module has been removed; do not reference tensor‑specific patterns.

AGENTS.md

@@ -0,0 +1,47 @@
+# AGENTS.md - AI Agent Guide for DPCTL
+
+## Purpose
+
+This file is the top-level entry point for AI agents working in `IntelPython/dpctl`.
+Use it to orient quickly, then follow directory-level `AGENTS.md` files for implementation details and local conventions.
+
+## Repository Scope
+
+DPCTL provides Python bindings for SYCL runtime objects and supporting infrastructure.
+
+High-level stack:
+
+```
+Python API -> Cython Bindings -> C API (libsyclinterface) -> SYCL Runtime
+```
+
+## How to Work in This Repo
+
+1. Identify the directory you are changing.
+2. Read the nearest `AGENTS.md` for that directory.
+3. Keep changes local and minimal; avoid unrelated refactors.
+4. Validate behavior with targeted tests before broad test runs.
+
+## Directory Guide
+
+| Directory | Guide | Notes |
+|-----------|-------|-------|
+| `dpctl/` | `dpctl/AGENTS.md` | Core SYCL Python bindings and Cython patterns |
+| `dpctl/memory/` | `dpctl/memory/AGENTS.md` | USM memory model and ownership rules |
+| `dpctl/program/` | `dpctl/program/AGENTS.md` | Program/kernel compilation APIs |
+| `dpctl/utils/` | `dpctl/utils/AGENTS.md` | Device info, ordering, and profiling utilities |
+| `dpctl/tests/` | `dpctl/tests/AGENTS.md` | Test conventions for SYCL objects and memory APIs |
+| `libsyclinterface/` | `libsyclinterface/AGENTS.md` | C API contracts and ABI-safe patterns |
+
+## Global Constraints
+
+- Match existing Apache 2.0 + Intel header style for source files.
+- Respect style tooling from `.pre-commit-config.yaml`, `.clang-format`, and `.flake8`.
+- Do not assume all devices support fp64/fp16.
+- Preserve queue/device compatibility checks and explicit error paths.
+- Keep memory/resource cleanup explicit and safe.
+
+## Notes on GitHub Copilot Instructions
+
+Files under `.github/instructions/*.instructions.md` are entry points for Copilot behavior.
+They should stay concise and reference authoritative `AGENTS.md` files rather than duplicating full guidance.

dpctl/AGENTS.md

@@ -0,0 +1,62 @@
+# dpctl/ - Core SYCL Bindings
+
+## Purpose
+
+Python/Cython wrappers for SYCL runtime objects: Device, Queue, Context, Event, Platform.
+
+## Key Files
+
+| File | Purpose |
+|------|---------|
+| `_sycl_device.pyx` | `SyclDevice` wrapping `sycl::device` |
+| `_sycl_queue.pyx` | `SyclQueue` wrapping `sycl::queue` |
+| `_sycl_context.pyx` | `SyclContext` wrapping `sycl::context` |
+| `_sycl_event.pyx` | `SyclEvent` wrapping `sycl::event` |
+| `_sycl_platform.pyx` | `SyclPlatform` wrapping `sycl::platform` |
+| `_sycl_device_factory.pyx` | Device enumeration and selection |
+| `_sycl_queue_manager.pyx` | Queue management utilities |
+| `_backend.pxd` | C API declarations from libsyclinterface |
+| `enum_types.py` | Python enums for SYCL types |
+
+## Cython Conventions
+
+### Required Directives (after license header)
+```cython
+# distutils: language = c++
+# cython: language_level=3
+# cython: linetrace=True
+```
+
+### Extension Type Pattern
+```cython
+cdef class SyclDevice:
+ cdef DPCTLSyclDeviceRef _device_ref # C reference
+
+ def __dealloc__(self):
+ if self._device_ref is not NULL:
+ DPCTLDevice_Delete(self._device_ref)
+
+ cdef DPCTLSyclDeviceRef get_device_ref(self):
+ return self._device_ref
+```
+
+### Key Rules
+- Store C references as `_*_ref` attributes
+- Always clean up in `__dealloc__` with NULL check
+- Use `with nogil:` for blocking C calls
+- Check NULL before using C API returns
+
+### Exceptions
+- `SyclDeviceCreationError`
+- `SyclQueueCreationError`
+- `SyclContextCreationError`
+
+## cimport vs import
+
+```cython
+# cimport - C-level declarations (compile-time)
+from ._backend cimport DPCTLSyclDeviceRef, DPCTLDevice_Create
+
+# import - Python-level (runtime)
+from . import _device_selection
+```

dpctl/memory/AGENTS.md

@@ -0,0 +1,41 @@
+# dpctl/memory/ - USM Memory Management
+
+## Purpose
+
+Python classes for SYCL Unified Shared Memory (USM) allocation.
+
+## USM Types
+
+| Class | USM Type | Description |
+|-------|----------|-------------|
+| `MemoryUSMDevice` | Device | Device-only, fastest access |
+| `MemoryUSMShared` | Shared | Host and device accessible |
+| `MemoryUSMHost` | Host | Host memory, device accessible |
+
+## __sycl_usm_array_interface__
+
+All memory classes implement this protocol:
+```python
+{
+ "data": (ptr, readonly_flag),
+ "shape": (nbytes,),
+ "strides": None,
+ "typestr": "|u1",
+ "version": 1,
+ "syclobj": queue
+}
+```
+
+## Memory Lifetime Rules
+
+1. **Queue-bound:** Memory tied to specific queue/context
+2. **Outlive operations:** Keep memory alive until operations complete
+3. **Views extend lifetime:** Views keep base memory alive
+
+## Key Files
+
+| File | Purpose |
+|------|---------|
+| `_memory.pyx` | Memory class implementations |
+| `_memory.pxd` | Cython declarations |
+| `__init__.py` | Public API exports |

dpctl/program/AGENTS.md

@@ -0,0 +1,39 @@
+# dpctl/program/ - SYCL Kernel Compilation
+
+## Purpose
+
+Compile and manage SYCL kernels from OpenCL C or SPIR-V source.
+
+## Key Files
+
+| File | Purpose |
+|------|---------|
+| `_program.pyx` | `SyclProgram`, `SyclKernel` extension types |
+| `_program.pxd` | Cython declarations |
+| `__init__.py` | Public API exports |
+
+## Classes
+
+- **`SyclProgram`** - Compiled SYCL program containing one or more kernels
+- **`SyclKernel`** - Individual kernel extracted from a program
+
+## Usage Pattern
+
+```python
+from dpctl.program import create_program_from_source
+
+source = """
+__kernel void add(__global float* a, __global float* b, __global float* c) {
+ int i = get_global_id(0);
+ c[i] = a[i] + b[i];
+}
+"""
+
+program = create_program_from_source(queue, source)
+kernel = program.get_sycl_kernel("add")
+```
+
+## Notes
+
+- Programs are context-bound
+- Follows same Cython patterns as core dpctl (see `../AGENTS.md`)

dpctl/tests/AGENTS.md

@@ -0,0 +1,40 @@
+# dpctl/tests/ - Test Suite
+
+## Purpose
+
+pytest-based test suite for dpctl SYCL runtime objects and USM memory functionality.
+
+**Note:** The `dpctl/tensor` module has been removed; focus testing on SYCL objects and memory APIs.
+
+## Key Files
+
+| File | Purpose |
+|------|---------|
+| `conftest.py` | Fixtures and pytest configuration |
+| `helper/_helper.py` | `get_queue_or_skip()` (queue creation helper) |
+
+## Essential Helpers
+
+From `helper/_helper.py`:
+```python
+get_queue_or_skip() # Create queue or skip test
+```
+
+## Test Pattern (SYCL objects)
+
+```python
+def test_device_creation():
+ q = get_queue_or_skip()
+ dev = q.sycl_device
+ # ... test device properties and methods
+
+def test_usm_allocation():
+ q = get_queue_or_skip()
+ # Test USM memory allocation for supported data types
+ # ...
+```
+
+## Critical Rules
+
+1. **Device compatibility:** Not all devices support fp64/fp16 – verify support before testing float64/complex128 memory operations.
+2. **Queue consistency:** Memory allocations and operations must use compatible queues.

dpctl/utils/AGENTS.md

@@ -0,0 +1,15 @@
+# dpctl/utils/ - Utility Functions
+
+## Purpose
+
+Helper utilities for device queries, execution context management, and ordering.
+
+**Note:** The `dpctl/tensor` module has been removed; utilities specific to tensor operations are no longer present.
+
+## Key Files
+
+| File | Purpose |
+|------|---------|
+| `_order_manager.py` | `OrderManager` for memory layout handling |
+| `_intel_device_info.py` | Intel-specific device information |
+| `_onetrace_context.py` | Tracing/profiling context manager |