datarobot (version 2.18.6)

'DataRobot' Predictive Modeling API

Description

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

Copy Link

Version

Install

install.packages('datarobot')

Monthly Downloads

550

Version

2.18.6

License

MIT + file LICENSE

Maintainer

David Chudzicki

Last Published

March 13th, 2024

Functions in datarobot (2.18.6)

CreateDatetimePartitionSpecification

Create a list describing datetime partition parameters

CreateDerivedFeatures

Derived Features

ConnectToDataRobot

Establish a connection to the DataRobot modeling engine

DataPartition

Data Partition methods

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

DataPathFromDataArg

Get the data path.

CreatePrimeCode

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

DeleteAnomalyAssessmentRecord

Delete anomaly assessment record.

CreateRandomPartition

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

DatetimeTrendPlotsStatuses

Datetime trend plots statuses

Delete a specified DataRobot model

DeleteComplianceDocTemplate

Deletes a compliance doc template.

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

DifferencingMethod

Differencing method

CreateFeaturelist

Create a new featurelist in a DataRobot project

DeprecatedHeaderMessage

Handler for Deprecated header in API responses

DownloadComplianceDocumentation

Download compliance documentation (in DOCX format).

DownloadComplianceDocTemplate

Download a compliance doc template (in JSON format).

DeletePredictionExplanations

Function to delete prediction explanations

DeletePredictionExplanationsInitialization

Delete the prediction explanations initialization for a model.

DeletePredictJob

Function to delete one predict job from the DataRobot queue

DeletePredictionDataset

Delete a specified prediction dataset

DownloadPredictionExplanations

Function to download and save prediction explanations rows as csv file

DownloadScoringCode

Download scoring code JAR

DeleteProject

Delete a specified element from the DataRobot project list

DownloadRatingTable

Download a rating table to a CSV.

GetAnomalyAssessmentPredictionsPreview

Retrieve anomaly assessment predictions preview.

GetAnomalyAssessmentExplanations

Retrieve anomaly assessment explanations.

GetAccuracyOverTimePlot

Retrieve Accuracy over Time plot for a model.

GenerateDatetimePartition

Preview the full partitioning determined by a DatetimePartitioningSpecification

DeleteTransferableModel

Delete this imported model.

DownloadPrimeCode

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

DownloadTransferableModel

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

DownloadTrainingPredictions

Download training predictions on a specified data set.

GetAccuracyOverTimePlotPreview

Retrieve Accuracy over Time preview plot for a model.

GetConfusionChart

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

GetDataStoreTables

Get all tables associated with a data store.

DeleteModelJob

Delete a model job from the modeling queue

GetDataStoreSchemas

Get the schemas associated with a data store.

DeleteModelingFeaturelist

Delete a modeling featurelist

GetCrossValidationScores

Get cross validation scores

GetAccuracyOverTimePlotsMetadata

Retrieve Accuracy over Time plots metadata for a model.

GetDeploymentAccuracy

Retrieve accuracy statistics for a deployment.

GetDeploymentAccuracyOverTime

Retrieves accuracy statistics over time on given metrics for a deployment.

GetDatetimeModelFromJobId

Retrieve a new or updated datetime model defined by modelJobId

GetDatetimeModel

Retrieve the details of a specified datetime model.

DownloadSeriesAccuracy

Download the series accuracy for a model, computing it if not already computed.

GetDataStore

Returns information about a particular data store.

GetBlueprintChart

Retrieve a blueprint chart

GetBlueprint

Retrieve a blueprint

CrossValidateModel

Run cross validation on a model.

DownloadTimeSeriesFeatureDerivationLog

Download the time series feature derivation log as a text file.

GetDataSource

Returns information about a particular data source.

CreateUserPartition

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

GetFeatureAssociationMatrix

Get pairwise feature association statistics for a project's informative features

GetDatetimePartition

Retrieve the DatetimePartitioning from a project

DatetimeTrendPlotsResolutions

Datetime trend plots resolutions

GetComplianceDocTemplate

Get a compliance doc template.

GetCalendar

Retrieve a calendar

GetBlueprintDocumentation

Get documentation for tasks used in the blueprint

GetCalendarFromProject

Retrieve the calendar for a particular project.

GetFeatureAssociationMatrixDetails

Get a sample of the actual values used to measure the association between a pair of features.

DataSubset

Data subset for training predictions

GetDeploymentSettings

Retrieves all settings for a deployed model.

GetModel

Retrieve the details of a specified model

DeploymentAccuracyMetric

Deployment accuracy metrics

DeploymentServiceHealthMetric

Deployment service health metrics

GetModelBlueprintChart

Retrieve a model blueprint chart

GetDriver

Returns information about a particular driver.

GetPredictionExplanationsRowsAsDataFrame

Retrieve all prediction explanations rows and return them as a data frame

GetPredictions

Retrieve model predictions

FeatureFromAsyncUrl

Retrieve a feature from the creation URL

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).

GetPrimeModelFromJobId

Retrieve information about specified DataRobot Prime model using corresponding jobId.

GetPrimeFile

Retrieve a specific Prime file from a DataRobot project

GetMultiSeriesProperties

Retrieve time series properties for a potential multiseries datetime partition column

GetModelingFeaturelist

Retrieve a specific modeling featurelist from a DataRobot project

GetProject

Retrieve details about a specified DataRobot modeling project

GetPrimeEligibility

Check if model can be approximated with DataRobot Prime

GetDeploymentDriftTrackingSettings

Get drift tracking settings for a deployment.

GetJob

Request information about a job

GetPredictionExplanations

Get prediction explanations

GetFeatureImpactForModel

Retrieve completed Feature Impact results given a model

GetFeatureImpactForJobId

Retrieve completed Feature Impact results given a job ID

GetFeaturelist

Retrieve a specific featurelist from a DataRobot project

GetDeploymentAssociationId

Deployment Association ID

GetGeneralizedInsight

An internal function to help fetch insights.

GetFeatureInfo

Details about a feature

GetPredictionExplanationsInitialization

Retrieve the prediction explanations initialization for a model.

GetBlenderModel

Retrieve the details of a specified blender model

GetBlenderModelFromJobId

Retrieve a new or updated blender model defined by modelJobId

GetLiftChart

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

GetParetoFront

Pareto Front data for a Eureqa model

GetMissingValuesReport

Get a report on missing values for the model.

GetServerDataInRows

Handle server side pagination.

GetPredictJob

Request information about a predict job

GetPredictionExplanationsRows

Retrieve all prediction explanations rows

GetPredictionExplanationsMetadataFromJobId

Retrieve the prediction explanations metadata for a model using jobId

GetRatingTableModelFromJobId

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

GetRecommendedModel

Retrieve the model object that DataRobot recommends for your project.

GetRocCurve

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

GetRulesets

List the rulesets approximating a model generated by DataRobot Prime

GetRatingTable

Retrieve a single rating table.

GetProjectStatus

Request Autopilot status for a specified DataRobot project

IsBlenderEligible

Check whether individual models can be blended together

InitializeAnomalyAssessment

Request anomaly assessment insight computation on the specified subset.

GetDeployment

Get information on a particular deployment.

GetModelBlueprintDocumentation

Get documentation for tasks used in the model blueprint

GetFeatureHistogram

Retrieve histogram plot data for a specific feature

GetFeatureImpact

Get the feature impact for a model, requesting the feature impact if it is not already available.

IsId

Checks if an id is a valid DataRobot ID (24 character string)

GetModelCapabilities

Get supported capabilities for a model, e.g., whether it has a word cloud.

GetModelParameters

Retrieve model parameters

GetTrainingPredictionDataFrame

Simplify the training prediction rows into a tidy format dataframe.

GetDeploymentServiceStatsOverTime

Retrieves service health statistics over time on given metrics for a deployment.

GetFrozenModelFromJobId

Retrieve a frozen model defined by modelJobId

GetModelFromJobId

Retrieve a new or updated model defined by modelJobId

GetFrozenModel

Retrieve the details of a specified frozen model

GetDeploymentServiceStats

Retrieve service health statistics for a deployment.

GetModelRecommendation

Retrieve a model recommendation from DataRobot for your project.

IsParameterIn

Check if a parameter is in a list of possibilities.

GetModelJob

Request information about a single model job

GetPredictJobs

Function to list all prediction jobs in a project

ListAnomalyAssessmentRecords

Retrieve anomaly assessment records.

GetPredictionExplanationsInitializationFromJobId

Retrieve the prediction explanations initialization for a model using jobId

GetPredictionDataset

Retrieve data on a prediction dataset

ListBlueprints

Retrieve the list of available blueprints for a project

GetPredictionExplanationsMetadata

Retrieve metadata for specified prediction explanations

ListResidualsCharts

Retrieve residuals chart data for a model for all available data partitions (see DataPartition). This chart is only available for regression models that are not time-aware.

ListModelRecommendations

Retrieve information about model recommendation made by DataRobot for your project.

ListConfusionCharts

Returns all available confusion charts for the model.

ListDataSources

Returns a dataframe with information on available data sources.

ListModelJobs

Retrieve status of Autopilot modeling jobs that are not complete

ListRatingTables

Retrieve information about all rating tables.

ListPrimeFiles

List all downloadable code files from DataRobot Prime for the project

ListPrimeModels

Retrieve information about all DataRobot Prime models for a DataRobot project

GetRedirectFromResponse

Helper method to retrieve the redirect from the response headers to any request that puts or queries for a DR job. Use this in your job-related methods to simplify testing.

GetTimeSeriesFeatureDerivationLog

Retrieve the time series feature derivation log content

GetPrimeFileFromJobId

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

GetPrimeModel

Retrieve information about specified DataRobot Prime model.

GetRatingTableFromJobId

Get a rating table from the rating table job metadata.

JobType

Job type

GetResidualsChart

Retrieve residuals chart data for a model for a data partition (see DataPartition).

JobStatus

Job statuses

GetSeriesAccuracy

Get the computed series accuracy for a model, computing it if not already computed.

GetSeriesAccuracyForModel

Get the series accuracy associated with a particular model.

ListDrivers

Returns a dataframe with information on available drivers.

ListFeatureInfo

Details about all features for this project

ListModelingFeaturelists

Retrieve all modeling featurelists associated with a project

ListCalendars

List all available calendars.

ListJobs

Retrieve information about jobs

ListComplianceDocTemplates

Retrieve information about all compliance doc templates.

ListFeaturelists

Retrieve all featurelists associated with a project

ListPredictionServers

List all available prediction servers.

ListPredictions

Fetch all computed predictions for a project.

GetRatingTableModel

Retrieve information about specified model with a rating table.

GetTrainingPredictionsFromJobId

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

GetTrainingPredictionsForModel

Get training predictions for a particular model.

ModelReplacementReason

Model replacement reason

GetTuningParameters

Retrieve data on tuning parameters for a particular model.

ListDataStores

Returns a dataframe with information on available data stores.

GetTransferableModel

Retrieve imported model info using import id

Retrieve all available model information for a DataRobot project

ListRatingTableModels

Retrieve information about all DataRobot models with a rating table.

ListProjects

Retrieve a list of all DataRobot projects

PauseQueue

Pause the DataRobot modeling queue

RequestMultiSeriesDetection

Format a multiseries.

MulticlassDeploymentAccuracyMetric

Accuracy metrics for multiclass deployments

GetWordCloud

Retrieve word cloud data for a model.

ReformatMetrics

replace NULL in $metrics list elements with NA

GetValidMetrics

Retrieve the valid fitting metrics for a specified project and target

GetTrainingPredictions

Retrieve training predictions on a specified data set.

Predict

Retrieve model predictions

RegressionDeploymentAccuracyMetric

Accuracy metrics for regression deployments

RenameRatingTable

Renames a rating table to a different name.

ReplaceDeployedModel

Replace a model in a deployment with another model.

ListTransferableModels

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

ListModelFeatures

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

ListSharingAccess

List information about which users have what kinds of access to a shared object.

ListRocCurves

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

ProjectFromJobResponse

Retrieve a project from the job response, which has a project-creation URL

MakeDataRobotRequest

Make a HTTP request

ListLiftCharts

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

RequestTrainingPredictions

Request training predictions for a specific model.

RequestTransferableModel

Request creation of a transferable model

RequestNewDatetimeModel

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

ListDeployments

List all current model deployments.

RequestSampleSizeUpdate

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

ListPredictionDatasets

Retrieve all prediction datasets associated with a project

RequestSeriesAccuracy

Compute the series accuracy for a model.

RequestFeatureImpact

Request Feature Impact to be computed.

RequestCrossSeriesDetection

Format a cross series with group by columns.

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 - modeling jobs in queue would not be affected but new jobs would not be added to queue by halted autopilot.

StarModel

Star a model.

PeriodicityTimeUnits

Periodicity time units

PeriodicityMaxTimeStep

Periodicity max time step

ListPredictionExplanationsMetadata

Retrieve metadata for prediction explanations in specified project

RequestNewModel

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

ProjectStage

Project stage

RequestPredictions

Request predictions from a model against a previously uploaded dataset

RequestBlender

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

RequestApproximation

Request an approximation of a model using DataRobot Prime

RequestNewRatingTableModel

Create a new model from a rating table.

UpdateComplianceDocTemplate

Update the name or sections of an existing doc template.

UpdateAccess

Update access to a particular object.

Ensure a parameter is valid

TreatAsExponential

Treat as exponential

RequestPrimeModel

Request training for a DataRobot Prime model using a specified ruleset

SeriesAggregationType

Series aggregation type

SegmentAnalysisAttribute

Segment analysis attributes

ViewWebProject

Retrieve a DataRobot web page that displays detailed project information

ValidatePartition

Checks if a partition is valid.

WaitForAutopilot

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

ListTrainingPredictions

Retrieve information about all training prediction datasets in a project.

ListStarredModels

List all the starred models in a project.

PredictionDatasetFromAsyncUrl

Retrieve prediction dataset info from the dataset creation URL

RunInteractiveTuning

Run an interactive model tuning session.

SetupProjectFromHDFS

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

Share a shareable object with a particular user.

TryingToSubmitNull

Checks to see if we are trying to submit `NULL` as a value.

cvMethods

CV methods

ScoreBacktests

Compute the scores for all available backtests.

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.

StartProject

Start a project, set the target, and run autopilot.

UpdateModelingFeaturelist

Update a modeling featurelist

datarobot-package

datarobot: 'DataRobot' Predictive Modeling API

SourceType

Source types

RFC3339DateTimeFormat

RFC 3339 datetime format

Re-start the DataRobot modeling queue

UpdateProject

Update parameters for an existing project

ValidateMultiSeriesProperties

Validate that the multiseries properties indicate a successful multiseries setup.

ValidateModel

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

ValidateCalendar

Get a calendar id from a calendar object.

WaitForJobToComplete

Wait for specified job to complete

UnstarModel

Unstar a model.

ValidateActuals

Validate that the actuals are a dataframe and contain required columns.

RecommendedModelType

Recommended model type values

as.dataRobotFeatureInfo

Information on a data feature.

reorderColumns

Reorder the columns in a data.frame

summary.dataRobotModel

DataRobot S3 object methods for R's generic summary function

as.dataRobotDeploymentAssociationIdSettings

Association ID settings for a deployment.

transformRFC3339Period

The DataRobot Monitoring APIs return dates formatted as RFC 3339 strings. This is the same as ISO 8601. Specifically, 'T' is the date/time separator and 'Z' is used to denote UTC. Fractional seconds are returned. e.g. 2020-01-01T05:00:00.000000Z

SubmitActuals

Submit actuals for processing.

SetPredictionThreshold

Set a custom prediction threshold for binary classification models.

validateReportingPeriodTime

Helper function for validating reporting period objects used by the deployment monitoring functions. See GetDeploymentServiceStats, GetDeploymentAccuracy, GetDeploymentServiceStatsOverTime, and GetDeploymentAccuracyOverTime.

RequestFrozenDatetimeModel

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

RequestPredictionExplanations

Request prediction explanations computation for a specified model and dataset.

SetTarget

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

RequestPredictionExplanationsInitialization

Request prediction explanations initialization for specified model

StartTuningSession

Create a function to initiate hyperparameter tuning for a particular model.

Stringify

Convert a function into a single string for DataRobot

SetupProject

Function to set up a new DataRobot project

ToggleStarForModel

Star a model if it is unstarred, otherwise unstar the model.

SetupProjectFromDataSource

Create a project from a data source.

TimeUnits

Time units

RequestFrozenModel

Train a new frozen model with parameters from specified model

as.data.frame

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

predict.dataRobotModel

Retrieve model predictions using R's default S3 predict method.

TargetType

Target Type modes

UploadPredictionDatasetFromDataSource

Upload a prediction dataset from a data source.

TargetLeakageType

Target leakage report values

plot.listOfModels

Plot method for DataRobot S3 objects of class listOfModels

UpdateFeaturelist

Update a featurelist

UpdateTransferableModel

Update the display name or note for an imported model.

UploadTransferableModel

Import a previously exported model for predictions.

UpdateDeploymentSettings

Updates configuration settings for a deployed model.

formatRFC3339Timestamp

ViewWebModel

Retrieve a DataRobot web page that displays detailed model information

parseRFC3339Timestamp

summary.listOfDataRobotTuningParameters

Summarize the list of tuning parameters available for a model.

VariableTransformTypes

Types of variable transformations

tidyServiceOverTimeObject

Tidies a ServiceOverTime response object for use in a DF

ValidateReplaceDeployedModel

Validate a potential deployment model replacement.

ValidateProject

Get a projectId from a project object.

UploadComplianceDocTemplate

Upload a compliance doc template.

as.dataRobotProjectShort

Return value for SetupProject() and others

as.dataRobotMultiSeriesProperties

Return value for GetMultiSeriesProperties() and others

TestDataStore

Test the database connection to the data store.

UpdateDataStore

Update a data store.

UploadData

Upload a data source.

UpdateDeploymentDriftTrackingSettings

Update drift tracking settings for a deployment.

UploadPredictionDataset

Function to upload new data to a DataRobot project for predictions

BatchFeaturesTypeTransform

Create new features by transforming the type of an existing ones.

ApplySchema

Apply a schema to DataRobot objects (lists, frames)

CleanServerData

Reformat paginated data returned from the server.

CheckUrl

Make sure the path is a reasonable URL

ClassificationDeploymentAccuracyMetric

Accuracy metrics for classification deployments

CloneProject

Clone a project

AddEureqaSolution

Add a Eureqa solution to the list of models for the project.

BlueprintChartToGraphviz

Convert a blueprint chart into graphviz DOT format

ComputeDatetimeTrendPlots

Compute datetime trend plots for datetime partitioned model.

CreateDataSource

Create a data source.

CreateBacktestSpecification

Create a list describing backtest parameters

CreateDeployment

Create a deployment.

ConstructDurationString

Construct a valid string representing a duration in accordance with ISO8601

CreateCalendar

Create a calendar from an uploaded CSV.

CreateDataStore

Create a data store.

CreateComplianceDocumentation

Create compliance documentation from a model.