Skip to content
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

DOC: onedal4py table helpers #2139

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions doc/sources/developers/array_api.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
.. ******************************************************************************
.. * Copyright 2024 Intel Corporation
.. *
.. * Licensed under the Apache License, Version 2.0 (the "License");
.. * you may not use this file except in compliance with the License.
.. * You may obtain a copy of the License at
.. *
.. * http://www.apache.org/licenses/LICENSE-2.0
.. *
.. * Unless required by applicable law or agreed to in writing, software
.. * distributed under the License is distributed on an "AS IS" BASIS,
.. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
.. * See the License for the specific language governing permissions and
.. * limitations under the License.
.. *******************************************************************************/

.. _array_api_dev:

Array API support
=================
File renamed without changes.
19 changes: 19 additions & 0 deletions doc/sources/developers/dispatching.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
.. ******************************************************************************
.. * Copyright 2024 Intel Corporation
.. *
.. * Licensed under the Apache License, Version 2.0 (the "License");
.. * you may not use this file except in compliance with the License.
.. * You may obtain a copy of the License at
.. *
.. * http://www.apache.org/licenses/LICENSE-2.0
.. *
.. * Unless required by applicable law or agreed to in writing, software
.. * distributed under the License is distributed on an "AS IS" BASIS,
.. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
.. * See the License for the specific language governing permissions and
.. * limitations under the License.
.. *******************************************************************************/

Dispatch mechanism
==================
TBD
60 changes: 60 additions & 0 deletions doc/sources/developers/estimators.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
.. ******************************************************************************
.. * Copyright 2024 Intel Corporation
.. *
.. * Licensed under the Apache License, Version 2.0 (the "License");
.. * you may not use this file except in compliance with the License.
.. * You may obtain a copy of the License at
.. *
.. * http://www.apache.org/licenses/LICENSE-2.0
.. *
.. * Unless required by applicable law or agreed to in writing, software
.. * distributed under the License is distributed on an "AS IS" BASIS,
.. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
.. * See the License for the specific language governing permissions and
.. * limitations under the License.
.. *******************************************************************************/
.. _estimators:

==========
Estimators
==========
TBD

daal4py
=======
TBD

onedal4py
=========

`to_table`
----------
In data processing stage `to_table` can be used as a step to transform input data to backend
oneDAL lib table format before feeding it into the backend functions, ensuring compatibility
and consistency.

The input data could be a NumPy ndarray, DPCTL usm_ndarray, DPNP ndarray or a CSR matrix or array.
You want to ensure that all data is converted to a table format before passing them backend functions.

If using the sua_iface parameter, ensure that the backend is correctly set up and compatible
with the data being processed. Different backends may have specific requirements or optimizations.

TBD

.. code-block:: python

# Using to_table to convert different formats to oneDAL table

data_array = np.array([[7, 8, 9], [10, 11, 12]])
table_from_array = to_table(data_array)

# Example CSR matrix
row = np.array([0, 0, 1, 2, 2, 2])
col = np.array([0, 2, 2, 0, 1, 2])
data = np.array([1, 2, 3, 4, 5, 6])
data_csr = csr_matrix((data, (row, col)), shape=(3, 3)).toarray()
table_from_csr = to_table(data_csr)

sklearnex
=========
TBD
21 changes: 21 additions & 0 deletions doc/sources/developers/pybind11.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
.. ******************************************************************************
.. * Copyright 2024 Intel Corporation
.. *
.. * Licensed under the Apache License, Version 2.0 (the "License");
.. * you may not use this file except in compliance with the License.
.. * You may obtain a copy of the License at
.. *
.. * http://www.apache.org/licenses/LICENSE-2.0
.. *
.. * Unless required by applicable law or agreed to in writing, software
.. * distributed under the License is distributed on an "AS IS" BASIS,
.. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
.. * See the License for the specific language governing permissions and
.. * limitations under the License.
.. *******************************************************************************/

.. _pybind11:

pybind11
========
TBD
21 changes: 21 additions & 0 deletions doc/sources/developers/spmd.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
.. ******************************************************************************
.. * Copyright 2024 Intel Corporation
.. *
.. * Licensed under the Apache License, Version 2.0 (the "License");
.. * you may not use this file except in compliance with the License.
.. * You may obtain a copy of the License at
.. *
.. * http://www.apache.org/licenses/LICENSE-2.0
.. *
.. * Unless required by applicable law or agreed to in writing, software
.. * distributed under the License is distributed on an "AS IS" BASIS,
.. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
.. * See the License for the specific language governing permissions and
.. * limitations under the License.
.. *******************************************************************************/

.. _spmd:

SPMD ifaces
===========
TBD
22 changes: 22 additions & 0 deletions doc/sources/developers/threading.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
.. ******************************************************************************
.. * Copyright 2024 Intel Corporation
.. *
.. * Licensed under the Apache License, Version 2.0 (the "License");
.. * you may not use this file except in compliance with the License.
.. * You may obtain a copy of the License at
.. *
.. * http://www.apache.org/licenses/LICENSE-2.0
.. *
.. * Unless required by applicable law or agreed to in writing, software
.. * distributed under the License is distributed on an "AS IS" BASIS,
.. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
.. * See the License for the specific language governing permissions and
.. * limitations under the License.
.. *******************************************************************************/


.. _threading:

Threading
=========
TBD
17 changes: 14 additions & 3 deletions doc/sources/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ Enable Intel(R) GPU optimizations
kaggle.rst

.. toctree::
:caption: Developer Guide
:caption: User Guide
:hidden:
:maxdepth: 2

Expand All @@ -111,7 +111,6 @@ Enable Intel(R) GPU optimizations
verbose.rst
preview.rst
deprecation.rst


.. toctree::
:caption: Performance
Expand All @@ -128,11 +127,23 @@ Enable Intel(R) GPU optimizations
Tutorials & Case Studies <tutorials.rst>
Medium Blogs <blogs.rst>

.. toctree::
:caption: Developer’s Guide
:hidden:
:maxdepth: 2

developers/contribute.rst
developers/dispatching.rst
developers/estimators.rst
developers/pybind11.rst
developers/array_api.rst
developers/spmd.rst
developers/threading.rst

.. toctree::
:caption: More
:hidden:
:maxdepth: 2

Support <support.rst>
contribute.rst
license.rst