client.models.edit_model_metadata
Edit a model's metadata after it is deployed
client.models.edit_model_metadata(self, model_id, model_version, long_description=None, technical_details=None, performance_summary=None, performance_metrics=None, input_details=None, output_details=None)
Edit metadata of deployed model version.
Parameters
Parameter | Type | Description | Example |
---|---|---|---|
model_id | str | Model identifier of model to edit | 'kp3qcrq0ee' |
model_version | str | Model version of model to edit | '0.0.1' |
long_description | str | Description to appear on model biography page | "Long Description" |
technical_details | str | Technical details to appear on model biography page. Markdown is accepted | "Technical Details " |
performance_summary | str | Description providing model performance to appear on model biography page | "Performance Summary " |
performance_metrics | List | List of arrays describing model performance statistics | [ { "label": "Accuracy", "category": "numeric", "type": "percentage", "description": "The average of the classification accuracies across all classes.", "order": 1, "value": 0.96 } ] |
input_details | List | [ { "name": "input", "acceptedMediaTypes": "application/json", "maximumSize": 1000000, "description": "Default input data" } ] | |
output_details | List | [ { "name": "results.json", "mediaType": "application/json", "maximumSize": 1000000, "description": "Default output data" } ] |
Returns
{
"model_data": {
"version": "0.0.1",
"createdAt": "2022-08-16T01:10:52.821+00:00",
"updatedAt": "2022-08-16T01:10:53.498+00:00",
"inputValidationSchema": "",
"timeout": {
"status": 60000,
"run": 60000
},
"requirement": {
"requirementId": 1
},
"containerImage": {
"uploadStatus": "IN_PROGRESS",
"loadStatus": "IN_PROGRESS",
"uploadPercentage": 0,
"loadPercentage": 0,
"containerImageSize": 0,
"repositoryName": "thjg0zuntf"
},
"inputs": [
{
"name": "input",
"acceptedMediaTypes": "application/json",
"maximumSize": 1000000,
"description": "Default input data"
}
],
"outputs": [
{
"name": "results.json",
"mediaType": "application/json",
"maximumSize": 1000000,
"description": "Default output data"
}
],
"statistics": [],
"isActive": false,
"longDescription": "Long Description",
"technicalDetails": "Techincal Details",
"isAvailable": true,
"status": "partial",
"performanceSummary": "Performance summary",
"model": {
"modelId": "thjg0zuntf",
"latestVersion": "0.0.1",
"latestActiveVersion": "",
"versions": [
"0.0.1"
],
"author": "Integration",
"name": "Echo Model",
"description": "Short Description",
"permalink": "thjg0zuntf-integration-echo-model",
"features": [],
"isActive": false,
"isRecommended": false,
"isCommercial": false,
"tags": [],
"createdByEmail": "[email protected]",
"createdByFullName": "First Last",
"visibility": {
"scope": "PRIVATE"
}
},
"processing": {
"minimumParallelCapacity": 0,
"maximumParallelCapacity": 1
},
"originSidecar": false
},
"container_url": "https://modzy-instance.app.modzy.com/models/thjg0zuntf/0.0.1"
}
Examples
model_info = {
"technicalDetails": {
"inputs": [
{
"name": "input",
"acceptedMediaTypes": "text/plain",
"maximumSize": 5000000,
"description": "Input description"
}
],
"outputs": [
{
"name": "results.json",
"mediaType": "application/json",
"maximumSize": 1000000,
"description": "Output description"
}
],
}
}
model_data = client.models.edit_model_metadata(
model_id="kp3qcrq0eel",
model_version="0.0.1",
long_description="This model returns the same text passed through as input, similar to an 'echo.'",
technical_details="This section can include any technical information abot your model. Include information about how your model was trained, any underlying architecture details, or other pertinant information an end-user would benefit from learning.",
performance_summary="This is the performance summary.",
input_details=model_info["technicalDetails"]["inputs"],
output_details=model_info["technicalDetails"]["outputs"],
)
Updated 4 months ago