API Methods under "model" category

Methods:

---

POSTgetTrainingConfigOptions

Retrieves the full initial description of the model training configuration options available for the specified project. The configuration options available are determined by the use case associated with the specified project. Refer to the [Use Case Documentation]({USE_CASES_URL}) for more information on use cases and use case-specific configuration options.

GETdescribeTrainTestDataSplitFeatureGroup

Get the train and test data split for a trained model by its unique identifier. This is only supported for models with custom algorithms.

GETdescribeTrainTestDataSplitFeatureGroupVersion

Get the train and test data split for a trained model by model version. This is only supported for models with custom algorithms.

POSTcreateTrainTestDataSplitFeatureGroup

Get the train and test data split without training the model. Only supported for models with custom algorithms.

POSTtrainModel

Create a new model and start its training in the given project.

POSTcreateModelFromPython

Initializes a new Model from user-provided Python code. If a list of input feature groups is supplied, they will be provided as arguments to the train and predict functions with the materialized feature groups for those input feature groups.

GETlistModels

Retrieves the list of models in the specified project.

GETdescribeModel

Retrieves a full description of the specified model.

PATCHrenameModel

Renames a model

POSTupdatePythonModel

Updates an existing Python Model using user-provided Python code. If a list of input feature groups is supplied, they will be provided as arguments to the `train` and `predict` functions with the materialized feature groups for those input feature groups.

POSTupdatePythonModelZip

Updates an existing Python Model using a provided zip file. If a list of input feature groups are supplied, they will be provided as arguments to the train and predict functions with the materialized feature groups for those input feature groups.

POSTupdatePythonModelGit

Updates an existing Python model using an existing Git application connector. If a list of input feature groups are supplied, these will be provided as arguments to the train and predict functions with the materialized feature groups for those input feature groups.

PATCHsetModelTrainingConfig

Edits the default model training config

POSTsetModelObjective

Sets the best model for all model instances of the model based on the specified metric, and updates the training configuration to use the specified metric for any future model versions.

PATCHsetModelPredictionParams

Sets the model prediction config for the model

GETgetModelMetrics

Retrieves metrics for all the algorithms trained in this model version.

GETgetFeatureGroupSchemasForModelVersion

Gets the schema (including feature mappings) for all feature groups used in the model version.

GETlistModelVersions

Retrieves a list of versions for a given model.

POSTretrainModel

Retrains the specified model, with an option to choose the deployments to which the retraining will be deployed.

DELETEdeleteModel

Deletes the specified model and all its versions. Models which are currently used in deployments cannot be deleted.

DELETEdeleteModelVersion

Deletes the specified model version. Model versions which are currently used in deployments cannot be deleted.

POSTexportModelArtifactAsFeatureGroup

Exports metric artifact data for a model as a feature group.

GETdescribeModelVersion

Retrieves a full description of the specified model version.

GETgetFeatureImportanceByModelVersion

Gets the feature importance calculated by various methods for the model.

GETgetTrainingDataLogs

Retrieves the data preparation logs during model training.

POSTsetDefaultModelAlgorithm

Sets the model's algorithm to default for all new deployments

GETgetTrainingLogs

Returns training logs for the model.

POSTgetCustomTrainFunctionInfo

Returns information about how to call the custom train function.

POSTexportCustomModelVersion

Bundle custom model artifacts to a zip file, and export to the specified location.

GETdescribeModelArtifactsExport

Get the description and status of the model artifacts export.

GETlistModelArtifactsExports

List all the model artifacts exports.