Type Members

1.  case class AlgorithmDefinition(bridge: MantikId, type: FunctionType) extends MantikDefinitionWithBridge with Product with Serializable

   An Algorithm Definition inside a MantikHeader.

2.  case class BridgeDefinition(dockerImage: String, suitable: Seq[String], protocol: Int = 1, payloadContentType: Option[String] = Some("application/zip")) extends MantikDefinitionWithoutBridge with Product with Serializable

   A Bridge definition.

   A Bridge definition.

   protocol

   0 ... Just pipe out DataSet, 1 ... Regular Format.

   payloadContentType

   if set, the bridge expects a payload content type.

3.  case class CombinerDefinition(bridge: MantikId, input: Seq[DataType], output: Seq[DataType]) extends MantikDefinitionWithBridge with Product with Serializable

   Combiner Definition (e.g.

   Combiner Definition (e.g. for SQL Operations)

4.  case class DataSetDefinition(bridge: MantikId, type: DataType) extends MantikDefinitionWithBridge with Product with Serializable

   A DataSet definition inside a MantikHeader

5.  final class ItemId extends MantikId

   Provides a stable identifier for Mantik Items.

   Provides a stable identifier for Mantik Items.

   In contrast to NamedMantikId this id always responds to the very same item. In practice, all NamedMantikId link to a ItemId which link to the item content.

   They can not be overwritten but deleted.

   In the moment they are random, but in future they shall represent hash values of the items.

6.  sealed trait MantikDefinition extends AnyRef

   A Basic Mantik Definition (algorithms, datasets, etc...)

7.  sealed trait MantikDefinitionWithBridge extends MantikDefinition

   A MantikDefinition which needs a Bridge.

8.  sealed trait MantikDefinitionWithoutBridge extends MantikDefinition

   A MantikDefinition which doesn't need a bridge.

9.  case class MantikHeader[T <: MantikDefinition](definition: T, metaJson: MetaJson, header: MantikHeaderMeta) extends Product with Serializable

   A MantikHeader file.

   A MantikHeader file. Contains one Mantik Definition together with it's JSON representation.

   definition

   the base definition of the Mantik Item

   metaJson

   the JSON source of the item and it's meta variables

   header

   common optional meta fields of a MantikHeader (e.g. Name, Version, ...) Note: MetaJson and MantikHeaderMeta both have meta in their name, but are completely different things.

10.  case class MantikHeaderMeta(author: Option[String] = None, authorEmail: Option[String] = None, name: Option[String] = None, version: Option[String] = None, account: Option[String] = None) extends Product with Serializable

    Contains Meta information inside a MantikHeader.

    Contains Meta information inside a MantikHeader. All fields are optional.

    All elements are directly parsed from the JSON.

    author

    author of the file, for informative use only

    authorEmail

    email of Author

    name

    default name of the Artifact behind the MantikHeader.

    version

    default version of the Artifact behind the mantik header.

    account

    default account name of the Artifact behind the mantik header.

11.  sealed trait MantikId extends AnyRef

    Identifies a MantikArtifact.

    Identifies a MantikArtifact. Can either be an (anonymous) ItemId or a NamedMantikId

12.  final case class NamedMantikId(account: String = NamedMantikId.DefaultAccount, name: String, version: String = NamedMantikId.DefaultVersion) extends MantikId with Product with Serializable

    A Named Mantik Artifact.

    A Named Mantik Artifact.

    account

    the users account, defaults to library.

    name

    of the Mantik artifact. If it starts with @ it refers to a ItemId.

    version

    the version, defaults to latest.

13.  case class OptionalFunctionType(input: Option[DataType] = None, output: Option[DataType] = None) extends Product with Serializable

    A Function type where input/output are optional.

14.  case class PipelineDefinition(type: Option[OptionalFunctionType] = None, steps: List[PipelineStep]) extends MantikDefinitionWithoutBridge with Product with Serializable

    A Pipeline.

    A Pipeline. A special item which refers to other algorithm items which executed after each other.

15.  sealed trait PipelineStep extends AnyRef

    A Single step within a PipelineDefinition.

16.  case class TrainableAlgorithmDefinition(bridge: MantikId, trainedBridge: Option[MantikId] = None, type: FunctionType, trainingType: DataType, statType: DataType) extends MantikDefinitionWithBridge with Product with Serializable