ml.combust.bundle

dsl

package dsl

Domain specific language for generating Bundle.ML models.

DSL provides objects for generating various Bundle.ML objects.

ml.combust.bundle.dsl.Bundle - Stores the name, version, serialization format, list of attributes, and list of root nodes in the bundle graph.

ml.combust.bundle.dsl.Node - A node for transforming data in the model graph. Nodes have a unique name within a Bundle.ML graph and are responsible for piping inputs to a model and outputs from a model to the rest of the graph via sockets. Sockets map a field name in the graph to a specific port in a model.

A model can have input ports and output ports. An example would be a StringIndexer node named "my_string_indexer" that indexes the input field "my_string_label" to the output field "my_double_label". There are two sockets for this node, one that maps the "my_string_label" field to the "input" port of the model and another socket that maps the "output" port of the model to the "my_double_label" field.

ml.combust.bundle.dsl.Model - A model operation that transforms data within the graph. Models have an op name that define the type of model. For instance, the op name could be "string_indexer", "linear_regression", or "random_forest_regression". In addition to the op name of the model, all of the required attributes, such as coefficients and intercepts ,for executing the model are stored here.

ml.combust.bundle.dsl.Attribute - Attributes are used to store values for ml.combust.bundle.dsl.Models and ml.combust.bundle.dsl.Bundles. They contain a name, a ml.bundle.DataType.DataType and a ml.combust.bundle.dsl.Value.

ml.combust.bundle.dsl.Value - Values store concrete data for an ml.combust.bundle.dsl.Attribute. You can store basic data like strings, doubles, longs and booleans, tensors of any dimension, custom data types, and lists of any depth and data type.

ml.combust.bundle.dsl.AttributeList - Stores a set of ml.combust.bundle.dsl.Attributes.

ml.combust.bundle.dsl.Shape - Stores the map of graph input/output fields to model inputs and outputs.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. dsl
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

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

    Attribute class stores a named value.

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

    Class that holds a list of Attribute objects.

  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.

  4. trait HasAttributeList[T] extends AnyRef

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

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

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

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

    Class for storing a node in the Bundle.

  7. trait ReadableAttributeList extends AnyRef

    Trait for read-only operations of an AttributeList.

  8. trait ReadableModel extends AnyRef

    Trait for read-only operations on a Model.

  9. trait ReadableNode extends AnyRef

    Trait for read-only interface to a Node.

  10. trait ReadableShape extends AnyRef

    Trait for read-only interface to Shape objects.

  11. case class Shape(_shape: bundle.Shape.Shape = ...) extends WritableShape with Product with Serializable

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

  12. case class Value(_bundleDataType: DataType, value: Any) extends Product with Serializable

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

  13. trait WritableAttributeList extends ReadableAttributeList

    Trait for write operations on an AttributeList.

  14. trait WritableModel extends ReadableModel

    Trait for a writable interface to a Model.

  15. trait WritableNode extends ReadableNode

    Trait for writable interface to a Node.

  16. trait WritableShape extends ReadableShape

    Trait for writable interface to a Shape.

Value Members

  1. object Attribute extends Serializable

    Companion object for Attribute class.

  2. object AttributeList extends Serializable

    Companion class for construction and conversion of AttributeList objects.

  3. object Bundle extends Serializable

    Companion class for constants and constructors of Bundle objects.

  4. object Shape extends Serializable

    Companion object for holding constant values.

  5. object Value extends Serializable

    Provides a set of helper methods for easily creating ml.combust.bundle.dsl.Value objects.

Inherited from AnyRef

Inherited from Any

Ungrouped