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

249 clarification of the symmetry argument in cqr and more general documentation about cqr #443

Conversation

LacombeLouis
Copy link
Collaborator

@LacombeLouis LacombeLouis commented May 14, 2024

Description

This change adds an example to the documentation that demonstrates the impact of the symmetry parameter in the MapieQuantileRegressor class. The example generates plots for prediction intervals with both symmetry=True and symmetry=False, allowing users to visualize and understand the differences.

Fixes #249.

Type of change

  • New feature (non-breaking change which adds functionality)

How Has This Been Tested?

  • Ran the script and visually inspected the generated plots to ensure they display correctly.
  • Verified that the explanation accurately reflects the results shown in the plots.

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

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.

Super PR that clarifies the theoretical aspects of CQR. Bravo! I have made suggestions to add clarification.

Maybe rework to the notebook to improve it (add a legend, use a more meaningful example, show visually where quantile models and quantile corrections come into play in interval estimation).

doc/theoretical_description_regression.rst Outdated Show resolved Hide resolved
doc/theoretical_description_regression.rst Outdated Show resolved Hide resolved
doc/theoretical_description_regression.rst Outdated Show resolved Hide resolved
doc/theoretical_description_regression.rst Outdated Show resolved Hide resolved
LacombeLouis and others added 5 commits May 16, 2024 17:29
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.

Thanks for adding your comments to the notebooks.

To make sure we're talking about the same thing, I've made some suggestions to highlight the difference between quantile regressors with the symmetric/asymmetric option.

The code could not be put into words because CQRs are not random_state parameters. To check and see how we can have the same regressor for both.

Another possibility is to have a single MapieQuantileRegressor and change the attribute by hand during prediction (without re-fit the model). I think this is a preferable solution.

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.

Here's my second proposal that I presented earlier to compare the symmetrical and asymmetrical options.

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.

Ready to merge. Thank you for your final modifications.

@LacombeLouis LacombeLouis merged commit be78d7a into master May 27, 2024
8 checks passed
@LacombeLouis LacombeLouis deleted the 249-clarification-of-the-symmetry-argument-in-cqr-and-more-general-documentation-about-cqr branch June 4, 2024 10:27
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.

Clarification of the "symmetry" argument in CQR and more general documentation about CQR
2 participants