Class/Object

io.github.timsetsfire.datarobot

Model

Related Docs: object Model | package datarobot

Permalink

class Model extends AnyRef

Model

Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Model
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Model(featurelistId: String, processes: Array[String], featurelistName: String, projectId: String, samplePct: Option[Double], trainingDuration: Option[String], trainingRowCount: Option[Int], trainingStartDate: Option[String], trainingEndDate: Option[String], modelCategory: String, isFrozen: Boolean = false, metrics: Map[String, Metric], modelType: String, blueprintId: String, monotonicIncreasingFeaturelistId: Option[String] = None, monotonicDecreasingFeaturelistId: Option[String] = None, supportsMonotonicConstraints: Option[Boolean] = None, id: String, isStarred: Boolean = false, predictionThreshold: Option[Double], predictionThresholdReadOnly: Option[Boolean])

    Permalink

    featurelistId

    the ID of the featurelist used by the model

    processes

    a json list of processes used by the model

    featurelistName

    the name of the featurelist used by the model

    projectId

    the ID of the project to which the model belongs

    samplePct

    the percentage of the dataset used in training the model

    trainingDuration

    the duration spanned by the dates in the partition column for the data used to train the model

    trainingRowCount

    the number of rows used to train the model

    trainingStartDate

    the start date of the dates in the partition column for the data used to train the model

    trainingEndDate

    the end date of the dates in the partition column for the data used to train the model

    modelCategory

    indicateswhatkindofmodelitis -willbeprimeforDataRobotPrime models, blend for blender models, scaleout for scaleout models, and model for all other models

    isFrozen

    boolean, indicating whether the model is frozen, i.e. uses tuning parameters from a parent model

    metrics

    the performance of the model according to various metrics, see below

    modelType

    identifies the model, e.g. Nystroem Kernel SVM Regressor

    blueprintId

    the blueprint used to construct the model - note this is not an ObjectId

    monotonicIncreasingFeaturelistId

    (new in v2.11) null or str, the ID of the featurelist that defines the set of features with a monotonically increasing relationship to the target. If null, no such constraints are enforced.

    monotonicDecreasingFeaturelistId

    (new in v2.11) null or str, the ID of the featurelist that defines the set of features with a monotonically decreasing relationship to the target. If null, no such constraints are enforced.

    supportsMonotonicConstraints

    (new in v2.11) boolean, whether this model supports enforcing montonic constraints

    id

    Model ID

    isStarred

    (bool) (New in version v2.13) whether the model has been starred

    predictionThreshold

    (float) (New in version v2.13) threshold used for binary classification in predictions.

    predictionThresholdReadOnly

    (boolean) (New in version v2.13) indicates whether modification of a predictions threshold is forbidden. Threshold modification is forbidden once a model has had a deployment created or predictions made via the dedicated prediction API.

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. def advancedTuning(description: String)(implicit client: DataRobotClient): AdvancedTuningSession

    Permalink
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. val blueprintId: String

    Permalink

    the blueprint used to construct the model - note this is not an ObjectId

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @throws( ... )
  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  10. val featurelistId: String

    Permalink

    the ID of the featurelist used by the model

  11. val featurelistName: String

    Permalink

    the name of the featurelist used by the model

  12. def getCapabilities()(implicit client: DataRobotClient): (Map[String, Boolean], Map[String, String])

    Permalink
  13. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  14. def getCrossValidationScores()(implicit client: DataRobotClient): Map[String, Map[String, Map[String, Double]]]

    Permalink
  15. def getFeatureEffects(source: String = "validation", backtestIndex: Option[String] = None)(implicit client: DataRobotClient): FeatureEffects

    Permalink
  16. def getFeatureEffectsMetaData()(implicit client: DataRobotClient): String

    Permalink
  17. def getFeatureFit(source: String = "validation", backtestIndex: Option[String] = None)(implicit client: DataRobotClient): FeatureFits

    Permalink
  18. def getFeatureFitMetaData()(implicit client: DataRobotClient): String

    Permalink
  19. def getFeatureImpact()(implicit client: DataRobotClient): FeatureImpacts

    Permalink
  20. def getHyperParameters()(implicit client: DataRobotClient): Map[String, List[Map[String, Any]]]

    Permalink
  21. def getLiftChart(source: enums.Source.Value)(implicit client: DataRobotClient): LiftChart

    Permalink
  22. def getLiftCharts()(implicit client: DataRobotClient): Map[String, List[LiftChart]]

    Permalink
  23. def getMissingValueReport()(implicit client: DataRobotClient): List[Map[_ <: String, Any]]

    Permalink
  24. def getModelBlueprintChart()(implicit client: DataRobotClient): Graph[BlueprintNode, LDiEdge]

    Permalink
  25. def getModelCoefficients()(implicit client: DataRobotClient): ModelCoefficients

    Permalink
  26. def getResiduals()(implicit client: DataRobotClient): Map[String, Map[String, ResidualData]]

    Permalink
  27. def getRocCurve(source: enums.Source.Value)(implicit client: DataRobotClient): RocCurve

    Permalink
  28. def getRocCurves()(implicit client: DataRobotClient): Map[String, List[RocCurve]]

    Permalink
  29. def getScoringCode(destination: Option[String] = None, sourceCode: Boolean = false)(implicit client: DataRobotClient): Unit

    Permalink
  30. def getWordCloud()(implicit client: DataRobotClient): WordCloud

    Permalink
  31. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  32. val id: String

    Permalink

    Model ID

  33. val isFrozen: Boolean

    Permalink

    boolean, indicating whether the model is frozen, i.e.

    boolean, indicating whether the model is frozen, i.e. uses tuning parameters from a parent model

  34. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  35. var isStarred: Boolean

    Permalink

    (bool) (New in version v2.13) whether the model has been starred

  36. val metrics: Map[String, Metric]

    Permalink

    the performance of the model according to various metrics, see below

  37. val modelCategory: String

    Permalink

    indicateswhatkindofmodelitis -willbeprimeforDataRobotPrime models, blend for blender models, scaleout for scaleout models, and model for all other models

  38. val modelType: String

    Permalink

    identifies the model, e.g.

    identifies the model, e.g. Nystroem Kernel SVM Regressor

  39. val monotonicDecreasingFeaturelistId: Option[String]

    Permalink

    (new in v2.11) null or str, the ID of the featurelist that defines the set of features with a monotonically decreasing relationship to the target.

    (new in v2.11) null or str, the ID of the featurelist that defines the set of features with a monotonically decreasing relationship to the target. If null, no such constraints are enforced.

  40. val monotonicIncreasingFeaturelistId: Option[String]

    Permalink

    (new in v2.11) null or str, the ID of the featurelist that defines the set of features with a monotonically increasing relationship to the target.

    (new in v2.11) null or str, the ID of the featurelist that defines the set of features with a monotonically increasing relationship to the target. If null, no such constraints are enforced.

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

    Permalink
    Definition Classes
    AnyRef
  42. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  43. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  44. var predictionThreshold: Option[Double]

    Permalink

    (float) (New in version v2.13) threshold used for binary classification in predictions.

  45. var predictionThresholdReadOnly: Option[Boolean]

    Permalink

    (boolean) (New in version v2.13) indicates whether modification of a predictions threshold is forbidden.

    (boolean) (New in version v2.13) indicates whether modification of a predictions threshold is forbidden. Threshold modification is forbidden once a model has had a deployment created or predictions made via the dedicated prediction API.

  46. val processes: Array[String]

    Permalink

    a json list of processes used by the model

  47. val projectId: String

    Permalink

    the ID of the project to which the model belongs

  48. def requestAndGetFeatureEffects(source: String = "validation", backtestIndex: Option[String] = None)(implicit client: DataRobotClient): FeatureEffects

    Permalink
  49. def requestAndGetFeatureFit(source: String = "validation", backtestIndex: Option[String] = None)(implicit client: DataRobotClient): FeatureFits

    Permalink
  50. def requestAndGetFeatureImpact(maxWait: Int = 600000)(implicit client: DataRobotClient): AnyRef

    Permalink
  51. def requestFeatureEffects(backtestIndex: Option[String] = None)(implicit client: DataRobotClient): Job

    Permalink
  52. def requestFeatureFit(backtestIndex: Option[String] = None)(implicit client: DataRobotClient): Job

    Permalink
  53. def requestFeatureImpact()(implicit client: DataRobotClient): Job

    Permalink
  54. def requestFrozenModel(samplePct: Option[Float] = None, trainingRowCount: Option[Int] = None)(implicit client: DataRobotClient): ModelJob

    Permalink
  55. def requestPredictions(datasetId: String, includePredictionIntervals: Option[Boolean] = None, predictionIntervalSize: Option[Int] = None, forecastPoint: Option[String] = None, predictionsStartDate: Option[String] = None, predictionsEndDate: Option[String] = None)(implicit client: DataRobotClient): PredictJob

    Permalink
  56. def runCrossValidation()(implicit client: DataRobotClient): Job

    Permalink
  57. val samplePct: Option[Double]

    Permalink

    the percentage of the dataset used in training the model

  58. def starModel()(implicit client: DataRobotClient): Model

    Permalink
  59. val supportsMonotonicConstraints: Option[Boolean]

    Permalink

    (new in v2.11) boolean, whether this model supports enforcing montonic constraints

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

    Permalink
    Definition Classes
    AnyRef
  61. def toString(): String

    Permalink
    Definition Classes
    Model → AnyRef → Any
  62. def toggleStar(starred: Boolean)(implicit client: DataRobotClient): Model

    Permalink
  63. val trainingDuration: Option[String]

    Permalink

    the duration spanned by the dates in the partition column for the data used to train the model

  64. val trainingEndDate: Option[String]

    Permalink

    the end date of the dates in the partition column for the data used to train the model

  65. val trainingRowCount: Option[Int]

    Permalink

    the number of rows used to train the model

  66. val trainingStartDate: Option[String]

    Permalink

    the start date of the dates in the partition column for the data used to train the model

  67. def unstarModel()(implicit client: DataRobotClient): Model

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  69. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  70. final def wait(): Unit

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

Deprecated Value Members

  1. def finalize(): Unit

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

    (Since version ) see corresponding Javadoc for more information.

Inherited from AnyRef

Inherited from Any

Ungrouped