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

415 documentation for winkler interval score #444

Merged
merged 42 commits into from
May 27, 2024

Conversation

LacombeLouis
Copy link
Collaborator

@LacombeLouis LacombeLouis commented May 15, 2024

Description

Add description for all the metrics.

Fixes #415

Please remove options that are irrelevant.

  • This change requires a documentation update

Checklist

  • I have read the contributing guidelines
  • I have updated the HISTORY.rst and AUTHORS.rst files
  • Linting passes successfully : make lint
  • Typing passes successfully : make type-check
  • Unit tests pass successfully : make tests
  • Coverage is 100% : make coverage
  • Documentation builds successfully : make doc

@LacombeLouis LacombeLouis linked an issue May 15, 2024 that may be closed by this pull request
Copy link
Collaborator

@thibaultcordier thibaultcordier left a comment

Choose a reason for hiding this comment

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

Wow, this detailed page explaining MAPIE metrics is awesome. Thank you so much for listing everything here.

I've commented on the style and a question about the equations being too similar.

README.rst Outdated
Comment on lines 180 to 181
:height: 45px
:width: 45px
Copy link
Collaborator

Choose a reason for hiding this comment

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

Incorrect image scale (distorted).

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

done

doc/theoretical_description_metrics.rst Outdated Show resolved Hide resolved
doc/theoretical_description_metrics.rst Outdated Show resolved Hide resolved
doc/theoretical_description_metrics.rst Outdated Show resolved Hide resolved
doc/theoretical_description_metrics.rst Outdated Show resolved Hide resolved
doc/theoretical_description_metrics.rst Outdated Show resolved Hide resolved
doc/theoretical_description_metrics.rst Outdated Show resolved Hide resolved
doc/theoretical_description_metrics.rst Outdated Show resolved Hide resolved
doc/theoretical_description_metrics.rst Outdated Show resolved Hide resolved
doc/theoretical_description_metrics.rst Outdated Show resolved Hide resolved
LacombeLouis and others added 19 commits May 16, 2024 17:46
Co-authored-by: Thibault Cordier <124613154+thibaultcordier@users.noreply.github.com>
Co-authored-by: Thibault Cordier <124613154+thibaultcordier@users.noreply.github.com>
Co-authored-by: Thibault Cordier <124613154+thibaultcordier@users.noreply.github.com>
Co-authored-by: Thibault Cordier <124613154+thibaultcordier@users.noreply.github.com>
Co-authored-by: Thibault Cordier <124613154+thibaultcordier@users.noreply.github.com>
Co-authored-by: Thibault Cordier <124613154+thibaultcordier@users.noreply.github.com>
Co-authored-by: Thibault Cordier <124613154+thibaultcordier@users.noreply.github.com>
Co-authored-by: Thibault Cordier <124613154+thibaultcordier@users.noreply.github.com>
Co-authored-by: Thibault Cordier <124613154+thibaultcordier@users.noreply.github.com>
Co-authored-by: Thibault Cordier <124613154+thibaultcordier@users.noreply.github.com>
Co-authored-by: Thibault Cordier <124613154+thibaultcordier@users.noreply.github.com>
Co-authored-by: Thibault Cordier <124613154+thibaultcordier@users.noreply.github.com>
Co-authored-by: Thibault Cordier <124613154+thibaultcordier@users.noreply.github.com>
Co-authored-by: Thibault Cordier <124613154+thibaultcordier@users.noreply.github.com>
Co-authored-by: Thibault Cordier <124613154+thibaultcordier@users.noreply.github.com>
Copy link
Collaborator

@thibaultcordier thibaultcordier left a comment

Choose a reason for hiding this comment

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

Thank you for your changes. I just need to add a few harmonised changes. At the same time, I can't see your changes in the documentation (bug because there are a lot of builds / a lot of commits). I suggest you make a single commit for all the suggested changes with the "Add suggestion to batch" option in GitHub.

doc/theoretical_description_metrics.rst Outdated Show resolved Hide resolved
doc/theoretical_description_metrics.rst Outdated Show resolved Hide resolved
doc/theoretical_description_metrics.rst Outdated Show resolved Hide resolved
doc/theoretical_description_metrics.rst Outdated Show resolved Hide resolved
doc/theoretical_description_metrics.rst Outdated Show resolved Hide resolved
doc/theoretical_description_metrics.rst Outdated Show resolved Hide resolved
doc/theoretical_description_metrics.rst Outdated Show resolved Hide resolved
doc/theoretical_description_metrics.rst Outdated Show resolved Hide resolved
doc/theoretical_description_metrics.rst Outdated Show resolved Hide resolved
doc/theoretical_description_metrics.rst Outdated Show resolved Hide resolved
LacombeLouis and others added 2 commits May 21, 2024 10:46
Co-authored-by: Thibault Cordier <124613154+thibaultcordier@users.noreply.github.com>
Copy link
Collaborator

@thibaultcordier thibaultcordier left a comment

Choose a reason for hiding this comment

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

Add line breaks, and it will be perfect.

doc/theoretical_description_metrics.rst Outdated Show resolved Hide resolved
doc/theoretical_description_metrics.rst Outdated Show resolved Hide resolved
Copy link
Collaborator

@thibaultcordier thibaultcordier left a comment

Choose a reason for hiding this comment

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

Simply add a line break to the format and you're done.

doc/theoretical_description_metrics.rst Outdated Show resolved Hide resolved
@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (614293e) to head (9dcca60).
Report is 375 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##            master      #444    +/-   ##
==========================================
  Coverage   100.00%   100.00%            
==========================================
  Files           39        41     +2     
  Lines         4616      4803   +187     
  Branches       487       363   -124     
==========================================
+ Hits          4616      4803   +187     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@LacombeLouis LacombeLouis merged commit aeb7894 into master May 27, 2024
8 checks passed
@Valentin-Laurent Valentin-Laurent deleted the 415-documentation-for-winkler-interval-score branch November 12, 2024 13:37
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.

Documentation for Winkler Interval Score
3 participants