Update API Reference

Author: vlad-perevezentsev

doc/reference/comparison.rst

@@ -1,7 +1,7 @@
-Comparison Table
-================
+Comparison Table NumPy/ DPNP/ CuPy
+==================================
 
-Here is a list of NumPy APIs and its corresponding DPNP implementations.
+Here is a list of NumPy and CuPy APIs and its corresponding DPNP implementations.
 
 ``-`` in DPNP column means that DPNP implementation is not provided yet.
 

doc/reference/creation.rst

@@ -20,7 +20,6 @@ Basic creation routines
    dpnp.zeros_like
    dpnp.full
    dpnp.full_like
-   dpnp.vander
 
 
 Creation from other data
@@ -35,7 +34,13 @@ Creation from other data
    dpnp.asanyarray
    dpnp.ascontiguousarray
    dpnp.copy
+   dpnp.frombuffer
+   dpnp.from_dlpack
    dpnp.fromfile
+   dpnp.fromfunction
+   dpnp.fromiter
+   dpnp.fromstring
+   dpnp.loadtxt
 
 
 Numerical ranges
@@ -66,3 +71,14 @@ Matrix creation
    dpnp.tri
    dpnp.tril
    dpnp.triu
+   dpnp.vander
+
+
+The Matrix class
+----------------
+.. autosummary::
+   :toctree: generated/
+   :nosignatures:
+
+   dpnp.mat
+   dpnp.bmat

doc/reference/dtype.rst

@@ -0,0 +1,56 @@
+Data type routines
+==================
+
+.. https://docs.scipy.org/doc/numpy/reference/routines.dtype.html
+
+.. autosummary::
+   :toctree: generated/
+   :nosignatures:
+
+   dpnp.can_cast
+   dpnp.promote_types
+   dpnp.min_scalar_type
+   dpnp.result_type
+   dpnp.common_type
+   dpnp.obj2sctype
+
+Creating data types
+-------------------
+.. autosummary::
+   :toctree: generated/
+   :nosignatures:
+
+   dpnp.dtype
+   dpnp.format_parser
+
+Data type information
+---------------------
+.. autosummary::
+   :toctree: generated/
+   :nosignatures:
+
+   dpnp.finfo
+   dpnp.iinfo
+
+Data type testing
+-----------------
+.. autosummary::
+   :toctree: generated/
+   :nosignatures:
+
+   dpnp.issctype
+   dpnp.issubdtype
+   dpnp.issubsctype
+   dpnp.issubclass_
+   dpnp.find_common_type
+
+Miscellaneous
+-------------
+.. autosummary::
+   :toctree: generated/
+   :nosignatures:
+
+   dpnp.typename
+   dpnp.sctype2char
+   dpnp.mintypecode
+   dpnp.maximum_sctype

doc/reference/indexing.rst

@@ -0,0 +1,72 @@
+Array Indexing Routines
+=======================
+
+.. https://docs.scipy.org/doc/numpy/reference/arrays.indexing.html
+
+Generating index arrays
+-----------------------
+
+
+.. autosummary::
+   :toctree: generated/
+   :nosignatures:
+
+   dpnp.c_
+   dpnp.r_
+   dpnp.s_
+   dpnp.nonzero
+   dpnp.where
+   dpnp.indices
+   dpnp.ix_
+   dpnp.ogrid
+   dpnp.ravel_multi_index
+   dpnp.unravel_index
+   dpnp.diag_indices
+   dpnp.diag_indices_from
+   dpnp.mask_indices
+   dpnp.tril_indices
+   dpnp.tril_indices_from
+   dpnp.triu_indices
+   dpnp.triu_indices_from
+
+
+Indexing-like operations
+------------------------
+.. autosummary::
+   :toctree: generated/
+   :nosignatures:
+
+   dpnp.take
+   dpnp.take_along_axis
+   dpnp.choose
+   dpnp.compress
+   dpnp.diag
+   dpnp.diagonal
+   dpnp.select
+
+
+Inserting data into arrays
+--------------------------
+.. autosummary::
+   :toctree: generated/
+   :nosignatures:
+
+   dpnp.place
+   dpnp.put
+   dpnp.put_along_axis
+   dpnp.putmask
+   dpnp.fill_diagonal
+
+
+Iterating over arrays
+---------------------
+.. autosummary::
+   :toctree: generated/
+   :nosignatures:
+
+   dpnp.nditer
+   dpnp.ndenumerate
+   dpnp.ndindex
+   dpnp.nested_iters
+   dpnp.flatiter
+   dpnp.iterable

doc/reference/linalg.rst

@@ -10,7 +10,6 @@ Matrix and vector products
    :toctree: generated/
    :nosignatures:
 
-   dpnp.cross
    dpnp.dot
    dpnp.linalg.multi_dot
    dpnp.vdot
@@ -46,15 +45,16 @@ Matrix eigenvalues
    dpnp.linalg.eigvals
    dpnp.linalg.eigvalsh
 
-Norms etc.
+Norms and other numbers
 ----------
 
 .. autosummary::
    :toctree: generated/
    :nosignatures:
 
-   dpnp.linalg.det
    dpnp.linalg.norm
+   dpnp.linalg.cond
+   dpnp.linalg.det
    dpnp.linalg.matrix_rank
    dpnp.linalg.slogdet
    dpnp.trace
@@ -73,14 +73,3 @@ Solving linear equations
    dpnp.linalg.inv
    dpnp.linalg.pinv
    dpnp.linalg.tensorinv
-
-Special Matrices
-----------------
-
-.. autosummary::
-   :toctree: generated/
-   :nosignatures:
-
-   dpnp.tri
-   dpnp.tril
-   dpnp.triu

doc/reference/manipulation.rst

@@ -11,6 +11,7 @@ Basic operations
    :nosignatures:
 
    dpnp.copyto
+   dpnp.shape
 
 
 Changing array shape
@@ -22,6 +23,8 @@ Changing array shape
 
    dpnp.reshape
    dpnp.ravel
+   dpnp.ndarray.flat
+   dpnp.ndarray.flatten
 
 
 Transpose-like operations
@@ -34,10 +37,9 @@ Transpose-like operations
    dpnp.moveaxis
    dpnp.rollaxis
    dpnp.swapaxes
+   dpnp.ndarray.T
    dpnp.transpose
 
-.. seealso::
-   :attr:`dpnp.dparray.T`
 
 Changing number of dimensions
 -----------------------------
@@ -66,6 +68,7 @@ Changing kind of array
    dpnp.asarray
    dpnp.asnumpy
    dpnp.asanyarray
+   dpnp.asmatrix
    dpnp.asfarray
    dpnp.asfortranarray
    dpnp.ascontiguousarray
@@ -81,10 +84,12 @@ Joining arrays
 
    dpnp.concatenate
    dpnp.stack
+   dpnp.block
+   dpnp.vstack
+   dpnp.hstack
    dpnp.column_stack
+   dpnp.row_stack
    dpnp.dstack
-   dpnp.hstack
-   dpnp.vstack
 
 
 Splitting arrays
@@ -119,6 +124,10 @@ Adding and removing elements
    :toctree: generated/
    :nosignatures:
 
+   dpnp.delete
+   dpnp.insert
+   dpnp.append
+   dpnp.resize
    dpnp.unique
    dpnp.trim_zeros
 

doc/reference/math.rst

@@ -48,7 +48,7 @@ Rounding
    :nosignatures:
 
    dpnp.around
-   dpnp.round_
+   dpnp.round
    dpnp.rint
    dpnp.fix
    dpnp.floor
@@ -119,6 +119,17 @@ Floating point routines
    dpnp.frexp
    dpnp.ldexp
    dpnp.nextafter
+   dpnp.spacing
+
+
+Rational routines
+-----------------
+.. autosummary::
+   :toctree: generated/
+   :nosignatures:
+
+   dpnp.lcm
+   dpnp.gcd
 
 
 Arithmetic operations
@@ -131,12 +142,14 @@ Arithmetic operations
    dpnp.add
    dpnp.reciprocal
    dpnp.negative
+   dpnp.positive
    dpnp.multiply
    dpnp.divide
    dpnp.power
    dpnp.subtract
    dpnp.true_divide
    dpnp.floor_divide
+   dpnp.floor_power
    dpnp.fmod
    dpnp.mod
    dpnp.modf
@@ -155,6 +168,26 @@ Handling complex numbers
    dpnp.real
    dpnp.imag
    dpnp.conj
+   dpnp.conjugate
+
+
+Extrema Finding
+---------------
+
+.. autosummary::
+   :toctree: generated/
+   :nosignatures:
+
+   dpnp.maximum
+   dpnp.max
+   dpnp.amax
+   dpnp.fmax
+   dpnp.nanmax
+   dpnp.minimum
+   dpnp.min
+   dpnp.amin
+   dpnp.fmin
+   dpnp.nanmin
 
 
 Miscellaneous
@@ -173,10 +206,6 @@ Miscellaneous
    dpnp.absolute
    dpnp.fabs
    dpnp.sign
-   dpnp.maximum
-   dpnp.minimum
-   dpnp.fmax
-   dpnp.fmin
    dpnp.nan_to_num
    dpnp.bartlett
    dpnp.blackman

doc/reference/misc.rst

@@ -11,3 +11,8 @@ Utility
    :nosignatures:
 
    dpnp.get_include
+   dpnp.show_config
+   dpnp.show_runtime
+   dpnp.deprecate
+   dpnp.deprecate_with_doc
+   dpnp.broadcast_shapes

doc/reference/random.rst

@@ -3,7 +3,6 @@
 Random Sampling (``dpnp.random``)
 =================================
 
-.. https://docs.scipy.org/doc/numpy-1.16.1/reference/routines.random.html
 .. https://docs.scipy.org/doc/numpy/reference/random/legacy.html
 
 

doc/reference/routines.rst

@@ -13,7 +13,9 @@ These functions cover a subset of
 
    creation
    manipulation
+   indexing
    binary
+   dtype
    fft
    linalg
    logic

doc/reference/sorting.rst

@@ -37,6 +37,7 @@ Searching
    dpnp.where
    dpnp.argwhere
    dpnp.searchsorted
+   dpnp.extract
 
 Counting
 --------