Skip to content
Merged
Show file tree
Hide file tree
Changes from 28 commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
c8f7da4
Align docs linalg with NumPy/CuPy short names
vlad-perevezentsev Oct 21, 2025
45d4296
Move linalg.outer to Matrix and vector products
vlad-perevezentsev Oct 21, 2025
47d2111
Align docs fft with NumPy/CuPy short names
vlad-perevezentsev Oct 21, 2025
08bf166
Align docs array creation with NumPy/CuPy short names
vlad-perevezentsev Oct 21, 2025
2769e2b
Align docs array manipulation with NumPy/CuPy short names
vlad-perevezentsev Oct 21, 2025
226b8bb
Align docs bit-wise with NumPy/CuPy short names
vlad-perevezentsev Oct 21, 2025
cd4ca37
Align docs data type with NumPy/CuPy short names
vlad-perevezentsev Oct 21, 2025
87efe3c
Align docs functional with NumPy/CuPy short names
vlad-perevezentsev Oct 21, 2025
2a164ea
Align docs indexing with NumPy/CuPy short names
vlad-perevezentsev Oct 21, 2025
56228c4
Align docs logic with NumPy/CuPy short names
vlad-perevezentsev Oct 21, 2025
1c4abf7
Align docs math with NumPy/CuPy short names
vlad-perevezentsev Oct 21, 2025
4badb0e
Align docs ndarray with NumPy short names and title
vlad-perevezentsev Oct 21, 2025
3497879
Align docs miscellaneous with NumPy/CuPy short names and chapters
vlad-perevezentsev Oct 21, 2025
d2a7862
Align docs polynomials with NumPy/CuPy short names
vlad-perevezentsev Oct 21, 2025
5f90b4a
Align docs random with NumPy/CuPy short names
vlad-perevezentsev Oct 21, 2025
9c0d2fe
Align docs set with NumPy/CuPy short names
vlad-perevezentsev Oct 21, 2025
78e1a83
Align docs sorting with NumPy/CuPy short names
vlad-perevezentsev Oct 21, 2025
9df7605
Align docs statistics with NumPy/CuPy short names
vlad-perevezentsev Oct 21, 2025
1e1c617
Align docs ufunc with NumPy/CuPy short names
vlad-perevezentsev Oct 21, 2025
9aa5251
Fix math rendering in gcd and lcm docs
vlad-perevezentsev Oct 21, 2025
a68ae95
Align docs window with NumPy/CuPy short names
vlad-perevezentsev Oct 21, 2025
2a7d732
Align docs array api with NumPy/CuPy short names
vlad-perevezentsev Nov 3, 2025
8d26f88
Remove matrix class from array-creation.rst
vlad-perevezentsev Nov 3, 2025
79288e1
Add a hint to exceprions.rst
vlad-perevezentsev Nov 3, 2025
78840cf
Merge master into short_name_in_docs
vlad-perevezentsev Nov 3, 2025
f3fbd82
Update changelog
vlad-perevezentsev Nov 3, 2025
ff5acaf
Add a hint to constants.rst
vlad-perevezentsev Nov 3, 2025
15af492
Update a link in ndarray.rst
vlad-perevezentsev Nov 3, 2025
84dc0b0
Merge master into short_name_in_docs
vlad-perevezentsev Nov 4, 2025
be1ff0f
Update changelog line
vlad-perevezentsev Nov 4, 2025
ac553ad
Merge branch 'master' into short_name_in_docs
antonwolfy Nov 5, 2025
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
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ Also, that release drops support for Python 3.9, making Python 3.10 the minimum
* Silenced `pybind11` CMake message due to using compatibility mode for Python [#2614](https://github.com/IntelPython/dpnp/pull/2614)
* Changed the license from `BSD-2-Clause` to `BSD-3-Clause` [#2593](https://github.com/IntelPython/dpnp/pull/2593)
* Defined explicit versions range of the Python interpreter which is needed during the build [#2634](https://github.com/IntelPython/dpnp/pull/2634)
* Aligned `Routines` documentation with NumPy and CuPy style by using short function names [#2633](https://github.com/IntelPython/dpnp/pull/2633)

### Deprecated

Expand Down
85 changes: 39 additions & 46 deletions doc/reference/array-creation.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
.. _routines.array-creation:

.. currentmodule:: dpnp

Array creation routines
=======================

.. https://numpy.org/doc/stable/reference/routines.array-creation.html
.. hint:: `NumPy API Reference: Array creation routines <https://numpy.org/doc/stable/reference/routines.array-creation.html>`_

From shape or value
-----------------------
Expand All @@ -12,16 +14,16 @@ From shape or value
:toctree: generated/
:nosignatures:

dpnp.empty
dpnp.empty_like
dpnp.eye
dpnp.identity
dpnp.ones
dpnp.ones_like
dpnp.zeros
dpnp.zeros_like
dpnp.full
dpnp.full_like
empty
empty_like
eye
identity
ones
ones_like
zeros
zeros_like
full
full_like


From existing data
Expand All @@ -31,19 +33,19 @@ From existing data
:toctree: generated/
:nosignatures:

dpnp.array
dpnp.asarray
dpnp.asanyarray
dpnp.ascontiguousarray
dpnp.astype
dpnp.copy
dpnp.frombuffer
dpnp.from_dlpack
dpnp.fromfile
dpnp.fromfunction
dpnp.fromiter
dpnp.fromstring
dpnp.loadtxt
array
asarray
asanyarray
ascontiguousarray
astype
copy
frombuffer
from_dlpack
fromfile
fromfunction
fromiter
fromstring
loadtxt


Numerical ranges
Expand All @@ -53,13 +55,13 @@ Numerical ranges
:toctree: generated/
:nosignatures:

dpnp.arange
dpnp.linspace
dpnp.logspace
dpnp.geomspace
dpnp.meshgrid
dpnp.mgrid
dpnp.ogrid
arange
linspace
logspace
geomspace
meshgrid
mgrid
ogrid


Building matrices
Expand All @@ -69,18 +71,9 @@ Building matrices
:toctree: generated/
:nosignatures:

dpnp.diag
dpnp.diagflat
dpnp.tri
dpnp.tril
dpnp.triu
dpnp.vander


The Matrix class
----------------
.. autosummary::
:toctree: generated/
:nosignatures:

dpnp.bmat
diag
diagflat
tri
tril
triu
vander
122 changes: 62 additions & 60 deletions doc/reference/array-manipulation.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
.. currentmodule:: dpnp

Array manipulation routines
===========================

.. https://numpy.org/doc/stable/reference/routines.array-manipulation.html
.. hint:: `NumPy API Reference: Array manipulation routines <https://numpy.org/doc/stable/reference/routines.array-manipulation.html>`_

Basic operations
----------------
Expand All @@ -10,10 +12,10 @@ Basic operations
:toctree: generated/
:nosignatures:

dpnp.copyto
dpnp.ndim
dpnp.shape
dpnp.size
copyto
ndim
shape
size


Changing array shape
Expand All @@ -23,10 +25,10 @@ Changing array shape
:toctree: generated/
:nosignatures:

dpnp.reshape
dpnp.ravel
dpnp.ndarray.flat
dpnp.ndarray.flatten
reshape
ravel
ndarray.flat
ndarray.flatten


Transpose-like operations
Expand All @@ -36,13 +38,13 @@ Transpose-like operations
:toctree: generated/
:nosignatures:

dpnp.moveaxis
dpnp.rollaxis
dpnp.swapaxes
dpnp.ndarray.T
dpnp.transpose
dpnp.permute_dims
dpnp.matrix_transpose (Array API compatible)
moveaxis
rollaxis
swapaxes
ndarray.T
transpose
permute_dims
matrix_transpose (Array API compatible)


Changing number of dimensions
Expand All @@ -52,14 +54,14 @@ Changing number of dimensions
:toctree: generated/
:nosignatures:

dpnp.atleast_1d
dpnp.atleast_2d
dpnp.atleast_3d
dpnp.broadcast
dpnp.broadcast_to
dpnp.broadcast_arrays
dpnp.expand_dims
dpnp.squeeze
atleast_1d
atleast_2d
atleast_3d
broadcast
broadcast_to
broadcast_arrays
expand_dims
squeeze


Changing kind of array
Expand All @@ -69,14 +71,14 @@ Changing kind of array
:toctree: generated/
:nosignatures:

dpnp.asarray
dpnp.asanyarray
dpnp.asnumpy
dpnp.asfarray
dpnp.asfortranarray
dpnp.ascontiguousarray
dpnp.asarray_chkfinite
dpnp.require
asarray
asanyarray
asnumpy
asfarray
asfortranarray
ascontiguousarray
asarray_chkfinite
require


Joining arrays
Expand All @@ -86,15 +88,15 @@ Joining arrays
:toctree: generated/
:nosignatures:

dpnp.concatenate
dpnp.concat
dpnp.stack
dpnp.block
dpnp.vstack
dpnp.hstack
dpnp.dstack
dpnp.column_stack
dpnp.row_stack
concatenate
concat
stack
block
vstack
hstack
dstack
column_stack
row_stack


Splitting arrays
Expand All @@ -104,12 +106,12 @@ Splitting arrays
:toctree: generated/
:nosignatures:

dpnp.split
dpnp.array_split
dpnp.dsplit
dpnp.hsplit
dpnp.vsplit
dpnp.unstack
split
array_split
dsplit
hsplit
vsplit
unstack


Tiling arrays
Expand All @@ -119,8 +121,8 @@ Tiling arrays
:toctree: generated/
:nosignatures:

dpnp.tile
dpnp.repeat
tile
repeat


Adding and removing elements
Expand All @@ -130,12 +132,12 @@ Adding and removing elements
:toctree: generated/
:nosignatures:

dpnp.delete
dpnp.insert
dpnp.append
dpnp.resize
dpnp.trim_zeros
dpnp.pad
delete
insert
append
resize
trim_zeros
pad


Rearranging elements
Expand All @@ -145,8 +147,8 @@ Rearranging elements
:toctree: generated/
:nosignatures:

dpnp.flip
dpnp.fliplr
dpnp.flipud
dpnp.roll
dpnp.rot90
flip
fliplr
flipud
roll
rot90
6 changes: 4 additions & 2 deletions doc/reference/array_api.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
.. _array-api-standard-compatibility:

.. https://numpy.org/doc/stable/reference/array_api.html
.. currentmodule:: dpnp

********************************
Array API standard compatibility
********************************

.. hint:: `NumPy API Reference: Array API standard compatibility <https://numpy.org/doc/stable/reference/array_api.html>`_

DPNP's main namespace as well as the :mod:`dpnp.fft` and :mod:`dpnp.linalg`
namespaces are compatible with the
`2024.12 version <https://data-apis.org/array-api/2024.12/index.html>`__
Expand All @@ -23,4 +25,4 @@ function, which returns a namespace containing the inspection utilities.
:toctree: generated/
:nosignatures:

dpnp.__array_namespace_info__
__array_namespace_info__
Loading
Loading