Advertise model inversion in the README - #479
Merged
Merged
Conversation
The capability shipped in 1.61 and the user-guide page in 1.62.1, but a reader landing on the repository had no way to see either. Adds it to the highlights, the capability list, and the scikit-learn comparison, with a quick-start example whose printed values are the ones the cheddar-cheese data actually produce.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Each one carried a sentence of elaboration the reader does not need at this point in the page. The links and the code names do the work.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
PLS.invert()andOPLSshipped in 1.61, and the user-guide page in 1.62.1, but someone landing on the repository page had no way to find out either existed. This puts the capability where readers look.What changed
OPLSroute to the same subspace, citing García-Carrión et al. (2025) and linking both the user-guide page and the book chapter.invert(), the null-space dimension, walking the null space, and theOPLSequivalent. Every printed value in that block was run against the packaged cheddar-cheese data and pasted from the actual output.Version
PATCH bump to 1.62.2,
CITATION.cffkept in sync (version anddate-released), and a### Changedentry under a new1.62.2heading with the link-reference footer updated. Tell me if you would rather this sat underUnreleasedwithout a bump; the repository convention reads as bump-on-every-PR, so I followed that.No source, test, or configuration changes.
Generated by Claude Code