bundles / numpy 2.4.4 / numpy / squeeze
_ArrayFunctionDispatcher
numpy:squeeze
Signature
def squeeze ( a , axis = None ) Summary
Remove axes of length one from a.
Parameters
a: array_likeInput data.
axis: None or int or tuple of ints, optionalSelects a subset of the entries of length one in the shape. If an axis is selected with shape entry greater than one, an error is raised.
Returns
squeezed: ndarrayThe input array, but with all or a subset of the dimensions of length 1 removed. This is always
aitself or a view intoa. Note that if all axes are squeezed, the result is a 0d array and not a scalar.
Raises
: ValueErrorIf
axisis not None, and an axis being squeezed is not of length 1
Examples
import numpy as np x = np.array([[[0], [1], [2]]]) x.shape np.squeeze(x).shape np.squeeze(x, axis=0).shape✓
np.squeeze(x, axis=1).shape
✗np.squeeze(x, axis=2).shape x = np.array([[1234]]) x.shape✓
np.squeeze(x)
✗np.squeeze(x).shape
✓np.squeeze(x)[()]
✗See also
- expand_dims
The inverse operation, adding entries of length one
- reshape
Insert, remove, and combine dimensions, and resize existing ones
Aliases
-
numpy.squeeze