nci / scores

scores: Metrics for the verification, evaluation and optimisation of forecasts, predictions or models.
https://scores.readthedocs.io/
Apache License 2.0
67 stars 18 forks source link

Minor updates to the "Additive Bias, Multiplicative Bias and Percent Bias" tutorial #656

Closed Steph-Chong closed 2 months ago

Steph-Chong commented 2 months ago

@tennlee @nicholasloveday @durgals

This PR makes some minor updates to the bias tutorial

Some additional questions I had:

  1. Should the first level header at the start of the tutorial now be updated, perhaps to something along the lines of "Additive Bias, Multiplicative Bias and Percent Bias" or "Additive, Multiplicative and Percent Bias"?

  2. Should the title as displayed in the tutorial gallery and the readthedocs left hand side bar be similarly changed?

  3. Should a references section be added at the end of this tutorial? (I realise some of the tutorials have a references section and others do not.)

durgals commented 2 months ago

@tennlee @nicholasloveday @durgals

  • Changed three instances of "additive bias precentage" to "percent bias" in code comments (@durgals - did I make these changes correctly?)

@Steph-Chong : Yes.

Steph-Chong commented 2 months ago

Some additional questions I had:

1. Should the first level header at the start of the tutorial now be updated, perhaps to something along the lines of "Additive Bias, Multiplicative Bias and Percent Bias" or "Additive, Multiplicative and Percent Bias"?

Following offline discussion with @tennlee, I updated the first level header (title) in the title to "Additive Bias, Multiplicative Bias and Percent Bias".

Steph-Chong commented 2 months ago

Some additional questions I had:

2. Should the title as displayed in the tutorial gallery and the readthedocs left hand side bar be similarly changed?

3. Should a references section be added at the end of this tutorial? (I realise some of the tutorials have a references section and others do not.)
  1. Tennessee updated the title in the tutorial gallery (and consequently, in the left hand side bar on readthedocs), and pushed it to this PR

  2. Following offline discussion with Tennessee, I added a references section (I used the references from the Percent Bias docstring and the references currently in included.md for Additive Bias and Multiplicative Bias).