Return-Path: X-Original-To: apmail-mahout-commits-archive@www.apache.org Delivered-To: apmail-mahout-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 7ED5717D83 for ; Fri, 29 May 2015 19:00:00 +0000 (UTC) Received: (qmail 1049 invoked by uid 500); 29 May 2015 18:59:55 -0000 Delivered-To: apmail-mahout-commits-archive@mahout.apache.org Received: (qmail 937 invoked by uid 500); 29 May 2015 18:59:55 -0000 Mailing-List: contact commits-help@mahout.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@mahout.apache.org Delivered-To: mailing list commits@mahout.apache.org Received: (qmail 490 invoked by uid 99); 29 May 2015 18:59:54 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 29 May 2015 18:59:54 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id ABC07E10DF; Fri, 29 May 2015 18:59:54 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit From: dlyubimov@apache.org To: commits@mahout.apache.org Date: Fri, 29 May 2015 19:00:24 -0000 Message-Id: <158bdd151ebd4ae4a70ca934a5960ad7@git.apache.org> In-Reply-To: <6fc367ca5fed40c890703eb88e5d6c7b@git.apache.org> References: <6fc367ca5fed40c890703eb88e5d6c7b@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [33/51] [partial] mahout git commit: Adding math-scala scaladoc from release. http://git-wip-us.apache.org/repos/asf/mahout/blob/908aa498/docs/math-scala/org/apache/mahout/drivers/MahoutOptionParser.html ---------------------------------------------------------------------- diff --git a/docs/math-scala/org/apache/mahout/drivers/MahoutOptionParser.html b/docs/math-scala/org/apache/mahout/drivers/MahoutOptionParser.html new file mode 100644 index 0000000..f23c8ee --- /dev/null +++ b/docs/math-scala/org/apache/mahout/drivers/MahoutOptionParser.html @@ -0,0 +1,893 @@ + + + + + MahoutOptionParser - Mahout Math Scala bindings 0.10.0 API - org.apache.mahout.drivers.MahoutOptionParser + + + + + + + + + + + + +

+ + + class + + + MahoutOptionParser extends OptionParser[Map[String, Any]] + +

+ +

Defines oft-repeated options and their parsing. Provides the option groups and parsing helper methods to +keep both standarized.

Note

options are engine neutral by convention. See the engine specific extending class for + to add Spark or other engine options. +

+ Linear Supertypes +
OptionParser[Map[String, Any]], Serializable, Serializable, Product, Equals, AnyRef, Any
+
+ + +
+
+
+ Ordering +
    + +
  1. Alphabetic
    2. +
  2. By inheritance
    3. +
+
+
+ Inherited
+ +
    +
  1. MahoutOptionParser
  2. OptionParser
  3. Serializable
  4. Serializable
  5. Product
  6. Equals
  7. AnyRef
  8. Any
    9. +
+
+ +
    +
  1. Hide All
    2. +
  2. Show all
    3. +
+ Learn more about member selection +
+
+ Visibility +
  1. Public
  2. All
+
+
+ +
+
+
+

Instance Constructors

+
  1. + + +

    + + + new + + + MahoutOptionParser(programName: String) + +

    +

    programName

    Name displayed in help message, the name by which the driver is invoked.

    +
+
+ + + + + +
+

Value Members

+
  1. + + +

    + + final + def + + + !=(arg0: AnyRef): Boolean + +

    +
    Definition Classes
    AnyRef
    +
  2. + + +

    + + final + def + + + !=(arg0: Any): Boolean + +

    +
    Definition Classes
    Any
    +
  3. + + +

    + + final + def + + + ##(): Int + +

    +
    Definition Classes
    AnyRef → Any
    +
  4. + + +

    + + final + def + + + ==(arg0: AnyRef): Boolean + +

    +
    Definition Classes
    AnyRef
    +
  5. + + +

    + + final + def + + + ==(arg0: Any): Boolean + +

    +
    Definition Classes
    Any
    +
  6. + + +

    + + + def + + + arg[A](name: String)(implicit arg0: Read[A]): OptionDef[A, Map[String, Any]] + +

    +
    Definition Classes
    OptionParser
    +
  7. + + +

    + + + def + + + arguments: Seq[OptionDef[_, Map[String, Any]]] + +

    +
    Attributes
    protected
    Definition Classes
    OptionParser
    +
  8. + + +

    + + final + def + + + asInstanceOf[T0]: T0 + +

    +
    Definition Classes
    Any
    +
  9. + + +

    + + + def + + + checkConfig(f: (Map[String, Any]) ⇒ Either[String, Unit]): OptionDef[Unit, Map[String, Any]] + +

    +
    Definition Classes
    OptionParser
    +
  10. + + +

    + + + def + + + checks: Seq[OptionDef[_, Map[String, Any]]] + +

    +
    Attributes
    protected
    Definition Classes
    OptionParser
    +
  11. + + +

    + + + def + + + clone(): AnyRef + +

    +
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    + @throws( + + ... + ) + +
    +
  12. + + +

    + + + def + + + cmd(name: String): OptionDef[Unit, Map[String, Any]] + +

    +
    Definition Classes
    OptionParser
    +
  13. + + +

    + + + def + + + commands: Seq[OptionDef[_, Map[String, Any]]] + +

    +
    Attributes
    protected
    Definition Classes
    OptionParser
    +
  14. + + +

    + + final + def + + + eq(arg0: AnyRef): Boolean + +

    +
    Definition Classes
    AnyRef
    +
  15. + + +

    + + + def + + + errorOnUnknownArgument: Boolean + +

    +
    Definition Classes
    OptionParser
    +
  16. + + +

    + + + def + + + failure(msg: String): Either[String, Unit] + +

    +
    Definition Classes
    OptionParser
    +
  17. + + +

    + + + def + + + finalize(): Unit + +

    +
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    + @throws( + + classOf[java.lang.Throwable] + ) + +
    +
  18. + + +

    + + final + def + + + getClass(): Class[_] + +

    +
    Definition Classes
    AnyRef → Any
    +
  19. + + +

    + + + def + + + head(xs: String*): OptionDef[Unit, Map[String, Any]] + +

    +
    Definition Classes
    OptionParser
    +
  20. + + +

    + + + def + + + header: String + +

    +
    Definition Classes
    OptionParser
    +
  21. + + +

    + + + def + + + heads: Seq[OptionDef[_, Map[String, Any]]] + +

    +
    Attributes
    protected
    Definition Classes
    OptionParser
    +
  22. + + +

    + + + def + + + help(name: String): OptionDef[Unit, Map[String, Any]] + +

    +
    Definition Classes
    OptionParser
    +
  23. + + +

    + + + val + + + helpOptions: ListBuffer[OptionDef[_, Map[String, Any]]] + +

    +
    Attributes
    protected
    Definition Classes
    OptionParser
    +
  24. + + +

    + + final + def + + + isInstanceOf[T0]: Boolean + +

    +
    Definition Classes
    Any
    +
  25. + + +

    + + + def + + + makeDef[A](kind: OptionDefKind, name: String)(implicit arg0: Read[A]): OptionDef[A, Map[String, Any]] + +

    +
    Attributes
    protected
    Definition Classes
    OptionParser
    +
  26. + + +

    + + final + def + + + ne(arg0: AnyRef): Boolean + +

    +
    Definition Classes
    AnyRef
    +
  27. + + +

    + + + def + + + nonArgs: Seq[OptionDef[_, Map[String, Any]]] + +

    +
    Attributes
    protected
    Definition Classes
    OptionParser
    +
  28. + + +

    + + + def + + + note(x: String): OptionDef[Unit, Map[String, Any]] + +

    +
    Definition Classes
    OptionParser
    +
  29. + + +

    + + final + def + + + notify(): Unit + +

    +
    Definition Classes
    AnyRef
    +
  30. + + +

    + + final + def + + + notifyAll(): Unit + +

    +
    Definition Classes
    AnyRef
    +
  31. + + +

    + + + def + + + opt[A](x: Char, name: String)(implicit arg0: Read[A]): OptionDef[A, Map[String, Any]] + +

    +
    Definition Classes
    OptionParser
    +
  32. + + +

    + + + def + + + opt[A](name: String)(implicit arg0: Read[A]): OptionDef[A, Map[String, Any]] + +

    +
    Definition Classes
    OptionParser
    +
  33. + + +

    + + + val + + + options: ListBuffer[OptionDef[_, Map[String, Any]]] + +

    +
    Attributes
    protected
    Definition Classes
    OptionParser
    +
  34. + + +

    + + + var + + + opts: Map[String, Any] + +

    + +
  35. + + +

    + + + def + + + parse(args: Seq[String], init: Map[String, Any]): Option[Map[String, Any]] + +

    +
    Definition Classes
    OptionParser
    +
  36. + + +

    + + + def + + + parse(args: Seq[String])(implicit ev: Zero[Map[String, Any]]): Boolean + +

    +
    Definition Classes
    OptionParser
    +
  37. + + +

    + + + def + + + parseElementInputSchemaOptions(): OptionDef[Unit, Map[String, Any]] + +

    + +
  38. + + +

    + + + def + + + parseFileDiscoveryOptions(): OptionDef[String, Map[String, Any]] + +

    + +
  39. + + +

    + + + def + + + parseGenericOptions(): OptionDef[Unit, Map[String, Any]] + +

    + +
  40. + + +

    + + + def + + + parseIOOptions(numInputs: Int = 1): OptionDef[String, Map[String, Any]] + +

    + +
  41. + + +

    + + + def + + + parseIndexedDatasetFormatOptions(): OptionDef[Unit, Map[String, Any]] + +

    + +
  42. + + +

    + + + def + + + reportError(msg: String): Unit + +

    +
    Definition Classes
    OptionParser
    +
  43. + + +

    + + + def + + + reportWarning(msg: String): Unit + +

    +
    Definition Classes
    OptionParser
    +
  44. + + +

    + + + def + + + showHeader: Unit + +

    +
    Definition Classes
    OptionParser
    +
  45. + + +

    + + + def + + + showTryHelp: Unit + +

    +
    Definition Classes
    OptionParser
    +
  46. + + +

    + + + def + + + showUsage: Unit + +

    +
    Definition Classes
    OptionParser
    +
  47. + + +

    + + + def + + + showUsageAsError: Unit + +

    +
    Definition Classes
    OptionParser
    +
  48. + + +

    + + + def + + + showUsageOnError: Boolean + +

    +
    Definition Classes
    MahoutOptionParser → OptionParser
    +
  49. + + +

    + + + def + + + success: Either[String, Unit] + +

    +
    Definition Classes
    OptionParser
    +
  50. + + +

    + + final + def + + + synchronized[T0](arg0: ⇒ T0): T0 + +

    +
    Definition Classes
    AnyRef
    +
  51. + + +

    + + + def + + + usage: String + +

    +
    Definition Classes
    OptionParser
    +
  52. + + +

    + + + def + + + version(name: String): OptionDef[Unit, Map[String, Any]] + +

    +
    Definition Classes
    OptionParser
    +
  53. + + +

    + + final + def + + + wait(): Unit + +

    +
    Definition Classes
    AnyRef
    Annotations
    + @throws( + + ... + ) + +
    +
  54. + + +

    + + final + def + + + wait(arg0: Long, arg1: Int): Unit + +

    +
    Definition Classes
    AnyRef
    Annotations
    + @throws( + + ... + ) + +
    +
  55. + + +

    + + final + def + + + wait(arg0: Long): Unit + +

    +
    Definition Classes
    AnyRef
    Annotations
    + @throws( + + ... + ) + +
    +
+
+ + + + +
+ +
+
+

Inherited from OptionParser[Map[String, Any]]

+
+

Inherited from Serializable

+
+

Inherited from Serializable

+
+

Inherited from Product

+
+

Inherited from Equals

+
+

Inherited from AnyRef

+
+

Inherited from Any

+
+ +
+ +
+
+

Ungrouped

+ +
+
+ +
+ +
+ + + + + \ No newline at end of file http://git-wip-us.apache.org/repos/asf/mahout/blob/908aa498/docs/math-scala/org/apache/mahout/drivers/package.html ---------------------------------------------------------------------- diff --git a/docs/math-scala/org/apache/mahout/drivers/package.html b/docs/math-scala/org/apache/mahout/drivers/package.html new file mode 100644 index 0000000..18a5b96 --- /dev/null +++ b/docs/math-scala/org/apache/mahout/drivers/package.html @@ -0,0 +1,134 @@ + + + + + drivers - Mahout Math Scala bindings 0.10.0 API - org.apache.mahout.drivers + + + + + + + + + + +
+ +

org.apache.mahout

+

drivers

+
+ +

+ + + package + + + drivers + +

+ +
+ + +
+
+ + +
+ Visibility +
  1. Public
  2. All
+
+
+ +
+
+ + +
+

Type Members

+
  1. + + +

    + + abstract + class + + + MahoutDriver extends AnyRef + +

    +

    Extended by a platform specific version of this class to create a Mahout CLI driver.

    +
  2. + + +

    + + + class + + + MahoutOptionParser extends OptionParser[Map[String, Any]] + +

    +

    Defines oft-repeated options and their parsing.

    +
+
+ + + +
+

Value Members

+
  1. + + +

    + + + object + + + MahoutOptionParser extends Serializable + +

    +

    Companion object defines default option groups for reference in any driver that needs them.

    +
+
+ + + + +
+ +
+ + +
+ +
+
+

Ungrouped

+ +
+
+ +
+ +
+ + + + + \ No newline at end of file