Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CRPS for the logistic distribution #41

Closed
wants to merge 2 commits into from
Closed

Add CRPS for the logistic distribution #41

wants to merge 2 commits into from

Conversation

sallen12
Copy link
Collaborator

No description provided.

@sallen12 sallen12 requested a review from frazane August 30, 2024 08:49
@sallen12 sallen12 closed this Aug 30, 2024
@sallen12 sallen12 reopened this Aug 30, 2024
where $\Phi(ω)$ and $\phi(ω)$ are respectively the CDF and PDF of the standard normal
distribution at the normalized prediction error $\omega = \frac{y - \mu}{\sigma}$.
where $F(\omega)$ is the CDF of the standard logistic distribution at the
normalized prediction error $\omega = \frac{y - \mu}{\sigma}$.

Parameters
----------
observations: ArrayLike
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The type hint suggestion can be removed in the docstrings. When mkdocstrings parses the code it will automatically infer the type from the function signature.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(we will make sure to remove them from all other functions later)


Returns
-------
crps: array_like
The CRPS between Normal(mu, sigma) and obs.
The CRPS for the Logistic(mu, sigma) forecasts given the observations.

Examples
--------
>>> from scoringrules import crps
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All examples should use the main API:

import scoringrules as sr
sr.crps_logistic(...)

@frazane frazane changed the title add crps for logistic distribution Add CRPS for the logistic distribution Aug 30, 2024
@sallen12
Copy link
Collaborator Author

sallen12 commented Sep 5, 2024

PR merged into PR for generalised truncated and censored logistic distribution

@sallen12 sallen12 closed this Sep 5, 2024
@sallen12 sallen12 deleted the crps-logis branch September 5, 2024 13:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants