Class/Object

ml.combust.bundle.dsl

Shape

Related Docs: object Shape | package dsl

Permalink

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. 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
_shape

protobuf shape object containing the shape information

Linear Supertypes
Serializable, Serializable, Product, Equals, WritableShape, ReadableShape, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Shape
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. WritableShape
  7. ReadableShape
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Shape(_shape: bundle.Shape.Shape = ...)

    Permalink

    _shape

    protobuf shape object containing the shape information

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def bundleShape: bundle.Shape.Shape

    Permalink

    Create a protobuf shape.

    Create a protobuf shape.

    returns

    protobuf shape

    Definition Classes
    Shape → ReadableShape

  6. def clone(): AnyRef

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

  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  8. def finalize(): Unit

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

  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  10. def getInput(port: String): Option[Socket]

    Permalink

    Get an optional input by the port name.

    Get an optional input by the port name.

    port

    name of the port

    returns

    optional socket for the named port

    Definition Classes
    Shape → ReadableShape

  11. def getOutput(port: String): Option[Socket]

    Permalink

    Get an optional input by the port name.

    Get an optional input by the port name.

    port

    name of the port

    returns

    optional socket for the named port

    Definition Classes
    Shape → ReadableShape

  12. def input(port: String): Socket

    Permalink

    Get an input by the port name.

    Get an input by the port name.

    port

    name of port

    returns

    socket for named port

    Definition Classes
    Shape → ReadableShape

  13. def inputs: Seq[Socket]

    Permalink

    Get list of all inputs.

    Get list of all inputs.

    returns

    list of inputs

    Definition Classes
    Shape → ReadableShape

  14. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  15. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  16. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  17. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  18. def output(port: String): Socket

    Permalink

    Get an output by the port name.

    Get an output by the port name.

    port

    name of port

    returns

    socket for named port

    Definition Classes
    Shape → ReadableShape

  19. def outputs: Seq[Socket]

    Permalink

    Get list of all outputs.

    Get list of all outputs.

    returns

    list of all outputs

    Definition Classes
    Shape → ReadableShape

  20. def standardInput: Socket

    Permalink

    Get the standard input socket.

    Get the standard input socket.

    The standard input socket is on port "input".

    returns

    standard input socket

    Definition Classes
    ReadableShape

  21. def standardOutput: Socket

    Permalink

    Get the standard output socket.

    Get the standard output socket.

    The standard output socket is on port "output".

    returns

    standard output socket

    Definition Classes
    ReadableShape

  22. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  23. final def wait(): Unit

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

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

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

  25. final def wait(arg0: Long): Unit

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

  26. def withInput(name: String, port: String): Shape.this.type

    Permalink

    Add an input socket to the shape.

    Add an input socket to the shape.

    name

    name of input socket

    port

    port of input socket

    returns

    copy of the shape with input socket added

    Definition Classes
    Shape → WritableShape

  27. def withOutput(name: String, port: String): Shape.this.type

    Permalink

    Add an output socket to the shape.

    Add an output socket to the shape.

    name

    name of output socket

    port

    port of output socket

    returns

    copy of the shape with output socket added

    Definition Classes
    Shape → WritableShape

  28. def withStandardIO(nameInput: String, nameOutput: String): Shape.this.type

    Permalink

    Add standard input/output sockets to the shape.

    Add standard input/output sockets to the shape.

    This is the same as calling WritableShape#withStandardInput and WritableShape#withStandardOutput.

    nameInput

    name of the input socket

    nameOutput

    name of the output socket

    returns

    copy of the shape with standard input/output sockets added

    Definition Classes
    WritableShape

  29. def withStandardInput(name: String): Shape.this.type

    Permalink

    Add standard input socket to the shape.

    Add standard input socket to the shape.

    name

    name of standard input socket

    returns

    copy of the shape with standard input socket added

    Definition Classes
    WritableShape

  30. def withStandardOutput(name: String): Shape.this.type

    Permalink

    Add standard output socket to the shape.

    Add standard output socket to the shape.

    name

    name of standard output socket

    returns

    copy of the shape with standard output socket added

    Definition Classes
    WritableShape

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from WritableShape

Inherited from ReadableShape

Inherited from AnyRef

Inherited from Any

Ungrouped