Rename signatures module to array_api

Author: steff456

spec/API_specification/array_api/__init__.py

@@ -0,0 +1,15 @@
+from .array_object import *
+from .constants import *
+from .creation_functions import *
+from .data_type_functions import *
+from .data_types import *
+from .elementwise_functions import *
+from .linear_algebra_functions import *
+from .manipulation_functions import *
+from .searching_functions import *
+from .set_functions import *
+from .sorting_functions import *
+from .statistical_functions import *
+from .utility_functions import *
+
+#__all__ = ['Any', 'Device', 'Dtype', 'Enum', 'Optional', 'PyCapsule', 'Tuple', 'Union', '_types', 'abs', 'acos', 'acosh', 'add', 'all', 'annotations', 'any', 'arange', 'argmax', 'argmin', 'argsort', 'array', 'array_object', 'asarray', 'asin', 'asinh', 'astype', 'atan', 'atan2', 'atanh', 'bitwise_and', 'bitwise_invert', 'bitwise_left_shift', 'bitwise_or', 'bitwise_right_shift', 'bitwise_xor', 'broadcast_arrays', 'broadcast_to', 'can_cast', 'ceil', 'concat', 'constants', 'cos', 'cosh', 'creation_functions', 'data_type_functions', 'data_types', 'divide', 'dtype', 'e', 'elementwise_functions', 'ellipsis', 'empty', 'empty_like', 'equal', 'exp', 'expand_dims', 'expm1', 'eye', 'finfo', 'flip', 'floor', 'floor_divide', 'from_dlpack', 'full', 'full_like', 'greater', 'greater_equal', 'iinfo', 'inf', 'isfinite', 'isinf', 'isnan', 'less', 'less_equal', 'linear_algebra_functions', 'linspace', 'log', 'log10', 'log1p', 'log2', 'logaddexp', 'logical_and', 'logical_not', 'logical_or', 'logical_xor', 'manipulation_functions', 'matmul', 'matrix_transpose', 'max', 'mean', 'meshgrid', 'min', 'multiply', 'nan', 'negative', 'newaxis', 'nonzero', 'not_equal', 'ones', 'ones_like', 'permute_dims', 'pi', 'positive', 'pow', 'prod', 'remainder', 'reshape', 'result_type', 'roll', 'round', 'searching_functions', 'set_functions', 'sign', 'sin', 'sinh', 'sort', 'sorting_functions', 'sqrt', 'square', 'squeeze', 'stack', 'statistical_functions', 'std', 'subtract', 'sum', 'tan', 'tanh', 'tensordot', 'tril', 'triu', 'trunc', 'unique_all', 'unique_counts', 'unique_inverse', 'unique_values', 'utility_functions', 'var', 'vecdot', 'where', 'zeros', 'zeros_like']

spec/API_specification/signatures/_types.py renamed to spec/API_specification/array_api/_types.py

@@ -135,7 +135,7 @@ def __abs__(self: array, /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.abs`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~array_api.elementwise_functions.abs`.
         """
 
     def __add__(self: array, other: Union[int, float, array], /) -> array:
@@ -181,7 +181,7 @@ def __add__(self: array, other: Union[int, float, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.add`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~array_api.elementwise_functions.add`.
         """
 
     def __and__(self: array, other: Union[int, bool, array], /) -> array:
@@ -202,7 +202,7 @@ def __and__(self: array, other: Union[int, bool, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.bitwise_and`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~array_api.elementwise_functions.bitwise_and`.
         """
 
     def __array_namespace__(self: array, /, *, api_version: Optional[str] = None) -> Any:
@@ -239,7 +239,7 @@ def __bool__(self: array, /) -> bool:
 
     def __dlpack__(self: array, /, *, stream: Optional[Union[int, Any]] = None) -> PyCapsule:
         """
-        Exports the array for consumption by :func:`~signatures.creation_functions.from_dlpack` as a DLPack capsule.
+        Exports the array for consumption by :func:`~array_api.creation_functions.from_dlpack` as a DLPack capsule.
 
         Parameters
         ----------
@@ -294,7 +294,7 @@ def __dlpack__(self: array, /, *, stream: Optional[Union[int, Any]] = None) -> P
 
     def __dlpack_device__(self: array, /) -> Tuple[Enum, int]:
         """
-        Returns device type and device ID in DLPack format. Meant for use within :func:`~signatures.creation_functions.from_dlpack`.
+        Returns device type and device ID in DLPack format. Meant for use within :func:`~array_api.creation_functions.from_dlpack`.
 
         Parameters
         ----------
@@ -336,7 +336,7 @@ def __eq__(self: array, other: Union[int, float, bool, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.equal`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~array_api.elementwise_functions.equal`.
         """
 
     def __float__(self: array, /) -> float:
@@ -411,7 +411,7 @@ def __floordiv__(self: array, other: Union[int, float, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.floor_divide`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~array_api.elementwise_functions.floor_divide`.
         """
 
     def __ge__(self: array, other: Union[int, float, array], /) -> array:
@@ -432,7 +432,7 @@ def __ge__(self: array, other: Union[int, float, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.greater_equal`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~array_api.elementwise_functions.greater_equal`.
         """
 
     def __getitem__(self: array, key: Union[int, slice, ellipsis, Tuple[Union[int, slice, ellipsis], ...], array], /) -> array:
@@ -470,7 +470,7 @@ def __gt__(self: array, other: Union[int, float, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.greater`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~array_api.elementwise_functions.greater`.
         """
 
     def __index__(self: array, /) -> int:
@@ -522,7 +522,7 @@ def __invert__(self: array, /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.bitwise_invert`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~array_api.elementwise_functions.bitwise_invert`.
         """
 
     def __le__(self: array, other: Union[int, float, array], /) -> array:
@@ -543,7 +543,7 @@ def __le__(self: array, other: Union[int, float, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.less_equal`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~array_api.elementwise_functions.less_equal`.
         """
 
     def __lshift__(self: array, other: Union[int, array], /) -> array:
@@ -564,7 +564,7 @@ def __lshift__(self: array, other: Union[int, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.bitwise_left_shift`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~array_api.elementwise_functions.bitwise_left_shift`.
         """
 
     def __lt__(self: array, other: Union[int, float, array], /) -> array:
@@ -585,7 +585,7 @@ def __lt__(self: array, other: Union[int, float, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.less`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~array_api.elementwise_functions.less`.
         """
 
     def __matmul__(self: array, other: array, /) -> array:
@@ -616,7 +616,7 @@ def __matmul__(self: array, other: array, /) -> array:
 
 
         .. note::
-           Results must equal the results returned by the equivalent function :func:`~signatures.linear_algebra_functions.matmul`.
+           Results must equal the results returned by the equivalent function :func:`~array_api.linear_algebra_functions.matmul`.
 
         **Raises**
 
@@ -676,7 +676,7 @@ def __mod__(self: array, other: Union[int, float, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.remainder`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~array_api.elementwise_functions.remainder`.
         """
 
     def __mul__(self: array, other: Union[int, float, array], /) -> array:
@@ -715,7 +715,7 @@ def __mul__(self: array, other: Union[int, float, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.multiply`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~array_api.elementwise_functions.multiply`.
         """
 
     def __ne__(self: array, other: Union[int, float, bool, array], /) -> array:
@@ -736,7 +736,7 @@ def __ne__(self: array, other: Union[int, float, bool, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.not_equal`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~array_api.elementwise_functions.not_equal`.
         """
 
     def __neg__(self: array, /) -> array:
@@ -758,7 +758,7 @@ def __neg__(self: array, /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.negative`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~array_api.elementwise_functions.negative`.
         """
 
     def __or__(self: array, other: Union[int, bool, array], /) -> array:
@@ -779,7 +779,7 @@ def __or__(self: array, other: Union[int, bool, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.bitwise_or`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~array_api.elementwise_functions.bitwise_or`.
         """
 
     def __pos__(self: array, /) -> array:
@@ -798,7 +798,7 @@ def __pos__(self: array, /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.positive`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~array_api.elementwise_functions.positive`.
         """
 
     def __pow__(self: array, other: Union[int, float, array], /) -> array:
@@ -853,7 +853,7 @@ def __pow__(self: array, other: Union[int, float, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.pow`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~array_api.elementwise_functions.pow`.
         """
 
     def __rshift__(self: array, other: Union[int, array], /) -> array:
@@ -874,7 +874,7 @@ def __rshift__(self: array, other: Union[int, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.bitwise_right_shift`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~array_api.elementwise_functions.bitwise_right_shift`.
         """
 
     def __setitem__(self: array, key: Union[int, slice, ellipsis, Tuple[Union[int, slice, ellipsis], ...], array], value: Union[int, float, bool, array], /) -> None:
@@ -918,7 +918,7 @@ def __sub__(self: array, other: Union[int, float, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.subtract`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~array_api.elementwise_functions.subtract`.
         """
 
     def __truediv__(self: array, other: Union[int, float, array], /) -> array:
@@ -971,7 +971,7 @@ def __truediv__(self: array, other: Union[int, float, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.divide`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~array_api.elementwise_functions.divide`.
         """
 
     def __xor__(self: array, other: Union[int, bool, array], /) -> array:
@@ -992,7 +992,7 @@ def __xor__(self: array, other: Union[int, bool, array], /) -> array:
 
 
         .. note::
-           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~signatures.elementwise_functions.bitwise_xor`.
+           Element-wise results must equal the results returned by the equivalent element-wise function :func:`~array_api.elementwise_functions.bitwise_xor`.
         """
 
     def to_device(self: array, device: Device, /, *, stream: Optional[Union[int, Any]] = None) -> array:
@@ -1019,3 +1019,5 @@ def to_device(self: array, device: Device, /, *, stream: Optional[Union[int, Any
         """
 
 array = _array
+
+__all__ = ['array']

spec/API_specification/signatures/array_object.py renamed to spec/API_specification/array_api/array_object.py

@@ -54,7 +54,7 @@ def asarray(obj: Union[array, bool, int, float, NestedSequence, SupportsBufferPr
         .. admonition:: Note
            :class: note
 
-           If ``dtype`` is not ``None``, then array conversions should obey :ref:`type-promotion` rules. Conversions not specified according to :ref:`type-promotion` rules may or may not be permitted by a conforming array library. To perform an explicit cast, use :func:`signatures.data_type_functions.astype`.
+           If ``dtype`` is not ``None``, then array conversions should obey :ref:`type-promotion` rules. Conversions not specified according to :ref:`type-promotion` rules may or may not be permitted by a conforming array library. To perform an explicit cast, use :func:`array_api.data_type_functions.astype`.
 
         .. note::
            If an input value exceeds the precision of the resolved output array data type, behavior is left unspecified and, thus, implementation-defined.

spec/API_specification/signatures/constants.py renamed to spec/API_specification/array_api/constants.py

@@ -157,7 +157,7 @@ def inv(x: array, /) -> array:
 
 def matmul(x1: array, x2: array, /) -> array:
     """
-    Alias for :func:`~signatures.linear_algebra_functions.matmul`.
+    Alias for :func:`~array_api.linear_algebra_functions.matmul`.
     """
 
 def matrix_norm(x: array, /, *, keepdims: bool = False, ord: Optional[Union[int, float, Literal[inf, -inf, 'fro', 'nuc']]] = 'fro') -> array:
@@ -249,7 +249,7 @@ def matrix_rank(x: array, /, *, rtol: Optional[Union[float, array]] = None) -> a
 
 def matrix_transpose(x: array, /) -> array:
     """
-    Alias for :func:`~signatures.linear_algebra_functions.matrix_transpose`.
+    Alias for :func:`~array_api.linear_algebra_functions.matrix_transpose`.
     """
 
 def outer(x1: array, x2: array, /) -> array:
@@ -406,7 +406,7 @@ def svdvals(x: array, /) -> array:
 
 def tensordot(x1: array, x2: array, /, *, axes: Union[int, Tuple[Sequence[int], Sequence[int]]] = 2) -> array:
     """
-    Alias for :func:`~signatures.linear_algebra_functions.tensordot`.
+    Alias for :func:`~array_api.linear_algebra_functions.tensordot`.
     """
 
 def trace(x: array, /, *, offset: int = 0) -> array:
@@ -440,7 +440,7 @@ def trace(x: array, /, *, offset: int = 0) -> array:
 
 def vecdot(x1: array, x2: array, /, *, axis: int = None) -> array:
     """
-    Alias for :func:`~signatures.linear_algebra_functions.vecdot`.
+    Alias for :func:`~array_api.linear_algebra_functions.vecdot`.
     """
 
 def vector_norm(x: array, /, *, axis: Optional[Union[int, Tuple[int, ...]]] = None, keepdims: bool = False, ord: Union[int, float, Literal[inf, -inf]] = 2) -> array:

spec/API_specification/signatures/creation_functions.py renamed to spec/API_specification/array_api/creation_functions.py

@@ -246,7 +246,7 @@ Bitwise Operators
 
 -------------------------------------------------
 
-.. currentmodule:: signatures.array_object
+.. currentmodule:: array_api.array_object
 
 Attributes
 ----------

spec/API_specification/signatures/data_type_functions.py renamed to spec/API_specification/array_api/data_type_functions.py

@@ -10,7 +10,7 @@ A conforming implementation of the array API standard must provide and support t
 Objects in API
 --------------
 
-.. currentmodule:: signatures.constants
+.. currentmodule:: array_api.constants
 
 ..
   NOTE: please keep the functions in alphabetical order

spec/API_specification/signatures/data_types.py renamed to spec/API_specification/array_api/data_types.py

@@ -11,7 +11,7 @@ A conforming implementation of the array API standard must provide and support t
 Objects in API
 --------------
 
-.. currentmodule:: signatures.creation_functions
+.. currentmodule:: array_api.creation_functions
 
 ..
   NOTE: please keep the functions in alphabetical order

spec/API_specification/signatures/elementwise_functions.py renamed to spec/API_specification/array_api/elementwise_functions.py

@@ -9,7 +9,7 @@ A conforming implementation of the array API standard must provide and support t
 Objects in API
 --------------
 
-.. currentmodule:: signatures.data_type_functions
+.. currentmodule:: array_api.data_type_functions
 
 ..
   NOTE: please keep the functions in alphabetical order

spec/API_specification/signatures/linalg.py renamed to spec/API_specification/array_api/linalg.py

@@ -100,7 +100,7 @@ Methods
 ..
   NOTE: please keep the functions in alphabetical order
 
-.. currentmodule:: signatures.data_types
+.. currentmodule:: array_api.data_types
 
 .. autosummary::
    :toctree: generated

spec/API_specification/signatures/linear_algebra_functions.py renamed to spec/API_specification/array_api/linear_algebra_functions.py

@@ -19,7 +19,7 @@ A conforming implementation of the array API standard must provide and support t
 Objects in API
 --------------
 
-.. currentmodule:: signatures.elementwise_functions
+.. currentmodule:: array_api.elementwise_functions
 
 ..
   NOTE: please keep the functions in alphabetical order