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.
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
[SPARK-31012][ML][PySpark][DOCS] Updating ML API docs for 3.0 changes #27762
Conversation
Test build #119186 has finished for PR 27762 at commit
|
@@ -28,7 +28,8 @@ import org.apache.spark.sql.functions._ | |||
import org.apache.spark.sql.types.DoubleType | |||
|
|||
/** | |||
* Evaluator for binary classification, which expects two input columns: rawPrediction and label. | |||
* Evaluator for binary classification, which expects input columns rawPrediction, label and |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: Evaluator for binary classification, which expects input columns: rawPrediction, label and
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Text is OK as is I think, but could quote the column names
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess I will leave this as is if that's OK by you two. The other two classes MulticlassClassificationEvaluator
and RegressionEvaluator
don't quote the column names either. If I change, I will have to change all of them.
@@ -110,7 +110,8 @@ def isLargerBetter(self): | |||
class BinaryClassificationEvaluator(JavaEvaluator, HasLabelCol, HasRawPredictionCol, HasWeightCol, | |||
JavaMLReadable, JavaMLWritable): | |||
""" | |||
Evaluator for binary classification, which expects two input columns: rawPrediction and label. | |||
Evaluator for binary classification, which expects input columns rawPrediction, label |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ditto
"(f1|accuracy|weightedPrecision|weightedRecall|weightedTruePositiveRate|" | ||
"weightedFalsePositiveRate|weightedFMeasure|truePositiveRateByLabel|" | ||
"falsePositiveRateByLabel|precisionByLabel|recallByLabel|fMeasureByLabel|" | ||
"(f1|accuracy|weightedPrecision|weightedRecall|weightedTruePositiveRate| " |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess we do not need to add spaces here
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@@ -28,7 +28,8 @@ import org.apache.spark.sql.functions._ | |||
import org.apache.spark.sql.types.DoubleType | |||
|
|||
/** | |||
* Evaluator for binary classification, which expects two input columns: rawPrediction and label. | |||
* Evaluator for binary classification, which expects input columns rawPrediction, label and |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Text is OK as is I think, but could quote the column names
### What changes were proposed in this pull request? Updating ML docs for 3.0 changes ### Why are the changes needed? I am auditing 3.0 ML changes, found some docs are missing or not updated. Need to update these. ### Does this PR introduce any user-facing change? Yes, doc changes ### How was this patch tested? Manually build and check Closes #27762 from huaxingao/spark-doc. Authored-by: Huaxin Gao <huaxing@us.ibm.com> Signed-off-by: Sean Owen <srowen@gmail.com> (cherry picked from commit 4a64901) Signed-off-by: Sean Owen <srowen@gmail.com>
Merged to master/3.0 |
Thank you very much! @srowen @zhengruifeng |
### What changes were proposed in this pull request? Updating ML docs for 3.0 changes ### Why are the changes needed? I am auditing 3.0 ML changes, found some docs are missing or not updated. Need to update these. ### Does this PR introduce any user-facing change? Yes, doc changes ### How was this patch tested? Manually build and check Closes apache#27762 from huaxingao/spark-doc. Authored-by: Huaxin Gao <huaxing@us.ibm.com> Signed-off-by: Sean Owen <srowen@gmail.com>
What changes were proposed in this pull request?
Updating ML docs for 3.0 changes
Why are the changes needed?
I am auditing 3.0 ML changes, found some docs are missing or not updated. Need to update these.
Does this PR introduce any user-facing change?
Yes, doc changes
How was this patch tested?
Manually build and check