@@ -318,8 +318,8 @@ We provide a number of common statistical functions:
318
318
:meth: `~Rolling.kurt `, Sample kurtosis (4th moment)
319
319
:meth: `~Rolling.quantile `, Sample quantile (value at %)
320
320
:meth: `~Rolling.apply `, Generic apply
321
- :meth: `~Rolling.cov `, Unbiased covariance (binary)
322
- :meth: `~Rolling.corr `, Correlation (binary)
321
+ :meth: `~Rolling.cov `, Sample covariance (binary)
322
+ :meth: `~Rolling.corr `, Sample correlation (binary)
323
323
324
324
.. _computation.window_variance.caveats :
325
325
@@ -341,6 +341,8 @@ We provide a number of common statistical functions:
341
341
sample variance under the circumstances would result in a biased estimator
342
342
of the variable we are trying to determine.
343
343
344
+ The same caveats apply to using any supported statistical sample methods.
345
+
344
346
.. _stats.rolling_apply :
345
347
346
348
Rolling apply
@@ -380,8 +382,8 @@ and their default values are set to ``False``, ``True`` and ``False`` respective
380
382
.. note ::
381
383
382
384
In terms of performance, **the first time a function is run using the Numba engine will be slow **
383
- as Numba will have some function compilation overhead. However, `` rolling `` objects will cache
384
- the function and subsequent calls will be fast. In general, the Numba engine is performant with
385
+ as Numba will have some function compilation overhead. However, the compiled functions are cached,
386
+ and subsequent calls will be fast. In general, the Numba engine is performant with
385
387
a larger amount of data points (e.g. 1+ million).
386
388
387
389
.. code-block :: ipython
@@ -870,12 +872,12 @@ Method summary
870
872
:meth: `~Expanding.max `, Maximum
871
873
:meth: `~Expanding.std `, Sample standard deviation
872
874
:meth: `~Expanding.var `, Sample variance
873
- :meth: `~Expanding.skew `, Unbiased skewness (3rd moment)
874
- :meth: `~Expanding.kurt `, Unbiased kurtosis (4th moment)
875
+ :meth: `~Expanding.skew `, Sample skewness (3rd moment)
876
+ :meth: `~Expanding.kurt `, Sample kurtosis (4th moment)
875
877
:meth: `~Expanding.quantile `, Sample quantile (value at %)
876
878
:meth: `~Expanding.apply `, Generic apply
877
- :meth: `~Expanding.cov `, Unbiased covariance (binary)
878
- :meth: `~Expanding.corr `, Correlation (binary)
879
+ :meth: `~Expanding.cov `, Sample covariance (binary)
880
+ :meth: `~Expanding.corr `, Sample correlation (binary)
879
881
880
882
.. note ::
881
883
@@ -884,6 +886,8 @@ Method summary
884
886
windows. See :ref: `this section <computation.window_variance.caveats >` for more
885
887
information.
886
888
889
+ The same caveats apply to using any supported statistical sample methods.
890
+
887
891
.. currentmodule :: pandas
888
892
889
893
Aside from not having a ``window `` parameter, these functions have the same
0 commit comments