Packages

class Project extends AnyRef

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

Instance Constructors

  1. new Project(id: String, projectName: String, fileName: String, stage: String, autopilotMode: Option[Double], created: String, target: Option[String], metric: Option[String], partition: Option[Partition], recommender: Option[Recommender], advancedOptions: Option[AdvancedOptions], positiveClass: Option[Double], maxTrainPct: Option[Double], maxTrainRows: Option[Double], scaleoutMaxTrainPct: Option[Double], scaleoutMaxTrainRows: Option[Double], holdoutUnlocked: Boolean = false, targetType: Option[String])

    create a new project.

    create a new project.

    id

    project id

    projectName

    project name

    fileName

    the name of the dataset used to create the project

    autopilotMode

    0 if autopiloe, 2 is manual

    created

    project creation time

    target

    project target

    metric

    the metric used to select the best-performing models

    partition

    partition of given project. See io.github.timsetsfire.datarobot.Partition.

    recommender

    does nothing

    advancedOptions

    advanced options of the project. See io.github.timsetsfire.datarobot.AdvancedOptions.

    positiveClass

    for binary classification projects, the class designated to be the positive class. Otherwise, null.

    maxTrainPct

    the maximum percentage of the dataset that can be used to successfully train a model without going into the validation data

    maxTrainRows

    the maximum number of rows of the dataset that can be used to suc- cessfully train a model without going into the validation data

    scaleoutMaxTrainPct

    the maximum percentage of the dataset that can be used to successfully train a scaleout model without going into the validation data. May exceed maxTrainPct, in which case only scaleout models can be trained up to this point.

    scaleoutMaxTrainRows

    the maximum number of rows of the dataset that can used be used to successfully train a scaleout model without going into the validation data. May exceed maxTrainRows, in which case only scaleout models can be trained up to this point.

    holdoutUnlocked

    true if holdout has been unlocked

    targetType

    either Regression, Binary, or Multiclass

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. var advancedOptions: Option[AdvancedOptions]
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. var autopilotMode: Option[Double]
  7. def clone(newProjectName: String, maxWait: Int = 60000)(implicit client: DataRobotClient): Project

    newProjectName

    Name of returns project

    maxWait

    Max wait time

    returns

    Returns a copy (post-EDA1) copy of the project.

    To do

    add maxWait appropriate to request happening behind the scenes.

  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  9. def createBlender(models: List[Model], blenderMethod: enums.BlenderMethod.Value)(implicit client: DataRobotClient): ModelJob

    models

    list of io.github.timsetsfire.datarobot.Model to use for blending

    blenderMethod

    one of io.github.timsetsfire.datarobot.enums.BlenderMethod

    returns

    Returns io.github.timsetsfire.datarobot.ModelJob for the requested blender

  10. def createFeaturelist(name: String, features: List[String])(implicit client: DataRobotClient): Featurelist

    Create feature list within a project.

    Create feature list within a project. see also io.github.timsetsfire.datarobot.Featurelist.createFeaturelist

    name

    Name for new featurelist

    features

    List of feature names to include in list

    returns

    new feature list object io.github.timsetsfire.datarobot.Featurelist

  11. val created: String
  12. def delete()(implicit client: DataRobotClient): HttpResponse[String]

    returns

    Returns Unit. Deletes projects

  13. def deleteFeaturelist(featurelistId: String)(implicit cleint: DataRobotClient): HttpResponse[String]
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  16. val fileName: String
  17. def getAccessList()(implicit client: DataRobotClient): List[Map[String, String]]

    returns

    list of users and permissions for given project

  18. def getAssociationFeatureLists()(implicit client: DataRobotClient): Seq[Map[String, String]]
  19. def getBlenderEligibility(models: List[Model], blenderMethod: enums.BlenderMethod.Value)(implicit client: DataRobotClient): Map[String, Any]

    models

    List of models to blend together

  20. def getBlenders()(implicit client: DataRobotClient): Nothing

    To do

    implement this

  21. def getBlueprint(id: String)(implicit client: DataRobotClient): Blueprint

    id

    blueprint id

    returns

    blueprint

    See also

    io.github.timsetsfire.datarobot.Blueprint.get

  22. def getBlueprintChart(blueprintId: String)(implicit client: DataRobotClient): Nothing

    blueprintId

    blueprint d

    To do

    implement this

  23. def getBlueprintDocumentation(blueprintId: String)(implicit client: DataRobotClient): Nothing

    blueprintId

    blueprint d

    To do

    implement this

  24. def getBlueprints()(implicit client: DataRobotClient): List[Blueprint]

    returns

    returns a list of eligible blueprints

    See also

    io.github.timsetsfire.datarobot.Blueprint.getBlueprints

  25. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  26. def getDatasets()(implicit client: DataRobotClient): Nothing

    To do

    implement this

  27. def getFeature(featureName: String)(implicit client: DataRobotClient): Feature

    returns

    return io.github.timsetsfire.datarobot.Feature given specified featurename

  28. def getFeatureAssocationMatrix(metric: enums.FeatureAssociationMetric.Value = FeatureAssociationMetric.MUTUALINFO, atype: enums.FeatureAssociationType.Value = FeatureAssociationType.ASSOCIATION, featurelistId: Option[String] = None)(implicit client: DataRobotClient): (Counter2[String, String, Double], List[FeatureAssociationDetail])

    metric

    association matrix metric

    atype

    association matric value type

    returns

    returns feature association matric for a given featurelist

  29. def getFeatureAssociationMatrixDetails(feature1: String, feature2: String, featurelistId: Option[String] = None)(implicit client: DataRobotClient): Map[String, Any]

    returns

    Returns associtation matric details for feature1 and feature2.

  30. def getFeaturelists()(implicit client: DataRobotClient): List[Featurelist]

    returns

    all featurelists available in project

  31. def getFeatures()(implicit client: DataRobotClient): List[Feature]

    returns

    set of all features available in project

  32. def getFrozenModel(modelId: String)(implicit client: DataRobotClient): Nothing

    modelId

    model id to get

    returns

    frozen model for specified id

    To do

    implement this

  33. def getFrozenModels()(implicit client: DataRobotClient): List[FrozenModel]

    returns

    list of frozen models for project

  34. def getJob(jobId: String)(implicit client: DataRobotClient): Job
  35. def getJobs(status: Option[String] = None)(implicit client: DataRobotClient): List[Job]
  36. def getLeaderboardLink()(implicit client: DataRobotClient): Nothing

    To do

    implement this

  37. def getMetrics(featureName: String)(implicit client: DataRobotClient): Map[String, Any]

    returns

    set of metrics available if given featureName is set as target

  38. def getModel(modelId: String)(implicit client: DataRobotClient): Model

    modelId

    model id to get

    returns

    model for specified modelId

  39. def getModelJob(jobId: String)(implicit client: DataRobotClient): Job
  40. def getModelJobs(status: Option[String] = None)(implicit client: DataRobotClient): List[Job]
  41. def getModels()(implicit client: DataRobotClient): List[Model]

    returns

    list of models for the project

  42. def getPredictJob(jobId: String)(implicit client: DataRobotClient): Job

    To do

    implement this

  43. def getPredictJobs(status: Option[String] = None)(implicit client: DataRobotClient): List[Job]
  44. def getPrimeFiles(projectId: String)(implicit client: DataRobotClient): Nothing

    To do

    implement this

  45. def getPrimeModels(projectId: String)(implicit client: DataRobotClient): Nothing

    To do

    implement this

  46. def getRatingTableModels(projectId: String)(implicit client: DataRobotClient): Nothing

    To do

    implement this

  47. def getRatingTables(projectId: String)(implicit client: DataRobotClient): Nothing

    To do

    implement this

  48. def getRecommendedModel()(implicit client: DataRobotClient): ModelRecommendation

    returns

    Returns model recommended for deployment

  49. def getRecommendedModels()(implicit client: DataRobotClient): List[ModelRecommendation]

    returns

    REturns a list of models recommended by DataRobot

  50. def getReducedBlueprintChart(blueprintId: String)(implicit client: DataRobotClient): Nothing

    blueprintId

    blueprint d

    To do

    implement this

  51. def getStatus(projectId: String)(implicit client: DataRobotClient): Nothing

    To do

    implement this

  52. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  53. var holdoutUnlocked: Boolean
  54. val id: String
  55. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  56. var maxTrainPct: Option[Double]
  57. var maxTrainRows: Option[Double]
  58. var metric: Option[String]
  59. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  60. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  61. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  62. var partition: Option[Partition]
  63. var positiveClass: Option[Double]
  64. var projectName: String
  65. def refresh()(implicit client: DataRobotClient): Project
  66. def requestFeatureAssocationMatrix(featurelistId: String)(implicit client: DataRobotClient): String

    Caluclated assocation matrix for specific featurelist

  67. var scaleoutMaxTrainPct: Option[Double]
  68. var scaleoutMaxTrainRows: Option[Double]
  69. def setAccessList()(implicit client: DataRobotClient): Nothing

  70. def setProjectName(name: String)(implicit client: DataRobotClient): Project
  71. def setTarget(target: String, mode: enums.ModelingMode.Value = ModelingMode.AUTOPILOT, metric: Option[String] = None, quickrun: Boolean = false, positiveClass: Option[String] = None, partitioningMethod: Option[PartitioningMethod] = None, featurelistId: Option[String] = None, advancedOptions: Option[AdvancedOptions] = None, maxWait: Int = 600000, targetType: Option[enums.TargetType.Value] = None, workerCount: Option[Int] = None)(implicit client: DataRobotClient): Project

    Start modeling

  72. def setWorkerCount(workerCount: Int)(implicit client: DataRobotClient): Unit

    workerCount

    Number of workers to use for modeling

  73. var stage: String
  74. def startAutopilot(projectId: String, featurelistId: Option[String] = None)(implicit client: DataRobotClient): HttpRequest
  75. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  76. var target: Option[String]
  77. var targetType: Option[String]
  78. def toDateTimeProject: DateTimeProject
  79. def toString(): String
    Definition Classes
    Project → AnyRef → Any
  80. def train(blueprint: Blueprint, featurelistId: Option[String] = None, samplePct: Option[Float] = None, trainingRowCount: Option[Int] = None, sourceProjectId: Option[String] = None, scoringType: Option[String] = None, monotonicIncreasingFeaturelistId: Option[String] = None, monotonicDecreasingFeaturelistId: Option[String] = None)(implicit client: DataRobotClient): ModelJob
  81. def unlockHoldout()(implicit client: DataRobotClient): Project
  82. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  83. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  84. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped