Merge branch 'main' into lithomas1-fix-dask

Author: asmeurer

.github/workflows/ruff.yml

@@ -16,4 +16,4 @@ jobs:
           pip install ruff
       # Update output format to enable automatic inline annotations.
       - name: Run Ruff
-        run: ruff check --output-format=github --select F822,PLC0414,RUF022 --preview .
+        run: ruff check --output-format=github .

README.md

@@ -71,23 +71,24 @@ namespace, except that functions that are part of the array API are wrapped so
 that they have the correct array API behavior. In each case, the array object
 used will be the same array object from the wrapped library.
 
-## Difference between `array_api_compat` and `numpy.array_api`
+## Difference between `array_api_compat` and `array_api_strict`
 
-`numpy.array_api` is a strict minimal implementation of the Array API (see
+`array_api_strict` is a strict minimal implementation of the array API standard, formerly
+known as `numpy.array_api` (see
 [NEP 47](https://numpy.org/neps/nep-0047-array-api-standard.html)). For
-example, `numpy.array_api` does not include any functions that are not part of
+example, `array_api_strict` does not include any functions that are not part of
 the array API specification, and will explicitly disallow behaviors that are
 not required by the spec (e.g., [cross-kind type
 promotions](https://data-apis.org/array-api/latest/API_specification/type_promotion.html)).
-(`cupy.array_api` is similar to `numpy.array_api`)
+(`cupy.array_api` is similar to `array_api_strict`)
 
 `array_api_compat`, on the other hand, is just an extension of the
 corresponding array library namespaces with changes needed to be compliant
 with the array API. It includes all additional library functions not mentioned
 in the spec, and allows any library behaviors not explicitly disallowed by it,
 such as cross-kind casting.
 
-In particular, unlike `numpy.array_api`, this package does not use a separate
+In particular, unlike `array_api_strict`, this package does not use a separate
 `Array` object, but rather just uses the corresponding array library array
 objects (`numpy.ndarray`, `cupy.ndarray`, `torch.Tensor`, etc.) directly. This
 is because those are the objects that are going to be passed as inputs to
@@ -96,7 +97,7 @@ functions by end users. This does mean that a few behaviors cannot be wrapped
 most things.
 
 Array consuming library authors coding against the array API may wish to test
-against `numpy.array_api` to ensure they are not using functionality outside
+against `array_api_strict` to ensure they are not using functionality outside
 of the standard, but prefer this implementation for the default behavior for
 end-users.
 

array_api_compat/__init__.py

@@ -5,14 +5,14 @@
 Array API standard https://data-apis.org/array-api/latest/. See also NEP 47
 https://numpy.org/neps/nep-0047-array-api-standard.html.
 
-Unlike numpy.array_api, this is not a strict minimal implementation of the
+Unlike array_api_strict, this is not a strict minimal implementation of the
 Array API, but rather just an extension of the main NumPy namespace with
 changes needed to be compliant with the Array API. See
 https://numpy.org/doc/stable/reference/array_api.html for a full list of
-changes. In particular, unlike numpy.array_api, this package does not use a
+changes. In particular, unlike array_api_strict, this package does not use a
 separate Array object, but rather just uses numpy.ndarray directly.
 
-Library authors using the Array API may wish to test against numpy.array_api
+Library authors using the Array API may wish to test against array_api_strict
 to ensure they are not using functionality outside of the standard, but prefer
 this implementation for the default when working with NumPy arrays.
 

array_api_compat/_internal.py

@@ -5,7 +5,6 @@
 from functools import wraps
 from inspect import signature
 
-
 def get_xp(xp):
     """
     Decorator to automatically replace xp with the corresponding array module.
@@ -45,31 +44,3 @@ def wrapped_f(*args, **kwargs):
         return wrapped_f
 
     return inner
-
-
-def _get_all_public_members(module, exclude=None, extend_all=False):
-    """Get all public members of a module.
-
-    Parameters
-    ----------
-    module : module
-        The module to get members from.
-    exclude : callable, optional
-        A callable that takes a name and returns True if the name should be
-        excluded from the list of members.
-    extend_all : bool, optional
-        If True, extend the module's __all__ attribute with the members of the
-        module derived from dir(module). To be used for libraries that do not have a complete __all__ list.
-    """
-    members = getattr(module, "__all__", [])
-
-    if members and not extend_all:
-        return members
-
-    if exclude is None:
-        exclude = lambda name: name.startswith("_")  # noqa: E731
-
-    members = members + [_ for _ in dir(module) if not exclude(_)]
-
-    # remove duplicates
-    return list(set(members))

array_api_compat/common/__init__.py

@@ -1,27 +1 @@
-from ._helpers import (
-    array_namespace,
-    device,
-    get_namespace,
-    is_array_api_obj,
-    is_cupy_array,
-    is_dask_array,
-    is_jax_array,
-    is_numpy_array,
-    is_torch_array,
-    size,
-    to_device,
-)
-
-__all__ = [
-    "array_namespace",
-    "device",
-    "get_namespace",
-    "is_array_api_obj",
-    "is_cupy_array",
-    "is_dask_array",
-    "is_jax_array",
-    "is_numpy_array",
-    "is_torch_array",
-    "size",
-    "to_device",
-]
+from ._helpers import * # noqa: F403

array_api_compat/common/_aliases.py

@@ -146,6 +146,9 @@ def zeros_like(
 
 # The functions here return namedtuples (np.unique() returns a normal
 # tuple).
+
+# Note that these named tuples aren't actually part of the standard namespace,
+# but I don't see any issue with exporting the names here regardless.
 class UniqueAllResult(NamedTuple):
     values: ndarray
     indices: ndarray
@@ -543,5 +546,13 @@ def isdtype(
         # This will allow things that aren't required by the spec, like
         # isdtype(np.float64, float) or isdtype(np.int64, 'l'). Should we be
         # more strict here to match the type annotation? Note that the
-        # numpy.array_api implementation will be very strict.
+        # array_api_strict implementation will be very strict.
         return dtype == kind
+
+__all__ = ['arange', 'empty', 'empty_like', 'eye', 'full', 'full_like',
+           'linspace', 'ones', 'ones_like', 'zeros', 'zeros_like',
+           'UniqueAllResult', 'UniqueCountsResult', 'UniqueInverseResult',
+           'unique_all', 'unique_counts', 'unique_inverse', 'unique_values',
+           'astype', 'std', 'var', 'permute_dims', 'reshape', 'argsort',
+           'sort', 'nonzero', 'sum', 'prod', 'ceil', 'floor', 'trunc',
+           'matmul', 'matrix_transpose', 'tensordot', 'vecdot', 'isdtype']

array_api_compat/common/_helpers.py

@@ -307,3 +307,19 @@ def size(x):
     if None in x.shape:
         return None
     return math.prod(x.shape)
+
+__all__ = [
+    "array_namespace",
+    "device",
+    "get_namespace",
+    "is_array_api_obj",
+    "is_cupy_array",
+    "is_dask_array",
+    "is_jax_array",
+    "is_numpy_array",
+    "is_torch_array",
+    "size",
+    "to_device",
+]
+
+_all_ignore = ['sys', 'math', 'inspect']

array_api_compat/common/_linalg.py

@@ -11,7 +11,7 @@
 else:
     from numpy.core.numeric import normalize_axis_tuple
 
-from ._aliases import matrix_transpose, isdtype
+from ._aliases import matmul, matrix_transpose, tensordot, vecdot, isdtype
 from .._internal import get_xp
 
 # These are in the main NumPy namespace but not in numpy.linalg
@@ -149,4 +149,10 @@ def trace(x: ndarray, /, xp, *, offset: int = 0, dtype=None, **kwargs) -> ndarra
             dtype = xp.float64
         elif x.dtype == xp.complex64:
             dtype = xp.complex128
-    return xp.asarray(xp.trace(x, offset=offset, dtype=dtype, axis1=-2, axis2=-1, **kwargs))
+    return xp.asarray(xp.trace(x, offset=offset, dtype=dtype, axis1=-2, axis2=-1, **kwargs))
+
+__all__ = ['cross', 'matmul', 'outer', 'tensordot', 'EighResult',
+           'QRResult', 'SlogdetResult', 'SVDResult', 'eigh', 'qr', 'slogdet',
+           'svd', 'cholesky', 'matrix_rank', 'pinv', 'matrix_norm',
+           'matrix_transpose', 'svdvals', 'vecdot', 'vector_norm', 'diagonal',
+           'trace']

array_api_compat/common/_typing.py

@@ -20,4 +20,4 @@ def __len__(self, /) -> int: ...
 SupportsBufferProtocol = Any
 
 Array = Any
-Device = Any
+Device = Any

array_api_compat/cupy/__init__.py

@@ -1,153 +1,14 @@
-import cupy as _cp
-from cupy import *  # noqa: F401, F403
+from cupy import * # noqa: F403
 
 # from cupy import * doesn't overwrite these builtin names
-from cupy import abs, max, min, round
-
-from .._internal import _get_all_public_members
-from ..common._helpers import (
-    array_namespace,
-    device,
-    get_namespace,
-    is_array_api_obj,
-    size,
-    to_device,
-)
+from cupy import abs, max, min, round # noqa: F401
 
 # These imports may overwrite names from the import * above.
-from ._aliases import (
-    UniqueAllResult,
-    UniqueCountsResult,
-    UniqueInverseResult,
-    acos,
-    acosh,
-    arange,
-    argsort,
-    asarray,
-    asarray_cupy,
-    asin,
-    asinh,
-    astype,
-    atan,
-    atan2,
-    atanh,
-    bitwise_invert,
-    bitwise_left_shift,
-    bitwise_right_shift,
-    bool,
-    ceil,
-    concat,
-    empty,
-    empty_like,
-    eye,
-    floor,
-    full,
-    full_like,
-    isdtype,
-    linspace,
-    matmul,
-    matrix_transpose,
-    nonzero,
-    ones,
-    ones_like,
-    permute_dims,
-    pow,
-    prod,
-    reshape,
-    sort,
-    std,
-    sum,
-    tensordot,
-    trunc,
-    unique_all,
-    unique_counts,
-    unique_inverse,
-    unique_values,
-    var,
-    vecdot,
-    zeros,
-    zeros_like,
-)
-
-__all__ = []
-
-__all__ += _get_all_public_members(_cp)
-
-__all__ += [
-    "abs",
-    "max",
-    "min",
-    "round",
-]
-
-__all__ += [
-    "array_namespace",
-    "device",
-    "get_namespace",
-    "is_array_api_obj",
-    "size",
-    "to_device",
-]
-
-__all__ += [
-    "UniqueAllResult",
-    "UniqueCountsResult",
-    "UniqueInverseResult",
-    "acos",
-    "acosh",
-    "arange",
-    "argsort",
-    "asarray",
-    "asarray_cupy",
-    "asin",
-    "asinh",
-    "astype",
-    "atan",
-    "atan2",
-    "atanh",
-    "bitwise_invert",
-    "bitwise_left_shift",
-    "bitwise_right_shift",
-    "bool",
-    "ceil",
-    "concat",
-    "empty",
-    "empty_like",
-    "eye",
-    "floor",
-    "full",
-    "full_like",
-    "isdtype",
-    "linspace",
-    "matmul",
-    "matrix_transpose",
-    "nonzero",
-    "ones",
-    "ones_like",
-    "permute_dims",
-    "pow",
-    "prod",
-    "reshape",
-    "sort",
-    "std",
-    "sum",
-    "tensordot",
-    "trunc",
-    "unique_all",
-    "unique_counts",
-    "unique_inverse",
-    "unique_values",
-    "var",
-    "zeros",
-    "zeros_like",
-]
-
-__all__ += [
-    "matrix_transpose",
-    "vecdot",
-]
+from ._aliases import * # noqa: F403
 
 # See the comment in the numpy __init__.py
-__import__(__package__ + ".linalg")
+__import__(__package__ + '.linalg')
+
+from ..common._helpers import * # noqa: F401,F403
 
-__array_api_version__ = "2022.12"
+__array_api_version__ = '2022.12'