mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-05-11 02:02:01 +08:00
9f0d592839
* remove python 3.9 support and code * black * more cli lint * more linting * more lint * fix for tests * docstring grammar police * add lock to to build function to avoid async import race conditions * grammar police * lots more linting * relock
46 lines
1.3 KiB
Python
46 lines
1.3 KiB
Python
"""Statistics Functions."""
|
|
|
|
from numpy import (
|
|
mean as mean_np,
|
|
ndarray,
|
|
std,
|
|
var as var_np,
|
|
)
|
|
from pandas import DataFrame, Series
|
|
from scipy import stats
|
|
|
|
# Because python is weird and these being the same name as the fastapi router functions
|
|
# which overwrites the function signature, we add the _ after the function name
|
|
|
|
|
|
def kurtosis_(data: DataFrame | Series | ndarray) -> float:
|
|
"""Get Kurtosis.
|
|
|
|
It is a measure of the "tailedness" of the probability distribution of a real-valued random variable.
|
|
"""
|
|
return stats.kurtosis(data)
|
|
|
|
|
|
def skew_(data: DataFrame | Series | ndarray) -> float:
|
|
"""Get Skewness.
|
|
|
|
It is a measure of the asymmetry of the probability distribution of a
|
|
real-valued random variable about its mean.
|
|
"""
|
|
return stats.skew(data)
|
|
|
|
|
|
def mean_(data: DataFrame | Series | ndarray) -> float:
|
|
"""Get Mean which is the average of the numbers."""
|
|
return mean_np(data)
|
|
|
|
|
|
def std_dev_(data: DataFrame | Series | ndarray) -> float:
|
|
"""Get Standard deviation that is a measure of the amount of variation or dispersion of a set of values."""
|
|
return std(data)
|
|
|
|
|
|
def var_(data: DataFrame | Series | ndarray) -> float:
|
|
"""Get Variance that is a measure of the amount of variation or dispersion of a set of values."""
|
|
return var_np(data)
|