Skip to content

[MRG] Add documentation for SVC properties#12427

Merged
amueller merged 1 commit intoscikit-learn:masterfrom
jhereth:fit_status_doc_4687
Oct 22, 2018
Merged

[MRG] Add documentation for SVC properties#12427
amueller merged 1 commit intoscikit-learn:masterfrom
jhereth:fit_status_doc_4687

Conversation

@jhereth
Copy link
Copy Markdown

@jhereth jhereth commented Oct 19, 2018

Reference Issues/PRs

Fixes #4687

What does this implement/fix? Explain your changes.

The implementation of svm.SVC leaks some variables. In #4794 it was decided that it is not worth the effort to make these private. Instead they should be documented.

This PR provides the documentation

Any other comments?

Most work on this PR has been done by @andylamb in #5224. I only implemented the last review comment by @amueller after the PR was dormant for three years.

@jhereth
Copy link
Copy Markdown
Author

jhereth commented Oct 19, 2018

Rendering of the new attributes:

image

@jhereth jhereth changed the title [WIP] Add documentation for SVC properties [MRG] Add documentation for SVC properties Oct 19, 2018
@jhereth jhereth mentioned this pull request Oct 20, 2018
produce probability estimates from decision values. If
probability=False, an empty array. Platt scaling uses the logistic
function
``1 / (1 + exp(decision_value * probA_ + probB_))``
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

It would not be good to add blanks to separate the formula?

@eamanu
Copy link
Copy Markdown
Contributor

eamanu commented Oct 22, 2018

IMO this PR add a little more docs than #5224, isn't? Maybe the issue #5224 could be closed.

@jhereth
Copy link
Copy Markdown
Author

jhereth commented Oct 22, 2018

@eamanu Yes, I found Issue 4687. This is just to finish the original PR #5224 from @andylamb (incorporating the last review by @amueller).

@amueller
Copy link
Copy Markdown
Member

looks good to me.

@amueller amueller merged commit 2ab1961 into scikit-learn:master Oct 22, 2018
thoo pushed a commit to thoo/scikit-learn that referenced this pull request Nov 14, 2018
jnothman pushed a commit to jnothman/scikit-learn that referenced this pull request Nov 14, 2018
jnothman pushed a commit to jnothman/scikit-learn that referenced this pull request Nov 14, 2018
xhluca pushed a commit to xhluca/scikit-learn that referenced this pull request Apr 28, 2019
xhluca pushed a commit to xhluca/scikit-learn that referenced this pull request Apr 28, 2019
xhluca pushed a commit to xhluca/scikit-learn that referenced this pull request Apr 28, 2019
koenvandevelde pushed a commit to koenvandevelde/scikit-learn that referenced this pull request Jul 12, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Q: doc svc.fit_status_

4 participants