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.

Sign up for GitHub

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

Jump to bottom

Improve docstring of LinearRegression #330

Merged
merged 1 commit into from
Jan 21, 2024
Merged

Improve docstring of LinearRegression #330

merged 1 commit into from
Jan 21, 2024

Conversation

rainij
Copy link
Contributor

@rainij rainij commented Jan 17, 2024

  • Fixed some "markdown errors".
  • Made docstring of LinearRegression more consistent with the docstrings of fit and predict (and variable names in code).
  • Removed comment on Moore-Penrose inverse because it does not really help to understand what the struct does. Instead it is explained more precisely what the goal of ordinary least squares for linear models is (briefly).
  • It is emphasized that the model is univariate (scalar targets).

@rainij rainij marked this pull request as ready for review January 17, 2024 10:05
quietlychris
quietlychris approved these changes Jan 21, 2024
View reviewed changes
Copy link
Member

@quietlychris quietlychris left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thank you!

@quietlychris quietlychris merged commit 86ad712 into rust-ml:master Jan 21, 2024
20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@quietlychris quietlychris quietlychris approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@rainij @quietlychris