Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API

Actions364

Overview

The "Update Model Comparison" operation in the Dataiku DSS node allows users to update an existing model comparison within a specified project. This node interacts with the Dataiku DSS API, enabling automation and integration of model comparison management into workflows.

Typical use cases include:

  • Automating updates to model comparisons as part of a machine learning lifecycle.
  • Integrating model comparison updates into CI/CD pipelines for data science projects.
  • Managing model comparison metadata or configurations programmatically without manual intervention.

For example, a user might update the parameters or metadata of a model comparison after retraining models, ensuring that the latest comparison results are reflected in the project.

Properties

Name Meaning
Project Key The unique identifier of the Dataiku DSS project where the model comparison exists.
Request Body A JSON object containing the details and fields to update in the model comparison.

Output

The node outputs the response from the Dataiku DSS API call as JSON. This typically includes the updated model comparison object reflecting the changes made.

If the API returns binary data (not typical for this operation), it would be provided as binary output, but for updating model comparisons, the output is JSON.

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Requires valid API credentials (an API key) for authentication with the Dataiku DSS API.
  • The node expects the Dataiku DSS server URL and user API key to be configured in the credentials.

Troubleshooting

  • Missing Credentials: If the API key credential is not set, the node will throw an error indicating missing credentials.
  • Required Parameters Missing: The node validates required parameters such as Project Key and Model Comparison ID; missing these will cause errors.
  • API Errors: Errors returned by the Dataiku DSS API (e.g., invalid JSON in request body, unauthorized access) will be surfaced as node errors with descriptive messages.
  • Invalid JSON in Request Body: Ensure the JSON provided in the Request Body property is well-formed to avoid parsing errors.

Links and References


This summary focuses on the "Update Model Comparison" operation under the "Model Comparison" resource, describing its purpose, inputs, outputs, dependencies, and common troubleshooting points based on static analysis of the node's source code and provided properties.

Discussion