Github user mateiz commented on a diff in the pull request:
https://github.com/apache/spark/pull/3099#discussion_r20117759
--- Diff: mllib/src/main/scala/org/apache/spark/ml/package-info.java ---
@@ -0,0 +1,24 @@
+/*
+ * 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.
+ */
+
+/**
+ * Spark ML is an ALPHA component that adapts the new set of machine
learning APIs.
+ */
+@AlphaComponent
+package org.apache.spark.ml;
--- End diff --
Actually FYI this annotation does not show up in ScalaDoc if it's here. I
think it's better to put it on the main classes in the package, namely
Pipeline, Estimator, Transformer, etc. Presumably Pipeline will be the first
one people read. In Spark SQL, we have it on SQLContext and SchemaRDD.
Also, to have a package-level comment in Scala, you need to create a
`package.scala` with `package object ml` in it. Take a look at Spark SQL's
`package.scala`. I believe you can also add the annotation there but I'm not
sure.
---
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]
