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 documentation for adaptive metrics and CRF score #332

Merged
merged 26 commits into from
Sep 6, 2023

Conversation

candicemyt
Copy link
Collaborator

@candicemyt candicemyt commented Jul 31, 2023

Description

Add the missing theoretical documentation on the conformity scores.
Add examples of how to use and interpret the new metrics.
Add a tutorial on the CRF score.

Fixes #331

Type of change

  • New feature (non-breaking change which adds functionality)
  • 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

@candicemyt candicemyt linked an issue Jul 31, 2023 that may be closed by this pull request
@codecov-commenter
Copy link

codecov-commenter commented Jul 31, 2023

Codecov Report

Patch has no changes to coverable lines.

❗ Current head 5701d75 differs from pull request most recent head 37492b6. Consider uploading reports for the commit 37492b6 to get more accurate results

Files Changed Coverage
...ie/conformity_scores/residual_conformity_scores.py ø
mapie/metrics.py ø

📢 Thoughts on this report? Let us know!.

@thibaultcordier
Copy link
Collaborator

@candicemyt, the problem of compiling documentation is now solved. I suggest you merge your branch with the master branch as follows (in your local branch):

git merge master

Consult https://git-scm.com/docs/git-merge if you have any difficulties, or ask me.

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.

It looks fine to me. The previous comments have been taken into account.

@thibaultcordier thibaultcordier added the Documentation Type: documentation label Aug 30, 2023
Copy link
Collaborator

@LacombeLouis LacombeLouis left a comment

Choose a reason for hiding this comment

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

Great PR! It's much better to understand how CRF works. I would add a couple more comments to explain the results 😃

candicemyt and others added 2 commits September 5, 2023 17:49
Co-authored-by: Thibault Cordier <124613154+thibaultcordier@users.noreply.github.com>
Co-authored-by: Thibault Cordier <124613154+thibaultcordier@users.noreply.github.com>
@candicemyt candicemyt merged commit b17e067 into master Sep 6, 2023
10 checks passed
@thibaultcordier thibaultcordier deleted the 331-documentation-adaptive-intervals branch September 20, 2023 14:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Type: documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add documentation for adaptive metrics and CRF score
4 participants