docs: correct docstring drift in schemas, db models, transforms, and cross-validation - #103
Open
kgdunn wants to merge 5 commits into
Open
docs: correct docstring drift in schemas, db models, transforms, and cross-validation#103kgdunn wants to merge 5 commits into
kgdunn wants to merge 5 commits into
Conversation
Clarify that FitModelRequest.auto_components=True IGNORES n_components; the count is picked by cross-validation up to the hard-coded _AUTO_MAX_COMPONENTS = 20 ceiling in api/models.py. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0132CNPVroNNG679mikPzqwc
List the arrays actually saved by _pack_params (x_loadings, explained_variance, r2_cumulative) in the Model.params blob description. Remove the inaccurate 'P, W, means, scales' mention. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0132CNPVroNNG679mikPzqwc
Correct the 'power' note in apply_transform: the default is c1 = 0.0, and when zero, an effective exponent of 0.5 (signed root) is used. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0132CNPVroNNG679mikPzqwc
Rename selection_is_stable -> stable and selection_distribution -> vote_share in _pls_curves Notes to match the _Curves fields actually returned. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0132CNPVroNNG679mikPzqwc
Docs-only PATCH bump for docstring corrections in schemas, db models, transforms, and cross-validation. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0132CNPVroNNG679mikPzqwc
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.
Docstrings only -- no runtime behavior changes.
Fixes
src/scorepilot/schemas.py(FitModelRequest): clarify that whenauto_components=True,n_componentsis ignored; cross-validation picks the count via the selectedselection_ruleup to the hard-coded_AUTO_MAX_COMPONENTS = 20ceiling inapi/models.py.src/scorepilot/db/models.py(Model): fix theparamsblob description to list the arrays actually saved by_pack_params--x_loadings,explained_variance,r2_cumulative. Remove the inaccurate "P, W, means, scales" mention.src/scorepilot/core/transforms.py(apply_transformNotes): correct thepowernote -- default isc1 = 0.0, and when zero, an effective exponent of0.5(signed root) is used.src/scorepilot/core/cross_validation.py(_pls_curvesdocstring): renameselection_is_stable->stableandselection_distribution->vote_shareto match the_Curvesfields the function actually returns.Verification
uv run ruff check .anduv run ruff format --check .both pass.0.22.1(PATCH, docs-only).uv.lockintentionally not committed (per repo policy for Claude Code sessions).🤖 Generated with Claude Code
Generated by Claude Code