Skip to content

Commit

Permalink
[ENH] Johnson QP-distributions - add some missing capability tags (#253)
Browse files Browse the repository at this point in the history
Adds some missing capability tags to the Johnson QPD distributions.

Includes minor improvements to the docstring.
  • Loading branch information
fkiraly authored Apr 19, 2024
1 parent 369cee7 commit 9b83b91
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions skpro/distributions/qpd.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,9 @@ class QPD_S(BaseDistribution):
quantile function value of quantile ``1 - alpha``
lower : float
lower bound of semi-bounded range (default is 0)
version: str
version: str, optional, default="normal"
options are ``normal`` (default) or ``logistic``
dist_shape: str
dist_shape: float, optional, default=0.0
parameter modifying the logistic base distribution via
sinh/arcsinh-scaling (only active in sinhlogistic version)
Expand All @@ -68,8 +68,8 @@ class QPD_S(BaseDistribution):
"python_dependencies": "cyclic_boosting>=1.2.5",
# estimator tags
# --------------
"capabilities:approx": [],
"capabilities:exact": ["mean", "var", "cdf", "ppf"],
"capabilities:approx": ["pdfnorm", "energy"],
"capabilities:exact": ["mean", "var", "cdf", "ppf", "pdf", "log_pdf"],
"distr:measuretype": "continuous",
}

Expand Down Expand Up @@ -266,9 +266,9 @@ class QPD_B(BaseDistribution):
lower bound of semi-bounded range
upper : float
upper bound of supported range
version: str
version: str, optional, default="normal"
options are ``normal`` (default) or ``logistic``
dist_shape: str
dist_shape: float, optional, default=0.0
parameter modifying the logistic base distribution via
sinh/arcsinh-scaling (only active in sinhlogistic version)
Expand Down Expand Up @@ -296,8 +296,8 @@ class QPD_B(BaseDistribution):
"python_dependencies": "cyclic_boosting>=1.2.5",
# estimator tags
# --------------
"capabilities:approx": [],
"capabilities:exact": ["mean", "var", "cdf", "ppf"],
"capabilities:approx": ["pdfnorm", "energy"],
"capabilities:exact": ["mean", "var", "cdf", "ppf", "pdf", "log_pdf"],
"distr:measuretype": "continuous",
}

Expand Down Expand Up @@ -497,9 +497,9 @@ class QPD_U(BaseDistribution):
quantile function value of quantile 0.5
qv_high : float or array_like[float]
quantile function value of quantile ``1 - alpha``
version: str
version: str, optional, default="normal"
options are ``normal`` (default) or ``logistic``
dist_shape: str
dist_shape: float, optional, default=0.0
parameter modifying the logistic base distribution via
sinh/arcsinh-scaling (only active in sinhlogistic version)
Expand All @@ -525,8 +525,8 @@ class QPD_U(BaseDistribution):
"python_dependencies": "cyclic_boosting>=1.2.5",
# estimator tags
# --------------
"capabilities:approx": [],
"capabilities:exact": ["mean", "var", "cdf", "ppf"],
"capabilities:approx": ["pdfnorm", "energy"],
"capabilities:exact": ["mean", "var", "cdf", "ppf", "pdf", "log_pdf"],
"distr:measuretype": "continuous",
}

Expand Down

0 comments on commit 9b83b91

Please sign in to comment.