Github user zero323 commented on a diff in the pull request:
https://github.com/apache/spark/pull/17969#discussion_r116355659
--- Diff: R/pkg/R/mllib_wrapper.R ---
@@ -0,0 +1,61 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+#' S4 class that represents a Java ML model
+#'
+#' @param jobj a Java object reference to the backing Scala model
+#' @export
+#' @note JavaModel since 2.3.0
+setClass("JavaModel", representation(jobj = "jobj"))
+
+#' Makes predictions from a Java ML model
+#'
+#' @param object a Spark ML model.
+#' @param newData a SparkDataFrame for testing.
+#' @return \code{predict} returns a SparkDataFrame containing predicted
value.
+#' @rdname spark.predict
+#' @aliases predict,JavaModel-method
--- End diff --
I am biased here, but I'll argue that it doesn't. Both `predict` and
`write.ml` (same as `read.ml`) are extremely generic and in general we don't
provide any useful information about these. And the usage is already covered by
class `examples`. Finally we can use `@seealso` to provide a bit more R-is
experience if you think it is not enough Something around the lines of `lm`
docs:
Moreover using this approach significantly reduces amount of clutter in the
generated docs. There are shorter, argument list is focused on the important
parts, same as `value`. See for example GLM docs below. So IMHO this is
actually a significant improvement.
Personally I would do the same with all the `prints` and `summaries` as
well, although it wouldn't reduce the codebase (for now.... ð). This would
further shorten the docs and remove awkward descriptions like this:
And from the developer side it is a clear win. No mindless copy / paste /
replace cycle and more time to provide useful examples.
__Before__:
__After__:
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
