Adds a surrogate model to an existing a model without uploading an artifact.

Note:

📘

Note: Before calling this function, you must have already added a model using add_model.

Input ParameterTypeDefaultDescription
project_idstrNoneThe unique identifier for the project.
model_idstrNoneA unique identifier for the model. Must be a lowercase string between 2-30 characters containing only alphanumeric characters and underscores. Additionally, it must not start with a numeric character.
deploymentOptional [fdl.core_objects.DeploymentOptions]NoneA DeploymentOptions object containing information about the model deployment.
cache_global_impact_importanceOptional [bool]TrueIf True, global feature impact and global feature importance will be precomputed and cached when the model is registered.
cache_global_pdpsOptional [bool]FalseIf True, global partial dependence plots will be precomputed and cached when the model is registered.
cache_datasetOptional [bool]TrueIf True, histogram information for the baseline dataset will be precomputed and cached when the model is registered.
PROJECT_ID = 'example_project'
MODEL_ID = 'example_model'

client.add_model_surrogate(
    project_id=PROJECT_ID,
    model_id=MODEL_ID
)
Return TypeDescription
strA message confirming that a surrogate model was generated.