@@ -6279,14 +6279,82 @@ def mean(
6279
6279
)
6280
6280
6281
6281
@deprecate_nonkeyword_arguments (version = "3.0" , allowed_args = ["self" ], name = "median" )
6282
- @doc (make_doc ("median" , ndim = 1 ))
6283
6282
def median (
6284
6283
self ,
6285
6284
axis : Axis | None = 0 ,
6286
6285
skipna : bool = True ,
6287
6286
numeric_only : bool = False ,
6288
6287
** kwargs ,
6289
6288
) -> Any :
6289
+ """
6290
+ Return the median of the values over the requested axis.
6291
+
6292
+ Parameters
6293
+ ----------
6294
+ axis : {index (0)}
6295
+ Axis for the function to be applied on.
6296
+ For `Series` this parameter is unused and defaults to 0.
6297
+
6298
+ For DataFrames, specifying ``axis=None`` will apply the aggregation
6299
+ across both axes.
6300
+
6301
+ .. versionadded:: 2.0.0
6302
+
6303
+ skipna : bool, default True
6304
+ Exclude NA/null values when computing the result.
6305
+ numeric_only : bool, default False
6306
+ Include only float, int, boolean columns.
6307
+ **kwargs
6308
+ Additional keyword arguments to be passed to the function.
6309
+
6310
+ Returns
6311
+ -------
6312
+ scalar or Series (if level specified)
6313
+ Median of the values for the requested axis.
6314
+
6315
+ See Also
6316
+ --------
6317
+ numpy.median : Equivalent numpy function for computing median.
6318
+ Series.sum : Sum of the values.
6319
+ Series.median : Median of the values.
6320
+ Series.std : Standard deviation of the values.
6321
+ Series.var : Variance of the values.
6322
+ Series.min : Minimum value.
6323
+ Series.max : Maximum value.
6324
+
6325
+ Examples
6326
+ --------
6327
+ >>> s = pd.Series([1, 2, 3])
6328
+ >>> s.median()
6329
+ 2.0
6330
+
6331
+ With a DataFrame
6332
+
6333
+ >>> df = pd.DataFrame({"a": [1, 2], "b": [2, 3]}, index=["tiger", "zebra"])
6334
+ >>> df
6335
+ a b
6336
+ tiger 1 2
6337
+ zebra 2 3
6338
+ >>> df.median()
6339
+ a 1.5
6340
+ b 2.5
6341
+ dtype: float64
6342
+
6343
+ Using axis=1
6344
+
6345
+ >>> df.median(axis=1)
6346
+ tiger 1.5
6347
+ zebra 2.5
6348
+ dtype: float64
6349
+
6350
+ In this case, `numeric_only` should be set to `True`
6351
+ to avoid getting an error.
6352
+
6353
+ >>> df = pd.DataFrame({"a": [1, 2], "b": ["T", "Z"]}, index=["tiger", "zebra"])
6354
+ >>> df.median(numeric_only=True)
6355
+ a 1.5
6356
+ dtype: float64
6357
+ """
6290
6358
return NDFrame .median (
6291
6359
self , axis = axis , skipna = skipna , numeric_only = numeric_only , ** kwargs
6292
6360
)
0 commit comments