⚠️There's a newer version (2.18.6) of this package.Take me there.

datarobot (version 2.8.0)

'DataRobot' Predictive Modeling API

Description

For working with the 'DataRobot' predictive modeling platform's API .

Copy Link

Version

Install

install.packages('datarobot')

Monthly Downloads

390

Version

2.8.0

License

MIT + file LICENSE

Maintainer

David Chudzicki

Last Published

January 17th, 2018

Functions in datarobot (2.8.0)

CreateDerivedFeatures

Derived Features

CreateFeaturelist

Create a new featurelist in a DataRobot project

ConnectToDataRobot

Establish a connection to the DataRobot modeling engine

ConstructDurationString

Construct a valid string representing a duration in accordance with ISO8601

BlendMethods

Blend methods

BlueprintChartToGraphviz

Convert a blueprint chart into graphviz DOT format

CreateBacktestSpecification

Create a list describing backtest parameters

CreateDatetimePartitionSpecification

Create a list describing datetime partition parameters

CreateRatingTable

Creates and validates a new rating table from an uploaded CSV.

CreateStratifiedPartition

Create a stratified sampling-based S3 object of class partition for the SetTarget function

DeleteModelJob

Delete a model job from the modeling queue

DeletePredictJob

Function to delete one predict job from the DataRobot queue

DataPathFromDataArg

Get the data path.

DataSubset

Data subset for training predictions

DeleteJob

Cancel a running job

DeleteModel

Delete a specified DataRobot model

CreatePrimeCode

Create and validate the downloadable code for the ruleset associated with this model

CreateRandomPartition

Create a random sampling-based S3 object of class partition for the SetTarget function

DownloadTransferrableModel

Download an transferrable model file for use in an on-premise DataRobot standalone prediction environment.

ExpectHasKeys

Make sure that the object has all of the keys specified. Also tests that there are not additional keys if allowAdditional is FALSE (default).

CreateUserPartition

Create a class partition object for use in the SetTarget function representing a user-defined partition.

DataPartition

Data Partition methods

DeletePredictionDataset

Delete a specified prediction dataset

DeleteProject

Delete a specified element from the DataRobot project list

ApplySchema

Apply a schema to DataRobot objects (lists, frames)

AutopilotMode

Autopilot modes

DeleteTransferrableModel

Delete this imported model.

DownloadPrimeCode

Download the code of DataRobot Prime model and save it to a file.

FeatureFromAsyncUrl

Retrieve a feature from the creation URL

GenerateDatetimePartition

Preview the full partitioning determined by a DatetimePartitioningSpecification

GetConfusionChart

Retrieve a model's confusion chart for a specified source.

GetDatetimeModelFromJobId

Retrieve a new or updated datetime model defined by modelJobId

GetFeatureImpactForJobId

Retrieve completed Feature Impact results given a job ID

GetFeatureImpactForModel

Retrieve completed Feature Impact results given a model

GetBlueprintDocumentation

Get documentation for tasks used in the blueprint

GetBlueprintDocuments

Get documentation for tasks used in the blueprint

GetDatetimeModelObject

Retrieve the details of a specified datetime model.

GetModelBlueprintDocumentation

Get documentation for tasks used in the model blueprint

GetModelFromJobId

Retrieve a new or updated model defined by modelJobId

GetPrimeModelFromJobId

Retrieve information about specified DataRobot Prime model using corresponding jobId.

GetDatetimePartition

Retrieve the DatetimePartitioning from a project

GetModel

Retrieve the details of a specified model

GetModelBlueprintChart

Retrieve a model blueprint chart

GetProjectList

Retrieve a list of all DataRobot projects

GetProjectStatus

Request Autopilot status for a specified DataRobot project

GetRatingTableModel

Retrieve information about specified model with a rating table.

GetRatingTableModelFromJobId

Retrieve a new or updated rating table model defined by a job ID.

DownloadRatingTable

Download a rating table to a CSV.

DownloadReasonCodes

Function to download and save reason codes rows as csv file

GetAllReasonCodesRowsAsDataFrame

Retrieve all reason codes rows and return them as a data frame

GetBlenderModel

Retrieve the details of a specified blender model

GetBlenderModelFromJobId

Retrieve a new or updated blender model defined by modelJobId

GetFrozenModel

Retrieve the details of a specified frozen model

ListBlueprints

Retrieve the list of available blueprints for a project

ListConfusionCharts

Returns all available confusion charts for the model.

ListTrainingPredictions

Retrieve information about all training prediction datasets in a project.

ListTransferrableModels

Retrieve information about all imported models This function returns a data.frame that describes all imported models

GetFrozenModelFromJobId

Retrieve a frozen model defined by modelJobId

GetModelObject

Retrieve the details of a specified model

GetModelParameters

Retrieve model parameters

GetProject

Retrieve dtails about a specified DataRobot modeling project

GetReasonCodesRows

Retrieve all reason codes rows

GetRecommendedBlueprints

Retrieve the list of available blueprints for a project

GetTrainingPredictionDataFrame

Simplify the training prediction rows into a tidy format dataframe.

GetTrainingPredictions

Retrieve training predictions on a specified data set.

RequestFrozenModel

Train a new frozen model with parameters from specified model

RequestNewDatetimeModel

Adds a new datetime model of the type specified by the blueprint to a DataRobot project

RequestReasonCodesInitialization

Request reason codes initialization for specified model

CreateGroupPartition

Create a group-based S3 object of class partition for the SetTarget function

CreateModelingFeaturelist

This function allows the user to create a new featurelist in a project by specifying its name and a list of variables to be included

DeleteReasonCodes

Function to delete reason codes

DeleteReasonCodesInitialization

Delete the reason codes initialization for a model.

RequestSampleSizeUpdate

Refits an existing model to a different fraction of the training dataset

StartNewAutoPilot

Starts autopilot on provided featurelist. Only one autopilot can be running at the time. That's why any ongoing autopilot on different featurelist will be halted - modelling jobs in queue would not be affected but new jobs would not be added to queue by halted autopilot.

StartRetryWaiter

Creates a waiter function that can be used in a loop while trying some task many times. The waiter sleeps while waiting to try again, with sleep times determined by exponential back-off.

DownloadScoringCode

Download scoring code JAR

DownloadTrainingPredictions

Download training predictions on a specified data set.

GetBlueprint

Retrieve a blueprint

Stringify

Convert a function into a single string for DataRobot

TargetType

Target Type modes

ViewWebProject

Retrieve a DataRobot web page that displays detailed project information

GetAllRocCurves

Retrieve ROC curve data for a model for all available data partitions (see DataPartition)

GetModelingFeaturelist

Retrieve a specific modeling featurelist from a DataRobot project

GetPredictJob

Request information about a predict job

GetPrimeEligibility

Check if model can be approximated with DataRobot Prime

ListModelingFeaturelists

Retrieve all modeling featurelists associated with a project

ListModels

Retrieve all available model information for a DataRobot project

ListRatingTables

Retrieve information about all rating tables.

ListReasonCodesMetadata

Retrieve metadata for reason codes in specified project

RequestFeatureImpact

Request Feature Impact to be computed.

RequestFrozenDatetimeModel

Train a new frozen datetime model with parameters from the specified model

RequestNewModel

Adds a new model of type specified by blueprint to a DataRobot project

SetupProjectFromHDFS

Function to set up a new DataRobot project using datasource on a WebHDFS server

SetupProjectFromMySQL

Function to set up a new DataRobot project using data from MySQL table

GetBlueprintChart

Retrieve a blueprint chart

GetJob

Request information about a job

GetLiftChart

Retrieve lift chart data for a model for a data partition (see DataPartition)

cvMethods

CV methods

datarobot-package

datarobot: DataRobot Predictive Modeling API

RequestNewRatingTableModel

Create a new model from a rating table.

GetPrimeFileFromJobId

Retrieve a specific Prime file from a DataRobot project for corresponding jobId

GetPrimeModel

Retrieve information about specified DataRobot Prime model.

GetReasonCodesInitialization

Retrieve the reason codes initialization for a model.

GetReasonCodesInitializationFromJobId

Retrieve the reason codes initialization for a model using jobId

WaitForAutopilot

This function periodically checks whether Autopilot is finished and returns only after it is.

GetAllLiftCharts

Retrieve lift chart data for a model for all available data partitions (see DataPartition)

GetAllModels

Retrieve all available model information for a DataRobot project

GetFeatureInfo

Details about a feature

GetFeaturelist

Retrieve a specific featurelist from a DataRobot project

GetModelJob

Request information about a single model job

GetModelJobs

Retrieve status of Autopilot modeling jobs that are not complete

GetPrimeFile

Retrieve a specific Prime file from a DataRobot project

GetRatingTable

Retrieve a single rating table.

GetRatingTableFromJobId

Get a rating table from the rating table job metadata.

GetRocCurve

Retrieve ROC curve data for a model for a particular data partition (see DataPartition)

GetReasonCodesMetadata

Retrieve metadata for specified reason codes

GetReasonCodesMetadataFromJobId

Retrieve the reason codes metadata for a model using jobId

JobStatus

Job statuses

GetValidMetrics

Retrieve the valid fitting metrics for a specified project and target

GetWordCloud

Retrieve word cloud data for a model.

ListJobs

Retrieve information about jobs

ListModelFeatures

Returns the list of features (i.e., variables) on which a specified model is based

GetPredictJobs

Function to list all prediction jobs in a project

GetPredictions

Retrieve model predictions from predictJobId

GetTrainingPredictionsFromJobId

Retrieve the training predictions for a model using a job id.

ProjectFromAsyncUrl

Retrieve a project from the project-creation URL

ReformatListOfModels

Convert the list-of-lists output from the server to a list-of-modelObjects format.

RequestPrimeModel

Request training for a DataRobot Prime model using a specified ruleset

GetTransferrableModel

Retrieve imported model info using import id

PredictionDatasetFromAsyncUrl

Retrieve prediction dataset info from the dataset creation URL

PrimeLanguage

Prime Language

RequestTrainingPredictions

Request training predictions for a specific model.

RequestTransferrableModel

Request generation of an transferrable model file for use in an on-premise DataRobot standalone prediction environment. This function can only be used if model export is enabled, and will only be useful if you have an on-premise environment in which to import it. This function does not download the exported file. Use DownloadTransferrableModel for that.

RequestReasonCodes

Request reason codes computation for a specified model and dataset.

SetupProjectFromOracle

Function to set up a new DataRobot project using data from Oracle table

SetupProjectFromPostgreSQL

Function to set up a new DataRobot project using data from PostgreSQL table

UploadPredictionDataset

Function to upload new data to a DataRobot project for predictions

JobType

Job type

ListPredictionDatasets

Retrieve all prediction datasets associated with a project

ListPrimeFiles

List all downloadable code files from DataRobot Prime for the project

PauseQueue

Pause the DataRobot modeling queue

PostgreSQLdrivers

PostgreSQL drivers

ReformatMetrics

replace NULL in $metrics list elements with NA

RenameRatingTable

Renames a rating table to a different name.

RequestPredictions

Request predictions for model from newdata

RequestPredictionsForDataset

Request predictions against a previously uploaded dataset

UploadTransferrableModel

Import a previously exported model for predictions.

WaitForJobToComplete

Wait for specified job to complete

as.data.frame

DataRobot S3 object methods for R's generic as.data.frame function

UpdateTransferrableModel

Update the display name or note for an imported model.

UploadData

Upload a data source.

plot.listOfModels

Plot method for DataRobot S3 objects of class listOfModels

SetTarget

Set the target variable (and by default, start the DataRobot Autopilot)

SetupProject

Function to set up a new DataRobot project

ValidateModel

Validate that model belongs to class 'dataRobotModel' and includes projectId and modelId.

ValidateParameterIn

Ensure a parameter is valid

summary.dataRobotModel

DataRobot S3 object methods for R's generic summary function

GetRulesets

List the rulesets approximating a model generated by DataRobot Prime

ListFeatureInfo

Details about all features for this project

ListFeaturelists

Retrieve all featurelists associated with a project

ListPrimeModels

Retrieve information about all DataRobot Prime models for a DataRobot project

ListRatingTableModels

Retrieve information about all DataRobot models with a rating table.

RequestApproximation

Request an approximation of a model using DataRobot Prime

RequestBlender

Submit a job for creating blender model. Upon success, the new job will be added to the end of the queue.

ScaleoutModelingMode

Scaleout modeling modes

ScoreBacktests

Compute the scores for all available backtests.

UnpauseQueue

Re-start the DataRobot modeling queue

ValidateProject

Get a projectId from a project object.

ViewWebModel

Retrieve a DataRobot web page that displays detailed model information

UpdateProject

Update parameters for an existing project