jax.numpy.nanmedian

Contents

jax.numpy.nanmedian#

jax.numpy.nanmedian(a, axis=None, out=None, overwrite_input=False, keepdims=False)[source]#

Compute the median along the specified axis, while ignoring NaNs.

LAX-backend implementation of numpy.nanmedian().

Original docstring below.

Returns the median of the array elements.

Added in version 1.9.0.

Parameters:
  • a (array_like) – Input array or object that can be converted to an array.

  • axis ({int, sequence of int, None}, optional) – Axis or axes along which the medians are computed. The default is to compute the median along a flattened version of the array. A sequence of axes is supported since version 1.9.0.

  • keepdims (bool, optional) –

    If this is set to True, the axes which are reduced are left in the result as dimensions with size one. With this option, the result will broadcast correctly against the original a.

    If this is anything but the default value it will be passed through (in the special case of an empty array) to the mean function of the underlying array. If the array is a sub-class and mean does not have the kwarg keepdims this will raise a RuntimeError.

  • out (None)

  • overwrite_input (bool)

Returns:

median – A new array holding the result. If the input contains integers or floats smaller than float64, then the output data-type is np.float64. Otherwise, the data-type of the output is the same as that of the input. If out is specified, that array is returned instead.

Return type:

ndarray