Skip to content

Commit

Permalink
clarified docstrings for brier_scascore and discrimination
Browse files Browse the repository at this point in the history
  • Loading branch information
dougiesquire committed Aug 21, 2020
1 parent 671eb10 commit 26c0b3d
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions xskillscore/core/probabilistic.py
Original file line number Diff line number Diff line change
Expand Up @@ -212,9 +212,10 @@ def brier_score(observations, forecasts, dim=None, weights=None, keep_attrs=Fals
Parameters
----------
observations : xarray.Dataset or xarray.DataArray
The observations or set of observations.
The observations or set of observations of the event. Data should be boolean or logical \
(True or 1 for event occurance, False or 0 for non-occurance).
forecasts : xarray.Dataset or xarray.DataArray
The forecasts associated with the observations.
The forecast likelihoods of the event. Data should be between 0 and 1.
dim : str or list of str, optional
Dimension over which to compute mean after computing ``brier_score``.
Defaults to None implying averaging.
Expand Down Expand Up @@ -443,8 +444,8 @@ def discrimination(
Parameters
----------
observations : xarray.Dataset or xarray.DataArray
The observations or set of observations of the event. Data should be boolean (True for event
occurance, False for non-occurance).
The observations or set of observations of the event. Data should be boolean or logical \
(True or 1 for event occurance, False or 0 for non-occurance).
forecasts : xarray.Dataset or xarray.DataArray
The forecast likelihoods of the event. Data should be between 0 and 1.
dim : str or list of str, optional
Expand Down

0 comments on commit 26c0b3d

Please sign in to comment.