Skip to content

Clarify README "How lorepy works" section#16

Merged
sepro merged 1 commit intodevfrom
codex/inspect-code-and-review-readme.md-section
Feb 25, 2026
Merged

Clarify README "How lorepy works" section#16
sepro merged 1 commit intodevfrom
codex/inspect-code-and-review-readme.md-section

Conversation

@sepro
Copy link
Member

@sepro sepro commented Feb 25, 2026

Motivation

  • Make the README mathematically precise and correct the misleading statement about confounders so documentation matches the code (default classifier behavior, prediction grid, and how confounders are handled).

Description

  • Update README.md "How lorepy works" to state lorepy fits scikit-learn's default LogisticRegression() (L2, C=1.0) unless a custom classifier is provided, that class probabilities are computed via the softmax formula and evaluated at 200 evenly spaced x points, that confounders are included during fitting and then fixed to user-specified reference values at prediction time (i.e., curves are conditional on those reference values), and to clarify how sample dots are generated.

Testing

  • Attempted to run python -m pytest -q, but the run aborted due to a missing dependency (ModuleNotFoundError: No module named 'numpy'), so automated tests could not be executed in this environment.

Codex Task

@sepro sepro merged commit bd1a98a into dev Feb 25, 2026
8 checks passed
@sepro sepro deleted the codex/inspect-code-and-review-readme.md-section branch February 25, 2026 09:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant