Package

com.salesforce

op

Permalink

package op

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. op
  2. RichLocationFeature
  3. RichVectorFeature
  4. RichTextFeature
  5. RichSetFeature
  6. RichNumericFeature
  7. RichMapFeature
  8. RichListFeature
  9. RichFeaturesCollection
  10. RichFeature
  11. RichDateFeature
  12. AnyRef
  13. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. case class Continuous(min: Double, max: Double, mean: Double, variance: Double) extends LabelInfo with Product with Serializable

    Permalink

    Summary of label distribution for continuous label

    Summary of label distribution for continuous label

    min

    min value

    max

    max value

    mean

    mean value

    variance

    variance of values

  2. case class Discrete(domain: Seq[String], prob: Seq[Double]) extends LabelInfo with Product with Serializable

    Permalink

    Summary of label distribution for discrete label

    Summary of label distribution for discrete label

    domain

    sequence of all unique values observed in data

    prob

    probabilities of each unique value observed in data (order is matched to domain order)

  3. class EvaluateResult extends OpWorkflowRunnerResult

    Permalink
  4. case class FeatureHistory(originFeatures: Seq[String], stages: Seq[String]) extends JsonLike with Product with Serializable

    Permalink

    History of all stages and origin features used to create a given feature

    History of all stages and origin features used to create a given feature

    originFeatures

    alphabetically ordered names of the raw features this feature was created from

    stages

    sequence of the stageNames applied

  5. case class FeatureInsights(featureName: String, featureType: String, derivedFeatures: Seq[Insights], distributions: Seq[FeatureDistribution] = Seq.empty) extends Product with Serializable

    Permalink

    Summary of feature insights for all features derived from a given input (raw) feature

    Summary of feature insights for all features derived from a given input (raw) feature

    featureName

    name of raw feature insights are about

    featureType

    type of raw feature insights are about

    derivedFeatures

    sequence containing insights for each feature derived from the raw feature

    distributions

    distribution information for the raw feature (if calculated in RawFeatureFilter)

  6. class FeaturesResult extends OpWorkflowRunnerResult

    Permalink
  7. case class Insights(derivedFeatureName: String, stagesApplied: Seq[String], derivedFeatureGroup: Option[String], derivedFeatureValue: Option[String], excluded: Option[Boolean] = None, corr: Option[Double] = None, cramersV: Option[Double] = None, mutualInformation: Option[Double] = None, pointwiseMutualInformation: Map[String, Double] = Map.empty, countMatrix: Map[String, Double] = Map.empty, contribution: Seq[Double] = Seq.empty, min: Option[Double] = None, max: Option[Double] = None, mean: Option[Double] = None, variance: Option[Double] = None) extends Product with Serializable

    Permalink

    Summary of insights for a derived feature

    Summary of insights for a derived feature

    derivedFeatureName

    name of derived feature

    stagesApplied

    the stageNames of all stages applied to make feature from the raw input feature

    derivedFeatureGroup

    grouping of this feature if the feature is a pivot

    derivedFeatureValue

    value of the feature if the feature is a numeric encoding of a non-numeric feature or bucket

    excluded

    was this derived feature excluded from the model by the sanity checker

    corr

    the correlation of this feature with the label

    cramersV

    the cramersV of this feature with the label (when both label and feature are categorical)

    mutualInformation

    the mutual information for this feature (and all features in its grouping) with the label (categorical features only)

    pointwiseMutualInformation

    the mutual information of this feature with each value of the label (categorical features only)

    countMatrix

    the counts of the occurrence of this feature with each of the label values (categorical features only)

    contribution

    the contribution of this feature to the model (eg feature importance for random forest, weight for logistic regression)

    min

    the min value of this feature

    max

    the max value of this feature

    mean

    the mean value of this feature

    variance

    the variance of this feature

  8. trait LabelInfo extends AnyRef

    Permalink

    Common trait for Continuous and Discrete

  9. case class LabelSummary(labelName: Option[String] = None, rawFeatureName: Seq[String] = Seq.empty, rawFeatureType: Seq[String] = Seq.empty, stagesApplied: Seq[String] = Seq.empty, sampleSize: Option[Double] = None, distribution: Option[LabelInfo] = None) extends Product with Serializable

    Permalink

    Summary information about label used in model creation (all fields will be empty if no label is found)

    Summary information about label used in model creation (all fields will be empty if no label is found)

    labelName

    name of label feature

    rawFeatureName

    name of raw features that label is derived from

    rawFeatureType

    types of raw features that label is derived from

    stagesApplied

    the stageNames of all stages applied to label before modeling

    sampleSize

    count of label used to compute distribution information (will be fraction of data corresponding to sample rate in sanity checker)

    distribution

    summary of label distribution (either continuous or discrete)

  10. case class ModelInsights(label: LabelSummary, features: Seq[FeatureInsights], selectedModelInfo: Option[ModelSelectorSummary], trainingParams: OpParams, stageInfo: Map[String, Any]) extends Product with Serializable

    Permalink

    Summary of all model insights

    Summary of all model insights

    label

    summary of information about the label

    features

    sequence containing insights for each raw feature that fed into the model

    selectedModelInfo

    summary information about model training and winning model from model selector

    trainingParams

    op parameters used in model training

    stageInfo

    all stages and their parameters settings used to create feature output of model keyed by stageName

  11. abstract class OpApp extends AnyRef

    Permalink

    A simple command line app for running an OpWorkflow with Spark.

    A simple command line app for running an OpWorkflow with Spark. A user needs to implement a run function.

  12. abstract class OpAppWithRunner extends OpApp

    Permalink

    A simple command line app for running an OpWorkflow with Spark.

    A simple command line app for running an OpWorkflow with Spark. A user needs to implement a runner creation function.

  13. final class OpParams extends JsonLike

    Permalink

    OpParams for passing in command line information

  14. class OpWorkflow extends OpWorkflowCore

    Permalink

    Workflow for TransmogrifAI.

    Workflow for TransmogrifAI. Takes the final features that the user wants to generate as inputs and constructs the full DAG needed to generate them from those features lineage. Then fits any estimators in the pipeline dag to create a sequence of transformations that are saved in a workflow model.

  15. class OpWorkflowModel extends OpWorkflowCore

    Permalink

    Workflow model is a container and executor for the sequence of transformations that have been fit to the data to produce the desired output features

  16. class OpWorkflowModelReader extends MLReader[OpWorkflowModel]

    Permalink

    Reads OpWorkflowModelWriter serialized OpWorkflowModel objects by path and JValue.

    Reads OpWorkflowModelWriter serialized OpWorkflowModel objects by path and JValue. This will only work if the features were serialized in topological order. NOTE: The FeatureGeneratorStages will not be recovered into the Model object, because they are part of each feature.

  17. class OpWorkflowModelWriter extends MLWriter

    Permalink

    Writes the OpWorkflowModel to json format.

    Writes the OpWorkflowModel to json format. For now we will not serialize the parent of the model

    Note

    The features/stages must be sorted in topological order

  18. sealed trait OpWorkflowRunType extends EnumEntry with Serializable

    Permalink
  19. class OpWorkflowRunner extends Serializable

    Permalink

    A class for running an TransmogrifAI Workflow.

    A class for running an TransmogrifAI Workflow. Provides methods to train, score, evaluate and computeUpTo for TransmogrifAI Workflow.

  20. case class OpWorkflowRunnerConfig(runType: OpWorkflowRunType = null, paramLocation: Option[String] = None, defaultParams: OpParams = new OpParams(), readLocations: Map[String, String] = Map.empty, writeLocation: Option[String] = None, modelLocation: Option[String] = None, metricsLocation: Option[String] = None) extends JsonLike with Product with Serializable

    Permalink

    OpWorkflowRunner configuration container

    OpWorkflowRunner configuration container

    runType

    workflow run type

    paramLocation

    workflow file params location

    defaultParams

    default params to use in case the file params is missing

    readLocations

    read locations

    writeLocation

    write location

    modelLocation

    model location

    metricsLocation

    metrics location

  21. trait OpWorkflowRunnerResult extends Serializable

    Permalink
  22. final class ReaderParams extends JsonLike

    Permalink

    Reader params

  23. implicit class RichAnyConcreteFeaturesArray extends RichAnyFeaturesCollection

    Permalink

    Enrichment functions for an array of arbitrary features

    Enrichment functions for an array of arbitrary features

    Definition Classes
    RichFeaturesCollection
  24. implicit class RichAnyFeaturesArray extends RichAnyFeaturesCollection

    Permalink

    Enrichment functions for an array of arbitrary features

    Enrichment functions for an array of arbitrary features

    Definition Classes
    RichFeaturesCollection
  25. implicit class RichAnyFeaturesCollection extends AnyRef

    Permalink

    Enrichment functions for a collection of arbitrary features

    Enrichment functions for a collection of arbitrary features

    Definition Classes
    RichFeaturesCollection
  26. implicit class RichBase64Feature extends AnyRef

    Permalink
    Definition Classes
    RichTextFeature
  27. implicit class RichBase64MapFeature extends AnyRef

    Permalink

    Enrichment functions for Base64Map features.

    Enrichment functions for Base64Map features.

    Definition Classes
    RichMapFeature
  28. implicit class RichBinaryFeature extends AnyRef

    Permalink

    Enrichment functions for Binary Feature

    Enrichment functions for Binary Feature

    Definition Classes
    RichNumericFeature
  29. implicit class RichBooleanMapFeature extends AnyRef

    Permalink

    Enrichment functions for OPMap Features with Boolean values

    Enrichment functions for OPMap Features with Boolean values

    Definition Classes
    RichMapFeature
  30. implicit class RichComboBoxFeature extends AnyRef

    Permalink
    Definition Classes
    RichTextFeature
  31. implicit class RichDateFeature extends AnyRef

    Permalink

    Enrichment functions for Date Feature

    Enrichment functions for Date Feature

    Definition Classes
    RichDateFeature
  32. implicit class RichDateListFeature extends AnyRef

    Permalink

    Enrichment functions for DateList Feature

    Enrichment functions for DateList Feature

    Definition Classes
    RichListFeature
  33. implicit class RichDateMapFeature extends AnyRef

    Permalink

    Enrichment functions for OPMap Features with Date values

    Enrichment functions for OPMap Features with Date values

    Definition Classes
    RichMapFeature
  34. implicit class RichDateTimeFeature extends AnyRef

    Permalink

    Enrichment functions for DateTime Feature

    Enrichment functions for DateTime Feature

    Definition Classes
    RichDateFeature
  35. implicit class RichDateTimeListFeature extends AnyRef

    Permalink

    Enrichment functions for DateList Feature

    Enrichment functions for DateList Feature

    Definition Classes
    RichListFeature
  36. implicit class RichDateTimeMapFeature extends AnyRef

    Permalink

    Enrichment functions for OPMap Features with DateTime values

    Enrichment functions for OPMap Features with DateTime values

    Definition Classes
    RichMapFeature
  37. implicit class RichEmailFeature extends AnyRef

    Permalink
    Definition Classes
    RichTextFeature
  38. implicit class RichEmailMapFeature extends AnyRef

    Permalink

    Enrichment functions for EmailMap Features

    Enrichment functions for EmailMap Features

    Definition Classes
    RichMapFeature
  39. implicit class RichFeature[A <: FeatureType] extends AnyRef

    Permalink

    Enrichment functions for Feature[A]

    Enrichment functions for Feature[A]

    A

    input type

    Definition Classes
    RichFeature
  40. implicit class RichGeolocationFeature extends AnyRef

    Permalink

    Enrichment functions for Geolocation Feature

    Enrichment functions for Geolocation Feature

    Definition Classes
    RichListFeature
  41. implicit class RichGeolocationMapFeature extends AnyRef

    Permalink

    Enrichment functions for OPMap Features with Geolocation values

    Enrichment functions for OPMap Features with Geolocation values

    Definition Classes
    RichMapFeature
  42. implicit class RichIdFeature extends AnyRef

    Permalink
    Definition Classes
    RichTextFeature
  43. implicit class RichIntegralFeature[T <: Integral] extends AnyRef

    Permalink

    Enrichment functions for Integral Feature

    Enrichment functions for Integral Feature

    Definition Classes
    RichNumericFeature
  44. implicit class RichIntegralMapFeature[T <: OPMap[Long]] extends AnyRef

    Permalink

    Enrichment functions for OPMap Features with Long values

    Enrichment functions for OPMap Features with Long values

    Definition Classes
    RichMapFeature
  45. implicit class RichLocationFeature[T <: Text with Location] extends AnyRef

    Permalink
    Definition Classes
    RichLocationFeature
  46. implicit class RichMapFeature[T <: OPMap[_]] extends AnyRef

    Permalink

    Enrichment functions for OPMap Features

    Enrichment functions for OPMap Features

    Definition Classes
    RichMapFeature
  47. implicit class RichMultiPickListMapFeature[T <: OPMap[Set[String]]] extends AnyRef

    Permalink

    Enrichment functions for OPMap Features with String values

    Enrichment functions for OPMap Features with String values

    Definition Classes
    RichMapFeature
  48. implicit class RichNumericFeature[I <: OPNumeric[_]] extends AnyRef

    Permalink

    Enrichment functions for Numeric Feature

    Enrichment functions for Numeric Feature

    I

    input type

    Definition Classes
    RichNumericFeature
  49. implicit class RichOPSetFeature[T <: OPSet[_]] extends AnyRef

    Permalink

    Enrichment functions for OPSet Feature

    Enrichment functions for OPSet Feature

    Definition Classes
    RichSetFeature
  50. implicit class RichPhoneFeature extends AnyRef

    Permalink
    Definition Classes
    RichTextFeature
  51. implicit class RichPhoneMapFeature extends AnyRef

    Permalink

    Enrichment functions for PhoneMap features

    Enrichment functions for PhoneMap features

    Definition Classes
    RichMapFeature
  52. implicit class RichPickListFeature extends AnyRef

    Permalink
    Definition Classes
    RichTextFeature
  53. implicit class RichRealFeature[T <: Real] extends AnyRef

    Permalink

    Enrichment functions for Real Feature

    Enrichment functions for Real Feature

    Definition Classes
    RichNumericFeature
  54. implicit class RichRealMapFeature[T <: OPMap[Double]] extends AnyRef

    Permalink

    Enrichment functions for OPMap Features with Double values

    Enrichment functions for OPMap Features with Double values

    Definition Classes
    RichMapFeature
  55. implicit class RichRealNNFeature extends AnyRef

    Permalink

    Enrichment functions for Real non nullable Feature

    Enrichment functions for Real non nullable Feature

    Definition Classes
    RichNumericFeature
  56. implicit class RichSetFeature extends AnyRef

    Permalink

    Enrichment functions for MultiPickList Feature

    Enrichment functions for MultiPickList Feature

    Definition Classes
    RichSetFeature
  57. implicit class RichStringMapFeature[T <: OPMap[String]] extends AnyRef

    Permalink

    Enrichment functions for OPMap Features with String values.

    Enrichment functions for OPMap Features with String values. All are pivoted by default except TextMap and TextAreaMap which are defined specially below.

    Definition Classes
    RichMapFeature
  58. implicit class RichTextAreaMapFeature extends AnyRef

    Permalink

    Enrichment functions for TextAreaMap Features (they are hashed by default instead of being pivoted)

    Enrichment functions for TextAreaMap Features (they are hashed by default instead of being pivoted)

    Definition Classes
    RichMapFeature
  59. implicit class RichTextFeature[T <: Text] extends AnyRef

    Permalink
    Definition Classes
    RichTextFeature
  60. implicit class RichTextListFeature extends AnyRef

    Permalink

    Enrichment functions for TextList Feature

    Enrichment functions for TextList Feature

    Definition Classes
    RichListFeature
  61. implicit class RichTextMapFeature extends AnyRef

    Permalink

    Enrichment functions for TextMap Features (they are hashed by default instead of being pivoted)

    Enrichment functions for TextMap Features (they are hashed by default instead of being pivoted)

    Definition Classes
    RichMapFeature
  62. implicit class RichURLFeature extends AnyRef

    Permalink
    Definition Classes
    RichTextFeature
  63. implicit class RichURLMapFeature extends AnyRef

    Permalink

    Enrichment functions for URLMap Features

    Enrichment functions for URLMap Features

    Definition Classes
    RichMapFeature
  64. implicit class RichVectorFeature extends AnyRef

    Permalink

    Enrichment functions for Vector Feature

    Enrichment functions for Vector Feature

    Definition Classes
    RichVectorFeature
  65. implicit class RichVectorFeaturesCollection extends AnyRef

    Permalink

    Enrichment functions for a collection of vector features

    Enrichment functions for a collection of vector features

    Definition Classes
    RichFeaturesCollection
  66. class ScoreResult extends OpWorkflowRunnerResult

    Permalink
  67. class StreamingScoreResult extends OpWorkflowRunnerResult

    Permalink
  68. class TrainResult extends OpWorkflowRunnerResult

    Permalink

Value Members

  1. object FeatureHistory extends Product with Serializable

    Permalink
  2. object ModelInsights extends Product with Serializable

    Permalink
  3. object OpParams extends Serializable

    Permalink

    OpParams factory

  4. object OpWorkflowModel extends Product with Serializable

    Permalink
  5. object OpWorkflowModelWriter

    Permalink

    Writes the OpWorkflowModel into a specified path

  6. object OpWorkflowRunType extends Enum[OpWorkflowRunType] with Serializable

    Permalink
  7. object UID extends Product with Serializable

    Permalink

    Unique Identifier (UID) generator

  8. package aggregators

    Permalink
  9. package cli

    Permalink
  10. package dsl

    Permalink
  11. package evaluators

    Permalink
  12. package features

    Permalink
  13. package filters

    Permalink
  14. package local

    Permalink
  15. package readers

    Permalink
  16. package stages

    Permalink
  17. package test

    Permalink
  18. package testkit

    Permalink
  19. package utils

    Permalink

Inherited from op.dsl.RichVectorFeature

Inherited from op.dsl.RichTextFeature

Inherited from op.dsl.RichSetFeature

Inherited from op.dsl.RichNumericFeature

Inherited from op.dsl.RichMapFeature

Inherited from RichListFeature

Inherited from RichFeaturesCollection

Inherited from op.dsl.RichFeature

Inherited from op.dsl.RichDateFeature

Inherited from AnyRef

Inherited from Any

Ungrouped