-
Notifications
You must be signed in to change notification settings - Fork 23
Add missing MKL function from VM namespace #2445
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
Merged
Merged
Changes from 7 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
31573f9
Add mkl_vm::arg() extnesion to be used in dpnp.angle
antonwolfy 6c9037d
Add mkl_vm::copysign() extnesion to be used in dpnp.copysign
antonwolfy 5682a94
Add mkl_vm::i0() extnesion to be used in dpnp.i0
antonwolfy eb9fc5c
Add mkl_vm::inv() extnesion to be used in dpnp.reciprocal
antonwolfy a9c2ca7
Add a note why mkl_vm::remainder() is not intended to be used
antonwolfy 869adff
Do not use sycl::half due to precision reason
antonwolfy 1605314
Populate changelog
antonwolfy fa4baa1
Apply suggestions from code review
antonwolfy 9572332
Update description of _copysign in vm extension
antonwolfy File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,135 @@ | ||
| //***************************************************************************** | ||
| // Copyright (c) 2025, Intel Corporation | ||
| // All rights reserved. | ||
| // | ||
| // Redistribution and use in source and binary forms, with or without | ||
| // modification, are permitted provided that the following conditions are met: | ||
| // - Redistributions of source code must retain the above copyright notice, | ||
| // this list of conditions and the following disclaimer. | ||
| // - Redistributions in binary form must reproduce the above copyright notice, | ||
| // this list of conditions and the following disclaimer in the documentation | ||
| // and/or other materials provided with the distribution. | ||
| // | ||
| // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | ||
| // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
| // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | ||
| // ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE | ||
| // LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR | ||
| // CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF | ||
| // SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS | ||
| // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN | ||
| // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | ||
| // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF | ||
| // THE POSSIBILITY OF SUCH DAMAGE. | ||
| //***************************************************************************** | ||
|
|
||
| #include <oneapi/mkl.hpp> | ||
| #include <sycl/sycl.hpp> | ||
|
|
||
| #include "dpctl4pybind11.hpp" | ||
|
|
||
| #include "arg.hpp" | ||
| #include "common.hpp" | ||
|
|
||
| // include a local copy of elementwise common header from dpctl tensor: | ||
| // dpctl/tensor/libtensor/source/elementwise_functions/elementwise_functions.hpp | ||
| // TODO: replace by including dpctl header once available | ||
| #include "../elementwise_functions/elementwise_functions.hpp" | ||
|
|
||
| // dpctl tensor headers | ||
| #include "kernels/elementwise_functions/common.hpp" | ||
| #include "utils/type_dispatch.hpp" | ||
| #include "utils/type_utils.hpp" | ||
|
|
||
| namespace dpnp::extensions::vm | ||
| { | ||
| namespace py = pybind11; | ||
| namespace py_int = dpnp::extensions::py_internal; | ||
| namespace td_ns = dpctl::tensor::type_dispatch; | ||
|
|
||
| namespace impl | ||
| { | ||
| namespace ew_cmn_ns = dpctl::tensor::kernels::elementwise_common; | ||
| namespace mkl_vm = oneapi::mkl::vm; // OneMKL namespace with VM functions | ||
| namespace tu_ns = dpctl::tensor::type_utils; | ||
|
|
||
| /** | ||
| * @brief A factory to define pairs of supported types for which | ||
| * MKL VM library provides support in oneapi::mkl::vm::arg<T> function. | ||
| * | ||
| * @tparam T Type of input vector `a` and of result vector `y`. | ||
| */ | ||
| template <typename T> | ||
| struct OutputType | ||
| { | ||
| using value_type = typename std::disjunction< | ||
| td_ns::TypeMapResultEntry<T, std::complex<double>, double>, | ||
| td_ns::TypeMapResultEntry<T, std::complex<float>, float>, | ||
| td_ns::DefaultResultEntry<void>>::result_type; | ||
| }; | ||
|
|
||
| template <typename T> | ||
| static sycl::event arg_contig_impl(sycl::queue &exec_q, | ||
| std::size_t in_n, | ||
| const char *in_a, | ||
| char *out_y, | ||
| const std::vector<sycl::event> &depends) | ||
| { | ||
| tu_ns::validate_type_for_device<T>(exec_q); | ||
|
|
||
| std::int64_t n = static_cast<std::int64_t>(in_n); | ||
| const T *a = reinterpret_cast<const T *>(in_a); | ||
|
|
||
| using resTy = typename OutputType<T>::value_type; | ||
| resTy *y = reinterpret_cast<resTy *>(out_y); | ||
|
|
||
| return mkl_vm::arg(exec_q, | ||
| n, // number of elements to be calculated | ||
| a, // pointer `a` containing input vector of size n | ||
| y, // pointer `y` to the output vector of size n | ||
| depends); | ||
| } | ||
|
|
||
| using ew_cmn_ns::unary_contig_impl_fn_ptr_t; | ||
| using ew_cmn_ns::unary_strided_impl_fn_ptr_t; | ||
|
|
||
| static int output_typeid_vector[td_ns::num_types]; | ||
| static unary_contig_impl_fn_ptr_t contig_dispatch_vector[td_ns::num_types]; | ||
|
|
||
| MACRO_POPULATE_DISPATCH_VECTORS(arg); | ||
| } // namespace impl | ||
|
|
||
| void init_arg(py::module_ m) | ||
| { | ||
| using arrayT = dpctl::tensor::usm_ndarray; | ||
| using event_vecT = std::vector<sycl::event>; | ||
|
|
||
| impl::populate_dispatch_vectors(); | ||
| using impl::contig_dispatch_vector; | ||
| using impl::output_typeid_vector; | ||
|
|
||
| auto arg_pyapi = [&](sycl::queue &exec_q, const arrayT &src, | ||
| const arrayT &dst, const event_vecT &depends = {}) { | ||
| return py_int::py_unary_ufunc( | ||
| src, dst, exec_q, depends, output_typeid_vector, | ||
| contig_dispatch_vector, | ||
| // no support of strided implementation in OneMKL | ||
| td_ns::NullPtrVector<impl::unary_strided_impl_fn_ptr_t>{}); | ||
| }; | ||
| m.def("_arg", arg_pyapi, | ||
| "Call `arg` function from OneMKL VM library to compute " | ||
| "the inverse tangent of vector elements", | ||
| py::arg("sycl_queue"), py::arg("src"), py::arg("dst"), | ||
| py::arg("depends") = py::list()); | ||
|
|
||
| auto arg_need_to_call_pyapi = [&](sycl::queue &exec_q, const arrayT &src, | ||
| const arrayT &dst) { | ||
| return py_internal::need_to_call_unary_ufunc( | ||
| exec_q, src, dst, output_typeid_vector, contig_dispatch_vector); | ||
| }; | ||
| m.def("_mkl_arg_to_call", arg_need_to_call_pyapi, | ||
| "Check input arguments to answer if `arg` function from " | ||
| "OneMKL VM library can be used", | ||
| py::arg("sycl_queue"), py::arg("src"), py::arg("dst")); | ||
| } | ||
| } // namespace dpnp::extensions::vm | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| //***************************************************************************** | ||
| // Copyright (c) 2025, Intel Corporation | ||
| // All rights reserved. | ||
| // | ||
| // Redistribution and use in source and binary forms, with or without | ||
| // modification, are permitted provided that the following conditions are met: | ||
| // - Redistributions of source code must retain the above copyright notice, | ||
| // this list of conditions and the following disclaimer. | ||
| // - Redistributions in binary form must reproduce the above copyright notice, | ||
| // this list of conditions and the following disclaimer in the documentation | ||
| // and/or other materials provided with the distribution. | ||
| // | ||
| // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | ||
| // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
| // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | ||
| // ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE | ||
| // LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR | ||
| // CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF | ||
| // SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS | ||
| // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN | ||
| // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | ||
| // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF | ||
| // THE POSSIBILITY OF SUCH DAMAGE. | ||
| //***************************************************************************** | ||
|
|
||
| #pragma once | ||
|
|
||
| #include <pybind11/pybind11.h> | ||
|
|
||
| namespace py = pybind11; | ||
|
|
||
| namespace dpnp::extensions::vm | ||
| { | ||
| void init_arg(py::module_ m); | ||
| } // namespace dpnp::extensions::vm |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,167 @@ | ||
| //***************************************************************************** | ||
| // Copyright (c) 2025, Intel Corporation | ||
| // All rights reserved. | ||
| // | ||
| // Redistribution and use in source and binary forms, with or without | ||
| // modification, are permitted provided that the following conditions are met: | ||
| // - Redistributions of source code must retain the above copyright notice, | ||
| // this list of conditions and the following disclaimer. | ||
| // - Redistributions in binary form must reproduce the above copyright notice, | ||
| // this list of conditions and the following disclaimer in the documentation | ||
| // and/or other materials provided with the distribution. | ||
| // | ||
| // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | ||
| // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
| // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | ||
| // ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE | ||
| // LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR | ||
| // CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF | ||
| // SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS | ||
| // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN | ||
| // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | ||
| // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF | ||
| // THE POSSIBILITY OF SUCH DAMAGE. | ||
| //***************************************************************************** | ||
|
|
||
| #include <stdexcept> | ||
|
|
||
| #include <oneapi/mkl.hpp> | ||
| #include <sycl/sycl.hpp> | ||
|
|
||
| #include "dpctl4pybind11.hpp" | ||
|
|
||
| #include "common.hpp" | ||
| #include "copysign.hpp" | ||
|
|
||
| // include a local copy of elementwise common header from dpctl tensor: | ||
| // dpctl/tensor/libtensor/source/elementwise_functions/elementwise_functions.hpp | ||
| // TODO: replace by including dpctl header once available | ||
| #include "../elementwise_functions/elementwise_functions.hpp" | ||
|
|
||
| // dpctl tensor headers | ||
| #include "kernels/elementwise_functions/common.hpp" | ||
| #include "utils/type_dispatch.hpp" | ||
| #include "utils/type_utils.hpp" | ||
|
|
||
| namespace dpnp::extensions::vm | ||
| { | ||
| namespace py = pybind11; | ||
| namespace py_int = dpnp::extensions::py_internal; | ||
| namespace td_ns = dpctl::tensor::type_dispatch; | ||
|
|
||
| namespace impl | ||
| { | ||
| namespace ew_cmn_ns = dpctl::tensor::kernels::elementwise_common; | ||
| namespace mkl_vm = oneapi::mkl::vm; // OneMKL namespace with VM functions | ||
| namespace tu_ns = dpctl::tensor::type_utils; | ||
|
|
||
| /** | ||
| * @brief A factory to define pairs of supported types for which | ||
| * MKL VM library provides support in oneapi::mkl::vm::copysign<T> function. | ||
| * | ||
| * @tparam T Type of input vectors `a` and `b` and of result vector `y`. | ||
| */ | ||
| template <typename T1, typename T2> | ||
| struct OutputType | ||
| { | ||
| using value_type = typename std::disjunction< | ||
| td_ns::BinaryTypeMapResultEntry<T1, double, T2, double, double>, | ||
| td_ns::BinaryTypeMapResultEntry<T1, float, T2, float, float>, | ||
| td_ns::DefaultResultEntry<void>>::result_type; | ||
| }; | ||
|
|
||
| template <typename T1, typename T2> | ||
| static sycl::event copysign_contig_impl(sycl::queue &exec_q, | ||
| std::size_t in_n, | ||
| const char *in_a, | ||
| py::ssize_t a_offset, | ||
| const char *in_b, | ||
| py::ssize_t b_offset, | ||
| char *out_y, | ||
| py::ssize_t out_offset, | ||
| const std::vector<sycl::event> &depends) | ||
| { | ||
| tu_ns::validate_type_for_device<T1>(exec_q); | ||
| tu_ns::validate_type_for_device<T2>(exec_q); | ||
|
|
||
| if ((a_offset != 0) || (b_offset != 0) || (out_offset != 0)) { | ||
| throw std::runtime_error("Arrays offsets have to be equals to 0"); | ||
| } | ||
|
|
||
| std::int64_t n = static_cast<std::int64_t>(in_n); | ||
| const T1 *a = reinterpret_cast<const T1 *>(in_a); | ||
| const T2 *b = reinterpret_cast<const T2 *>(in_b); | ||
|
|
||
| using resTy = typename OutputType<T1, T2>::value_type; | ||
| resTy *y = reinterpret_cast<resTy *>(out_y); | ||
|
|
||
| return mkl_vm::copysign( | ||
| exec_q, | ||
| n, // number of elements to be calculated | ||
| a, // pointer `a` containing 1st input vector of size n | ||
| b, // pointer `b` containing 2nd input vector of size n | ||
| y, // pointer `y` to the output vector of size n | ||
| depends); | ||
| } | ||
|
|
||
| using ew_cmn_ns::binary_contig_impl_fn_ptr_t; | ||
| using ew_cmn_ns::binary_contig_matrix_contig_row_broadcast_impl_fn_ptr_t; | ||
| using ew_cmn_ns::binary_contig_row_contig_matrix_broadcast_impl_fn_ptr_t; | ||
| using ew_cmn_ns::binary_strided_impl_fn_ptr_t; | ||
|
|
||
| static int output_typeid_vector[td_ns::num_types][td_ns::num_types]; | ||
| static binary_contig_impl_fn_ptr_t contig_dispatch_vector[td_ns::num_types] | ||
| [td_ns::num_types]; | ||
|
|
||
| MACRO_POPULATE_DISPATCH_TABLES(copysign); | ||
| } // namespace impl | ||
|
|
||
| void init_copysign(py::module_ m) | ||
| { | ||
| using arrayT = dpctl::tensor::usm_ndarray; | ||
| using event_vecT = std::vector<sycl::event>; | ||
|
|
||
| impl::populate_dispatch_tables(); | ||
| using impl::contig_dispatch_vector; | ||
| using impl::output_typeid_vector; | ||
|
|
||
| auto copysign_pyapi = [&](sycl::queue &exec_q, const arrayT &src1, | ||
| const arrayT &src2, const arrayT &dst, | ||
| const event_vecT &depends = {}) { | ||
| return py_int::py_binary_ufunc( | ||
| src1, src2, dst, exec_q, depends, output_typeid_vector, | ||
| contig_dispatch_vector, | ||
| // no support of strided implementation in OneMKL | ||
| td_ns::NullPtrTable<impl::binary_strided_impl_fn_ptr_t>{}, | ||
| // no support of C-contig row with broadcasting in OneMKL | ||
| td_ns::NullPtrTable< | ||
| impl:: | ||
| binary_contig_matrix_contig_row_broadcast_impl_fn_ptr_t>{}, | ||
| td_ns::NullPtrTable< | ||
| impl:: | ||
| binary_contig_row_contig_matrix_broadcast_impl_fn_ptr_t>{}); | ||
| }; | ||
| m.def( | ||
| "_copysign", copysign_pyapi, | ||
| "Call `copysign` function from OneMKL VM library to return `dst` of " | ||
| "elements containing the next representable floating-point values " | ||
| "following the values from the elements of `src1` in the direction of " | ||
| "the corresponding elements of `src2`", | ||
| py::arg("sycl_queue"), py::arg("src1"), py::arg("src2"), py::arg("dst"), | ||
| py::arg("depends") = py::list()); | ||
|
|
||
| auto copysign_need_to_call_pyapi = [&](sycl::queue &exec_q, | ||
| const arrayT &src1, | ||
| const arrayT &src2, | ||
| const arrayT &dst) { | ||
| return py_internal::need_to_call_binary_ufunc(exec_q, src1, src2, dst, | ||
| output_typeid_vector, | ||
| contig_dispatch_vector); | ||
| }; | ||
| m.def("_mkl_copysign_to_call", copysign_need_to_call_pyapi, | ||
| "Check input arguments to answer if `copysign` function from " | ||
| "OneMKL VM library can be used", | ||
| py::arg("sycl_queue"), py::arg("src1"), py::arg("src2"), | ||
| py::arg("dst")); | ||
| } | ||
| } // namespace dpnp::extensions::vm |
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.