dsl

Type Members

1. case class Attribute(name: String, value: Value) extends Product with Serializable

   

   Attribute class stores a named value.

   Attribute class stores a named value.

   name

   name of the value

   value

   stored value of the attribute

2. case class AttributeList(lookup: Map[String, Attribute]) extends Product with Serializable

   

   Class that holds a list of Attribute objects.

   Class that holds a list of Attribute objects.

   Can only have one attribute with a given name at a time.

   lookup

   map of attribute name to Attribute object

3. case class Bundle(name: String, format: SerializationFormat, version: String, attributes: Option[AttributeList], nodes: Seq[Any]) extends HasAttributeList[Bundle] with Product with Serializable

   

   Root object for serializing Bundle.ML pipelines and graphs.

   Root object for serializing Bundle.ML pipelines and graphs.

   name

   name of the bundle

   format

   serialization format of the Bundle

   version

   Bundle.ML version used for serializing

   attributes

   optional AttributeList to serialize with the bundle

   nodes

   list of root nodes in the bundle

4. case class BundleMeta(name: String, format: SerializationFormat, version: String, attributes: Option[AttributeList], nodes: Seq[String]) extends Product with Serializable

   

   Meta data for a bundle.

   Meta data for a bundle.

   name

   name of the bundle

   format

   serialization format of the Bundle

   version

   Bundle.ML version used for serializing

   attributes

   optional AttributeList to serialize with the bundle

   nodes

   list of root nodes in the bundle

5. trait HasAttributeList[T] extends AnyRef

   

   This trait provides easy access to reading/writing attributes to objects that contain an AttributeList.

   This trait provides easy access to reading/writing attributes to objects that contain an AttributeList.

   T

   class type that contains the attribute list

6. case class Model(op: String, attributes: Option[AttributeList] = None) extends HasAttributeList[Model] with Product with Serializable

   

   Class that encodes all information need to serialize or deserialize a machine learning model.

   Class that encodes all information need to serialize or deserialize a machine learning model.

   Models encode things like coefficients for linear regressions, labels for string indexers, sizes for one hot encoders, decision trees, and any other data needed to serialize and deserialize ML models and feature builders.

   op

   op name for the model

   attributes

   optional list of attributes for the model

7. case class Node(name: String, shape: Shape) extends Product with Serializable

   

   Class for storing a node in the Bundle.ML graph.

   Class for storing a node in the Bundle.ML graph.

   Bundle.ML is composed of a set of Node objects, each with their own inputs and outputs defined by their Node#shape.

   Every Node needs a unique identifier within a Bundle.ML graph. This is the Node#name.

   name

   unique identifier for the node

   shape

   shape of the node

8. case class Shape extends Product with Serializable

   

   Class for holding the input fields and output fields of a Node.

   Class for holding the input fields and output fields of a Node. The shape also holds information for connecting the input/output fields to the underlying ML model.

   A Shape contains input and output sockets. Sockets map field data to certain functionality within a Model. For instance, say we want to run a "label" field through a string indexer and have the result output to the field "label_name". We could wire up the node like so:

   scala> import ml.bundle.dsl._
   scala> Shape().withInput("label", "input"). // connect the "label" field to the model input
            withOutput("label_name", "output") // connect the model output to the "label_name" field

   Or more concisely:

   scala> import ml.bundle.dsl._
   scala> Shape().withStandardIO("label", "label_name") // shorthand for the above code

9. case class Value(bundleDataType: DataType, value: Any) extends Product with Serializable

   

   This class is used to wrap Scala objects for later serialization into Bundle.ML

   This class is used to wrap Scala objects for later serialization into Bundle.ML

   bundleDataType

   data type of the value being stored

   value

   Scala object that will be serialized later