Skip to content

Commit

Permalink
Fixed errors in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
aloukina committed Mar 19, 2020
1 parent 3d0c691 commit 34ae641
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions rsmtool/analyzer.py
Original file line number Diff line number Diff line change
Expand Up @@ -601,8 +601,8 @@ def metrics_helper(human_scores,
smd_method='unpooled',
use_diff_std_means=False):
"""
This is a helper function that computes some basic agreement
and association metrics between the system scores and the
This is a helper function that computes several basic
association metrics between the system scores and the
human scores.
Parameters
Expand All @@ -620,16 +620,16 @@ def metrics_helper(human_scores,
population_system_score_sd : float, optional
Reference standard deviation for system scores. If `smd_method='williamson'`, this is
used to compute SMD and should be the standard deviation for the whole population.If
`use_diff_std_means=True`, this must be used with `population_human_score_mn`.
`use_diff_std_means=True`, this must be used with `population_system_score_mn`.
Otherwise, it is ignored.
Defaults to None.
population_human_score_mn : float, optional
Reference mean for human scores. If `use_diff_std_means=True`, this must be used with
`population_human_score_mn`. Otherwise, it is ignored.
`population_human_score_sd`. Otherwise, it is ignored.
Defaults to None.
population_system_score_mn : float, optional
Reference mean for system scores. If `use_diff_std_means=True`, this must be used with
`population_human_score_mn`. Otherwise, it is ignored.
`population_system_score_sd`. Otherwise, it is ignored.
Defaults to None.
smd_method : {'williamson', 'johnson', pooled', 'unpooled'}, optional
The SMD method to use, only used if `use_diff_std_means=False`.
Expand Down

0 comments on commit 34ae641

Please sign in to comment.