first docstrings for linear model #691
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
FBruzzesi
reviewed
Jul 14, 2024
There was a problem hiding this comment.
Thanks for your PR!
I have a minor concern for DemographicParity and EqualOpportunity: the code snippet "overflows" the screen, even on a large one - (see screenshot). I left comments for how we could format the code for DemographicParityClassifier , and the same should apply to EqualOpportunityClassifier.
We may consider linting and formatting docstring code snippet programmatically as well in the future I guess.
Comment on lines
+180
to
+189
| # The weights sum up to 1 | ||
| assert np.isclose(pwr.coef_.sum(), 1) | ||
|
|
||
| X_test = np.array([[5, 6], [6, 7]]) | ||
|
|
||
| # The prediction is positive (all weights are positive, and features are positive) | ||
| assert all(pwr.predict(X_test) > 0) | ||
|
|
||
| # The weights are positive | ||
| assert all(pwr.coef_ > -1e-8) |
There was a problem hiding this comment.
I really like these "behavior"-like assertions :)
Co-authored-by: Francesco Bruzzesi <42817048+FBruzzesi@users.noreply.github.com>
Co-authored-by: Francesco Bruzzesi <42817048+FBruzzesi@users.noreply.github.com>
FBruzzesi
approved these changes
Jul 14, 2024
33 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds docstrings for all the linear_model in #596. It's just basic fit-predict usage, let me know if you'd like something more detailed @FBruzzesi