model_versions

Creates, updates, deletes, gets or lists a model_versions resource.

Overview

Name	`model_versions`
Type	Resource
Id	`nvidia.catalog.model_versions`

Fields

The following fields are returned by SELECT queries:

get_by_team
get
list_by_team
list

Name	Datatype	Description
`id`	`integer (int64)`	Deprecated: Please use versionId instead. Unique ID of the version
`version_id`	`string`	Unique version id. Please use this instead of 'id' (wire: versionId)
`owner_name`	`string`	Name of the user who owns this version (wire: ownerName)
`accuracy_reached`	`number (float)`	Accuracy this model reached (wire: accuracyReached)
`batch_size`	`integer (int64)`	Batch size this model was trained with (wire: batchSize)
`created_by_user`	`string`	Id of the user who created this model (wire: createdByUser)
`created_date`	`string`	Creation date in ISO-8601 format (pattern: <code>\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d.\d+Z</code>) (wire: createdDate)
`custom_metrics`	`array`	(wire: customMetrics)
`description`	`string`	Description of the model version
`gpu_model`	`string`	GPU model and memory (wire: gpuModel)
`is_signed`	`boolean`	Indicates if the version is signed (wire: isSigned)
`malware_scan_date`	`string`	Scan date in ISO-8601 format (pattern: <code>\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d.\d+Z</code>) (wire: malwareScanDate)
`malware_scan_status`	`string`	Malware scan status (NOT_SCANNED, IN_PROGRESS, CLEAN, SUSPICIOUS, FAILED, MALICIOUS) (wire: malwareScanStatus)
`memory_footprint`	`string`	Model size/memory footprint for inference (wire: memoryFootprint)
`number_of_epochs`	`integer (int64)`	Number of epochs this model trained (wire: numberOfEpochs)
`nvcf_container_configuration`	`object`	NVCF container configuration parameters (wire: nvcfContainerConfiguration)
`nvcf_deployment_specification`	`object`	NVCF deployment specification (wire: nvcfDeploymentSpecification)
`other_contents`	`array`	(wire: otherContents)
`policy`	`array`
`release_type`	`string`	Release type enum for the artifact version in the product lifecycle. (BETA, GA, EA, FEATURE, PRODUCTION, LTSB) (wire: releaseType)
`status`	`string`	Version status (UPLOAD_PENDING, UPLOAD_COMPLETE)
`storage_version`	`string`	The storage version i.e. the format the file and their contents are persisted in in object store. Possible values include V1 - for legacy artifact versions with files, V2 - for new artifact versions with blob registry, `` - for artifact versions without any files. (wire: storageVersion)
`total_file_count`	`integer (int64)`	Total file count (wire: totalFileCount)
`total_size_in_bytes`	`integer (int64)`	Total size of the model in bytes (wire: totalSizeInBytes)
`updated_date`	`string`	Updated date in ISO-8601 format (pattern: <code>\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d.\d+Z</code>) (wire: updatedDate)

Name	Datatype	Description
`id`	`integer (int64)`	Deprecated: Please use versionId instead. Unique ID of the version
`version_id`	`string`	Unique version id. Please use this instead of 'id' (wire: versionId)
`owner_name`	`string`	Name of the user who owns this version (wire: ownerName)
`accuracy_reached`	`number (float)`	Accuracy this model reached (wire: accuracyReached)
`batch_size`	`integer (int64)`	Batch size this model was trained with (wire: batchSize)
`created_by_user`	`string`	Id of the user who created this model (wire: createdByUser)
`created_date`	`string`	Creation date in ISO-8601 format (pattern: <code>\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d.\d+Z</code>) (wire: createdDate)
`custom_metrics`	`array`	(wire: customMetrics)
`description`	`string`	Description of the model version
`gpu_model`	`string`	GPU model and memory (wire: gpuModel)
`is_signed`	`boolean`	Indicates if the version is signed (wire: isSigned)
`malware_scan_date`	`string`	Scan date in ISO-8601 format (pattern: <code>\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d.\d+Z</code>) (wire: malwareScanDate)
`malware_scan_status`	`string`	Malware scan status (NOT_SCANNED, IN_PROGRESS, CLEAN, SUSPICIOUS, FAILED, MALICIOUS) (wire: malwareScanStatus)
`memory_footprint`	`string`	Model size/memory footprint for inference (wire: memoryFootprint)
`number_of_epochs`	`integer (int64)`	Number of epochs this model trained (wire: numberOfEpochs)
`nvcf_container_configuration`	`object`	NVCF container configuration parameters (wire: nvcfContainerConfiguration)
`nvcf_deployment_specification`	`object`	NVCF deployment specification (wire: nvcfDeploymentSpecification)
`other_contents`	`array`	(wire: otherContents)
`policy`	`array`
`release_type`	`string`	Release type enum for the artifact version in the product lifecycle. (BETA, GA, EA, FEATURE, PRODUCTION, LTSB) (wire: releaseType)
`status`	`string`	Version status (UPLOAD_PENDING, UPLOAD_COMPLETE)
`storage_version`	`string`	The storage version i.e. the format the file and their contents are persisted in in object store. Possible values include V1 - for legacy artifact versions with files, V2 - for new artifact versions with blob registry, `` - for artifact versions without any files. (wire: storageVersion)
`total_file_count`	`integer (int64)`	Total file count (wire: totalFileCount)
`total_size_in_bytes`	`integer (int64)`	Total size of the model in bytes (wire: totalSizeInBytes)
`updated_date`	`string`	Updated date in ISO-8601 format (pattern: <code>\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d.\d+Z</code>) (wire: updatedDate)

Name	Datatype	Description
`id`	`integer (int64)`	Deprecated: Please use versionId instead. Unique ID of the version
`version_id`	`string`	Unique version id. Please use this instead of 'id' (wire: versionId)
`owner_name`	`string`	Name of the user who owns this version (wire: ownerName)
`accuracy_reached`	`number (float)`	Accuracy this model reached (wire: accuracyReached)
`batch_size`	`integer (int64)`	Batch size this model was trained with (wire: batchSize)
`created_by_user`	`string`	Id of the user who created this model (wire: createdByUser)
`created_date`	`string`	Creation date in ISO-8601 format (pattern: <code>\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d.\d+Z</code>) (wire: createdDate)
`custom_metrics`	`array`	(wire: customMetrics)
`description`	`string`	Description of the model version
`gpu_model`	`string`	GPU model and memory (wire: gpuModel)
`is_signed`	`boolean`	Indicates if the version is signed (wire: isSigned)
`malware_scan_date`	`string`	Scan date in ISO-8601 format (pattern: <code>\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d.\d+Z</code>) (wire: malwareScanDate)
`malware_scan_status`	`string`	Malware scan status (NOT_SCANNED, IN_PROGRESS, CLEAN, SUSPICIOUS, FAILED, MALICIOUS) (wire: malwareScanStatus)
`memory_footprint`	`string`	Model size/memory footprint for inference (wire: memoryFootprint)
`number_of_epochs`	`integer (int64)`	Number of epochs this model trained (wire: numberOfEpochs)
`nvcf_container_configuration`	`object`	NVCF container configuration parameters (wire: nvcfContainerConfiguration)
`nvcf_deployment_specification`	`object`	NVCF deployment specification (wire: nvcfDeploymentSpecification)
`other_contents`	`array`	(wire: otherContents)
`policy`	`array`
`release_type`	`string`	Release type enum for the artifact version in the product lifecycle. (BETA, GA, EA, FEATURE, PRODUCTION, LTSB) (wire: releaseType)
`status`	`string`	Version status (UPLOAD_PENDING, UPLOAD_COMPLETE)
`storage_version`	`string`	The storage version i.e. the format the file and their contents are persisted in in object store. Possible values include V1 - for legacy artifact versions with files, V2 - for new artifact versions with blob registry, `` - for artifact versions without any files. (wire: storageVersion)
`total_file_count`	`integer (int64)`	Total file count (wire: totalFileCount)
`total_size_in_bytes`	`integer (int64)`	Total size of the model in bytes (wire: totalSizeInBytes)
`updated_date`	`string`	Updated date in ISO-8601 format (pattern: <code>\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d.\d+Z</code>) (wire: updatedDate)

Name	Datatype	Description
`id`	`integer (int64)`	Deprecated: Please use versionId instead. Unique ID of the version
`version_id`	`string`	Unique version id. Please use this instead of 'id' (wire: versionId)
`owner_name`	`string`	Name of the user who owns this version (wire: ownerName)
`accuracy_reached`	`number (float)`	Accuracy this model reached (wire: accuracyReached)
`batch_size`	`integer (int64)`	Batch size this model was trained with (wire: batchSize)
`created_by_user`	`string`	Id of the user who created this model (wire: createdByUser)
`created_date`	`string`	Creation date in ISO-8601 format (pattern: <code>\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d.\d+Z</code>) (wire: createdDate)
`custom_metrics`	`array`	(wire: customMetrics)
`description`	`string`	Description of the model version
`gpu_model`	`string`	GPU model and memory (wire: gpuModel)
`is_signed`	`boolean`	Indicates if the version is signed (wire: isSigned)
`malware_scan_date`	`string`	Scan date in ISO-8601 format (pattern: <code>\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d.\d+Z</code>) (wire: malwareScanDate)
`malware_scan_status`	`string`	Malware scan status (NOT_SCANNED, IN_PROGRESS, CLEAN, SUSPICIOUS, FAILED, MALICIOUS) (wire: malwareScanStatus)
`memory_footprint`	`string`	Model size/memory footprint for inference (wire: memoryFootprint)
`number_of_epochs`	`integer (int64)`	Number of epochs this model trained (wire: numberOfEpochs)
`nvcf_container_configuration`	`object`	NVCF container configuration parameters (wire: nvcfContainerConfiguration)
`nvcf_deployment_specification`	`object`	NVCF deployment specification (wire: nvcfDeploymentSpecification)
`other_contents`	`array`	(wire: otherContents)
`policy`	`array`
`release_type`	`string`	Release type enum for the artifact version in the product lifecycle. (BETA, GA, EA, FEATURE, PRODUCTION, LTSB) (wire: releaseType)
`status`	`string`	Version status (UPLOAD_PENDING, UPLOAD_COMPLETE)
`storage_version`	`string`	The storage version i.e. the format the file and their contents are persisted in in object store. Possible values include V1 - for legacy artifact versions with files, V2 - for new artifact versions with blob registry, `` - for artifact versions without any files. (wire: storageVersion)
`total_file_count`	`integer (int64)`	Total file count (wire: totalFileCount)
`total_size_in_bytes`	`integer (int64)`	Total size of the model in bytes (wire: totalSizeInBytes)
`updated_date`	`string`	Updated date in ISO-8601 format (pattern: <code>\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d.\d+Z</code>) (wire: updatedDate)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get_by_team`	`select`	`org_name`, `team_name`, `model_name`, `version_id`		Get model version in team as guest
`get`	`select`	`org_name`, `model_name`, `version_id`		Get model version in org as guest
`list_by_team`	`select`	`org_name`, `team_name`, `model_name`	`release_type`, `page_size`, `page_number`, `sort_order`	List model versions in team as guest
`list`	`select`	`org_name`, `model_name`	`release_type`, `page_size`, `page_number`, `sort_order`	List model versions in org as guest

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`model_name`	`string (UTF-8)`	Model name
`org_name`	`string (UTF-8)`	Organization name
`team_name`	`string (UTF-8)`	Team name
`version_id`	`string (UTF-8)`	Version ID
`page_number`	`string (UTF-8)`	Page number - zero based index
`page_size`	`string (UTF-8)`	Page size
`release_type`	`string (UTF-8)`	Release Type
`sort_order`	`string (UTF-8)`	Sort order

`SELECT` examples

get_by_team
get
list_by_team
list

Get model version in team as guest

SELECT
id,
version_id,
owner_name,
accuracy_reached,
batch_size,
created_by_user,
created_date,
custom_metrics,
description,
gpu_model,
is_signed,
malware_scan_date,
malware_scan_status,
memory_footprint,
number_of_epochs,
nvcf_container_configuration,
nvcf_deployment_specification,
other_contents,
policy,
release_type,
status,
storage_version,
total_file_count,
total_size_in_bytes,
updated_date
FROM nvidia.catalog.model_versions
WHERE org_name = '{{ org_name }}' -- required
AND team_name = '{{ team_name }}' -- required
AND model_name = '{{ model_name }}' -- required
AND version_id = '{{ version_id }}' -- required
;

Get model version in org as guest

SELECT
id,
version_id,
owner_name,
accuracy_reached,
batch_size,
created_by_user,
created_date,
custom_metrics,
description,
gpu_model,
is_signed,
malware_scan_date,
malware_scan_status,
memory_footprint,
number_of_epochs,
nvcf_container_configuration,
nvcf_deployment_specification,
other_contents,
policy,
release_type,
status,
storage_version,
total_file_count,
total_size_in_bytes,
updated_date
FROM nvidia.catalog.model_versions
WHERE org_name = '{{ org_name }}' -- required
AND model_name = '{{ model_name }}' -- required
AND version_id = '{{ version_id }}' -- required
;

List model versions in team as guest

SELECT
id,
version_id,
owner_name,
accuracy_reached,
batch_size,
created_by_user,
created_date,
custom_metrics,
description,
gpu_model,
is_signed,
malware_scan_date,
malware_scan_status,
memory_footprint,
number_of_epochs,
nvcf_container_configuration,
nvcf_deployment_specification,
other_contents,
policy,
release_type,
status,
storage_version,
total_file_count,
total_size_in_bytes,
updated_date
FROM nvidia.catalog.model_versions
WHERE org_name = '{{ org_name }}' -- required
AND team_name = '{{ team_name }}' -- required
AND model_name = '{{ model_name }}' -- required
AND release_type = '{{ release_type }}'
AND page_size = '{{ page_size }}'
AND page_number = '{{ page_number }}'
AND sort_order = '{{ sort_order }}'
;

List model versions in org as guest

SELECT
id,
version_id,
owner_name,
accuracy_reached,
batch_size,
created_by_user,
created_date,
custom_metrics,
description,
gpu_model,
is_signed,
malware_scan_date,
malware_scan_status,
memory_footprint,
number_of_epochs,
nvcf_container_configuration,
nvcf_deployment_specification,
other_contents,
policy,
release_type,
status,
storage_version,
total_file_count,
total_size_in_bytes,
updated_date
FROM nvidia.catalog.model_versions
WHERE org_name = '{{ org_name }}' -- required
AND model_name = '{{ model_name }}' -- required
AND release_type = '{{ release_type }}'
AND page_size = '{{ page_size }}'
AND page_number = '{{ page_number }}'
AND sort_order = '{{ sort_order }}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

Overview

Fields

Methods

Parameters

`SELECT` examples