Dataiku DSSInstall

Overview

This node integrates with the Dataiku DSS API, enabling users to interact programmatically with various Dataiku DSS resources. Specifically, for the Machine Learning - Lab resource and the operation Generate Model Documentation From Default Template, it starts the generation of model documentation using a default template for a specified trained model within a machine learning task.

This operation is useful when you want to automate the creation of standardized documentation for your machine learning models directly from Dataiku DSS, ensuring consistent reporting and easier sharing of model details without manual intervention.

Practical example:
You have a trained ML model in a Dataiku project and want to generate its documentation automatically as part of an automated workflow or pipeline. Using this node operation, you can trigger the generation of the documentation based on the default template provided by Dataiku DSS, which can then be downloaded or further processed.

Properties

These properties are required to specify exactly which model's documentation should be generated using the default template.

Output

The output of this operation is the JSON response from the Dataiku DSS API indicating the status or result of the documentation generation request. It does not directly return the generated document but triggers the generation process on the server side.

If the user wants to download the generated documentation, they would typically use a separate operation (e.g., machineLearningLabModelDocumentationDownload) with the export ID returned after generation.

No binary data is output directly by this operation.

Dependencies

• Requires valid Dataiku DSS API credentials including:
  • The DSS server URL.
  • A user API key with sufficient permissions to access the project and machine learning lab features.
• The node must be configured with these credentials in n8n before execution.

Troubleshooting

• Missing Required Parameters:
  If any of the required parameters (Project Key, Analysis ID, ML Task ID, Model Full ID) are missing, the node will throw an error indicating which parameter is required.

• Authentication Errors:
  Ensure that the API key credential is correctly set up and has the necessary permissions.

• API Endpoint Errors:
  If the Dataiku DSS server is unreachable or returns an error, check network connectivity and server status.

• Operation Not Supported:
  If the operation or resource is incorrectly specified, the node will throw an "Unknown resource" or similar error.

Links and References

• Dataiku DSS API Documentation – Official API reference for all endpoints including Machine Learning Lab operations.
• Dataiku DSS Machine Learning Lab – Overview of ML Lab features in Dataiku DSS.
• Generating Model Documentation – Guide on model documentation generation in Dataiku DSS.

Note: This summary is based solely on static code analysis of the provided source code and property definitions. Runtime behavior and dynamic responses depend on the actual Dataiku DSS environment and API responses.