Move dpnp.special to dpnp.scipy.special

Author: vlad-perevezentsev

.pre-commit-config.yaml

@@ -113,7 +113,7 @@ repos:
             "--disable=redefined-builtin",
             "--disable=unused-wildcard-import"
             ]
-        files: '^dpnp/(dpnp_iface.*|fft|linalg|scipy|special|dpnp_array)'
+        files: '^dpnp/(dpnp_iface.*|fft|linalg|scipy|dpnp_array)'
 -   repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
     rev: v2.15.0
     hooks:

dpnp/dpnp_iface.py

@@ -55,7 +55,6 @@
 from dpnp.linalg import *
 from dpnp.memory import *
 from dpnp.random import *
-from dpnp.special import *
 
 __all__ = [
     "are_same_logical_tensors",

dpnp/scipy/__init__.py

@@ -34,6 +34,6 @@
 DPNP functionality, reusing DPNP and oneMKL implementations underneath.
 """
 
-from . import linalg
+from . import linalg, special
 
-__all__ = ["linalg"]
+__all__ = ["linalg", "special"]

dpnp/special/__init__.py renamed to dpnp/scipy/special/__init__.py

@@ -25,8 +25,8 @@
 # *****************************************************************************
 
 """
-``dpnp.special``
-================
+``dpnp.scipy.special``
+======================
 
 The submodule provides a large collection of mathematical functions that are
 widely used in science and engineering. It includes special functions of

dpnp/special/_erf.py renamed to dpnp/scipy/special/_erf.py

@@ -29,7 +29,7 @@
 
 Notes
 -----
-This module is a face or public interface file for the library
+This module exposes the public interface for ``dpnp.scipy.special``.
 it contains:
  - Interface functions
  - documentation for the functions
@@ -92,11 +92,11 @@ def __call__(self, x, out=None):  # pylint: disable=signature-differs
 
 See Also
 --------
-:obj:`dpnp.special.erfc` : Complementary error function.
-:obj:`dpnp.special.erfinv` : Inverse of the error function.
-:obj:`dpnp.special.erfcinv` : Inverse of the complementary error function.
-:obj:`dpnp.special.erfcx` : Scaled complementary error function.
-:obj:`dpnp.special.erfi` : Imaginary error function.
+:obj:`dpnp.scipy.special.erfc` : Complementary error function.
+:obj:`dpnp.scipy.special.erfinv` : Inverse of the error function.
+:obj:`dpnp.scipy.special.erfcinv` : Inverse of the complementary error function.
+:obj:`dpnp.scipy.special.erfcx` : Scaled complementary error function.
+:obj:`dpnp.scipy.special.erfi` : Imaginary error function.
 
 Notes
 -----
@@ -113,7 +113,7 @@ def __call__(self, x, out=None):  # pylint: disable=signature-differs
 --------
 >>> import dpnp as np
 >>> x = np.linspace(-3, 3, num=5)
->>> np.special.erf(x)
+>>> np.scipy.special.erf(x)
 array([[-0.99997791, -0.96610515,  0.        ,  0.96610515,  0.99997791])
 
 """
@@ -148,17 +148,17 @@ def __call__(self, x, out=None):  # pylint: disable=signature-differs
 
 See Also
 --------
-:obj:`dpnp.special.erf` : Gauss error function.
-:obj:`dpnp.special.erfinv` : Inverse of the error function.
-:obj:`dpnp.special.erfcinv` : Inverse of the complementary error function.
-:obj:`dpnp.special.erfcx` : Scaled complementary error function.
-:obj:`dpnp.special.erfi` : Imaginary error function.
+:obj:`dpnp.scipy.special.erf` : Gauss error function.
+:obj:`dpnp.scipy.special.erfinv` : Inverse of the error function.
+:obj:`dpnp.scipy.special.erfcinv` : Inverse of the complementary error function.
+:obj:`dpnp.scipy.special.erfcx` : Scaled complementary error function.
+:obj:`dpnp.scipy.special.erfi` : Imaginary error function.
 
 Examples
 --------
 >>> import dpnp as np
 >>> x = np.linspace(-3, 3, num=5)
->>> np.special.erfc(x)
+>>> np.scipy.special.erfc(x)
 array([[-0.99997791, -0.96610515,  0.        ,  0.96610515,  0.99997791])
 
 """

setup.py

@@ -37,9 +37,9 @@
         "dpnp.linalg",
         "dpnp.memory",
         "dpnp.random",
-        "dpnp.special",
         "dpnp.scipy",
         "dpnp.scipy.linalg",
+        "dpnp.scipy.special",
     ],
     package_data={
         "dpnp": [