Repository navigation
Update changelog for 0.23.0 release - #2392
vlad-perevezentsev wants to merge 4 commits into
Conversation
|
View rendered docs @ https://intelpython.github.io/dpctl/pulls/2392/index.html |
antonwolfy
left a comment
There was a problem hiding this comment.
I checked each entry against its PR and the code at this PR's head.
Confirmed:
- All 28 referenced PRs are merged to master, none were reverted, and none duplicate the 0.22.0/0.22.1 sections.
- All links match their PR numbers, and every section is in PR-number order.
Most of the inline comments come with a suggested fix:
antonwolfy
left a comment
There was a problem hiding this comment.
Thanks for the updates. Everything from the earlier round is addressed. A few wording nits are inline.
| * `dpctl.SyclDevice.sub_group_independent_forward_progress` property and `DPCTLDevice_GetSubGroupIndependentForwardProgress` C-API function were removed [gh-2353](https://github.com/IntelPython/dpctl/pull/2353) | ||
| * The signature of `DPCTLKernelBundle_CreateFromSpirv` C-API function changed [gh-2304](https://github.com/IntelPython/dpctl/pull/2304) | ||
| * The values of `DPCTLPartitionAffinityDomainType` enumerators shifted, as `DPCTL_PARTITION_AFFINITY_DOMAIN_UNKNOWN` was added as the zero value [gh-2324](https://github.com/IntelPython/dpctl/pull/2324) | ||
| * `SyclProgram` names in the `dpctl` Python C-API and `dpctl4pybind11.hpp` (e.g. `PySyclKernelBundleObject`, `SyclKernelBundle_Make`) were renamed to `SyclKernelBundle` ones without keeping aliases, while the Python names remain available as deprecated aliases [gh-2291](https://github.com/IntelPython/dpctl/pull/2291) |
There was a problem hiding this comment.
The examples come right after "SyclProgram names", but they're the new names, so they read as if PySyclKernelBundleObject were an old name. Suggest showing old → new:
| * `SyclProgram` names in the `dpctl` Python C-API and `dpctl4pybind11.hpp` (e.g. `PySyclKernelBundleObject`, `SyclKernelBundle_Make`) were renamed to `SyclKernelBundle` ones without keeping aliases, while the Python names remain available as deprecated aliases [gh-2291](https://github.com/IntelPython/dpctl/pull/2291) | |
| * `SyclProgram` names in the `dpctl` Python C-API and `dpctl4pybind11.hpp` were renamed to `SyclKernelBundle` ones (e.g. `PySyclProgramObject` → `PySyclKernelBundleObject`, `SyclProgram_Make` → `SyclKernelBundle_Make`) without keeping aliases, while the Python names remain available as deprecated aliases [gh-2291](https://github.com/IntelPython/dpctl/pull/2291) |
| * Registered `DPCTL_PARTITION_AFFINITY_DOMAIN_UNKNOWN` enumerator when `DPCTLDevice_GetPartitionAffinityDomains` receives an unrecognized value from the SYCL runtime [gh-2324](https://github.com/IntelPython/dpctl/pull/2324) | ||
| * `dpctl.SyclPlatform.get_devices` no longer relies on a work-around for `custom` and `automatic` device types, as it is not needed with the supported compiler versions [gh-2303](https://github.com/IntelPython/dpctl/pull/2303) | ||
| * `DPCTLKernelBundle_CreateFromSpirv` C-API function now also takes an array of `DPCTLSpecConst` specialization constants [gh-2304](https://github.com/IntelPython/dpctl/pull/2304) | ||
| * Device and platform collection APIs, such as `dpctl.get_devices` and `dpctl.SyclPlatform.get_devices`, as well as `dpctl.SyclDevice.sub_group_sizes`, now return a `tuple` instead of a `list`; this is a backward-incompatible change [gh-2322](https://github.com/IntelPython/dpctl/pull/2322) |
There was a problem hiding this comment.
Nit (optional): the breaking-changes list at the top now covers this, so the "backward-incompatible" clause I suggested earlier is redundant here:
| * Device and platform collection APIs, such as `dpctl.get_devices` and `dpctl.SyclPlatform.get_devices`, as well as `dpctl.SyclDevice.sub_group_sizes`, now return a `tuple` instead of a `list`; this is a backward-incompatible change [gh-2322](https://github.com/IntelPython/dpctl/pull/2322) | |
| * Device and platform collection APIs, such as `dpctl.get_devices` and `dpctl.SyclPlatform.get_devices`, as well as `dpctl.SyclDevice.sub_group_sizes`, now return a `tuple` instead of a `list` [gh-2322](https://github.com/IntelPython/dpctl/pull/2322) |
| * Deprecated `dpctl.program.SyclProgram` and `dpctl.program.SyclProgramCompilationError` aliases in favor of `dpctl.compiler.SyclKernelBundle` and `dpctl.compiler.SyclKernelBundleCompilationError` [gh-2291](https://github.com/IntelPython/dpctl/pull/2291) | ||
| * Deprecated `dpctl.program.create_program_from_source` and `dpctl.program.create_program_from_spirv`, which are kept as aliases emitting a `DeprecationWarning` in favor of `dpctl.compiler.create_kernel_bundle_from_source` and `dpctl.compiler.create_kernel_bundle_from_spirv` [gh-2291](https://github.com/IntelPython/dpctl/pull/2291) |
There was a problem hiding this comment.
Two small things:
- On L49, "in favor of …" ends up attached to "emitting a
DeprecationWarning". Putting "in favor of" right after the deprecated names reads more clearly. - Both entries name the
dpctl.compilerreplacements, which come from Move and deprecate dpctl program #2317 (RenameSyclProgramtoSyclKernelBundle#2291 put them indpctl.program), so they could cite both PRs.
| * Deprecated `dpctl.program.SyclProgram` and `dpctl.program.SyclProgramCompilationError` aliases in favor of `dpctl.compiler.SyclKernelBundle` and `dpctl.compiler.SyclKernelBundleCompilationError` [gh-2291](https://github.com/IntelPython/dpctl/pull/2291) | |
| * Deprecated `dpctl.program.create_program_from_source` and `dpctl.program.create_program_from_spirv`, which are kept as aliases emitting a `DeprecationWarning` in favor of `dpctl.compiler.create_kernel_bundle_from_source` and `dpctl.compiler.create_kernel_bundle_from_spirv` [gh-2291](https://github.com/IntelPython/dpctl/pull/2291) | |
| * Deprecated `dpctl.program.SyclProgram` and `dpctl.program.SyclProgramCompilationError` aliases in favor of `dpctl.compiler.SyclKernelBundle` and `dpctl.compiler.SyclKernelBundleCompilationError` [gh-2291](https://github.com/IntelPython/dpctl/pull/2291), [gh-2317](https://github.com/IntelPython/dpctl/pull/2317) | |
| * Deprecated `dpctl.program.create_program_from_source` and `dpctl.program.create_program_from_spirv` in favor of `dpctl.compiler.create_kernel_bundle_from_source` and `dpctl.compiler.create_kernel_bundle_from_spirv`; the old functions are kept as aliases that emit a `DeprecationWarning` [gh-2291](https://github.com/IntelPython/dpctl/pull/2291), [gh-2317](https://github.com/IntelPython/dpctl/pull/2317) |
Adds changelog entries for changes made since
0.22.0and renames thedevsection to0.23.0