model_versions

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

Overview

Name	model_versions
Type	Resource
Id	nvidia.private_registry.model_versions

Fields

The following fields are returned by SELECT queries:

get_by_team

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)

get

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)

list_by_team

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)

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)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_by_team	select	team_name, model_name, version_id		Get model version in team
get	select	model_name, version_id		Get model version in org
list_by_team	select	team_name, model_name	release_type, page_size, page_number, sort_order	List model versions in team
list	select	model_name	release_type, page_size, page_number, sort_order	List model versions in org
create_by_team	insert	team_name, model_name		Create model version in team. Please use the string versionId and not the deprecated numeric id. Semantic Versioning is recommended https:​//semver.org
create	insert	model_name		Create a new and empty model version in org. Please use the string versionId and not the deprecated numeric id. Semantic Versioning is recommended https:​//semver.org
update_by_team	update	team_name, model_name, version_id	create_zip, set_latest	Update model version information in team e.g. upload status
update	update	model_name, version_id	create_zip, set_latest	Update model version information in org e.g. upload status
stash	exec	artifact_name, version_id		Stash artifact version information in org during upload paused state
stash_by_team	exec	team_name, artifact_name, version_id		Stash artifact version information in team in model version upload paused state

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
artifact_name	string (UTF-8)	Artifact name
model_name	string (UTF-8)	Model name
team_name	string (UTF-8)	Team name
version_id	string (UTF-8)	Version ID
create_zip	boolean	Create zip of version content
page_number	string (UTF-8)	Page number - zero based index
page_size	string (UTF-8)	Page size
release_type	string (UTF-8)	Release Type
set_latest	boolean	Set version to latest
sort_order	string (UTF-8)	Sort order

SELECT examples

get_by_team

Get model version in team

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.private_registry.model_versions
WHERE team_name = '{{ team_name }}' -- required
AND model_name = '{{ model_name }}' -- required
AND version_id = '{{ version_id }}' -- required
;

get

Get model version in org

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.private_registry.model_versions
WHERE model_name = '{{ model_name }}' -- required
AND version_id = '{{ version_id }}' -- required
;

list_by_team

List model versions in team

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.private_registry.model_versions
WHERE 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

List model versions in org

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.private_registry.model_versions
WHERE 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 }}'
;

INSERT examples

create_by_team

Create model version in team. Please use the string versionId and not the deprecated numeric id. Semantic Versioning is recommended https://semver.org

INSERT INTO nvidia.private_registry.model_versions (
accuracy_reached,
batch_size,
custom_metrics,
description,
gpu_model,
id,
memory_footprint,
number_of_epochs,
nvcf_container_configuration,
nvcf_deployment_specification,
other_contents,
owner_name,
version_id,
team_name,
model_name
)
SELECT 
{{ accuracy_reached }},
{{ batch_size }},
'{{ custom_metrics }}',
'{{ description }}',
'{{ gpu_model }}',
{{ id }},
'{{ memory_footprint }}',
{{ number_of_epochs }},
'{{ nvcf_container_configuration }}',
'{{ nvcf_deployment_specification }}',
'{{ other_contents }}',
'{{ owner_name }}',
'{{ version_id }}',
'{{ team_name }}',
'{{ model_name }}'
RETURNING
model,
model_version,
request_status
;

create

Create a new and empty model version in org. Please use the string versionId and not the deprecated numeric id. Semantic Versioning is recommended https://semver.org

INSERT INTO nvidia.private_registry.model_versions (
accuracy_reached,
batch_size,
custom_metrics,
description,
gpu_model,
id,
memory_footprint,
number_of_epochs,
nvcf_container_configuration,
nvcf_deployment_specification,
other_contents,
owner_name,
version_id,
model_name
)
SELECT 
{{ accuracy_reached }},
{{ batch_size }},
'{{ custom_metrics }}',
'{{ description }}',
'{{ gpu_model }}',
{{ id }},
'{{ memory_footprint }}',
{{ number_of_epochs }},
'{{ nvcf_container_configuration }}',
'{{ nvcf_deployment_specification }}',
'{{ other_contents }}',
'{{ owner_name }}',
'{{ version_id }}',
'{{ model_name }}'
RETURNING
model,
model_version,
request_status
;

Manifest

# Description fields are for documentation purposes
- name: model_versions
props:
  - name: team_name
    value: "{{ team_name }}"
    description: Required parameter for the model_versions resource.
  - name: model_name
    value: "{{ model_name }}"
    description: Required parameter for the model_versions resource.
  - name: accuracy_reached
    value: {{ accuracy_reached }}
    description: |
      Accuracy this model reached
  - name: batch_size
    value: {{ batch_size }}
    description: |
      Batch size this model was trained with
  - name: custom_metrics
    value:
      - attributes: "{{ attributes }}"
        name: "{{ name }}"
  - name: description
    value: "{{ description }}"
    description: |
      Description of the model version
  - name: gpu_model
    value: "{{ gpu_model }}"
    description: |
      GPU model and memory
  - name: id
    value: {{ id }}
    description: |
      Deprecated: Please use version instead. Unique ID of the version
  - name: memory_footprint
    value: "{{ memory_footprint }}"
    description: |
      Model size/memory footprint for inference
  - name: number_of_epochs
    value: {{ number_of_epochs }}
    description: |
      Number of epochs this model trained
  - name: nvcf_container_configuration
    description: |
      NVCF container configuration parameters
    value:
      apiBodyFormat: "{{ apiBodyFormat }}"
      containerArgs: "{{ containerArgs }}"
      containerEnvironment:
        - key: "{{ key }}"
          value: "{{ value }}"
      containerImage: "{{ containerImage }}"
      healthUri: "{{ healthUri }}"
      inferencePort: "{{ inferencePort }}"
      inferenceUrl: "{{ inferenceUrl }}"
      models:
        - name: "{{ name }}"
          uri: "{{ uri }}"
          version: "{{ version }}"
  - name: nvcf_deployment_specification
    description: |
      NVCF deployment specification
    value:
      gpuCount: {{ gpuCount }}
      gpuType: "{{ gpuType }}"
      instanceType: "{{ instanceType }}"
      maxConcurrency: {{ maxConcurrency }}
  - name: other_contents
    value:
      - key: "{{ key }}"
        value: "{{ value }}"
  - name: owner_name
    value: "{{ owner_name }}"
    description: |
      Name of the user who owns this version
  - name: version_id
    value: "{{ version_id }}"
    description: |
      Unique version id. Please use this instead of 'id'

UPDATE examples

update_by_team

Update model version information in team e.g. upload status

UPDATE nvidia.private_registry.model_versions
SET 
accuracy_reached = {{ accuracy_reached }},
batch_size = {{ batch_size }},
custom_metrics = '{{ custom_metrics }}',
description = '{{ description }}',
gpu_model = '{{ gpu_model }}',
memory_footprint = '{{ memory_footprint }}',
number_of_epochs = {{ number_of_epochs }},
nvcf_container_configuration = '{{ nvcf_container_configuration }}',
nvcf_deployment_specification = '{{ nvcf_deployment_specification }}',
other_contents = '{{ other_contents }}',
owner_name = '{{ owner_name }}',
status = '{{ status }}'
WHERE 
team_name = '{{ team_name }}' --required
AND model_name = '{{ model_name }}' --required
AND version_id = '{{ version_id }}' --required
AND create-zip = {{ create-zip}}
AND set-latest = {{ set-latest}}
RETURNING
model,
model_version,
request_status;

update

Update model version information in org e.g. upload status

UPDATE nvidia.private_registry.model_versions
SET 
accuracy_reached = {{ accuracy_reached }},
batch_size = {{ batch_size }},
custom_metrics = '{{ custom_metrics }}',
description = '{{ description }}',
gpu_model = '{{ gpu_model }}',
memory_footprint = '{{ memory_footprint }}',
number_of_epochs = {{ number_of_epochs }},
nvcf_container_configuration = '{{ nvcf_container_configuration }}',
nvcf_deployment_specification = '{{ nvcf_deployment_specification }}',
other_contents = '{{ other_contents }}',
owner_name = '{{ owner_name }}',
status = '{{ status }}'
WHERE 
model_name = '{{ model_name }}' --required
AND version_id = '{{ version_id }}' --required
AND create-zip = {{ create-zip}}
AND set-latest = {{ set-latest}}
RETURNING
model,
model_version,
request_status;

Lifecycle Methods

EXEC variables use wire (API) names.

stash

Stash artifact version information in org during upload paused state

EXEC nvidia.private_registry.model_versions.stash 
@artifact_name='{{ artifact_name }}' --required, 
@version_id='{{ version_id }}' --required
;

stash_by_team

Stash artifact version information in team in model version upload paused state

EXEC nvidia.private_registry.model_versions.stash_by_team 
@team_name='{{ team_name }}' --required, 
@artifact_name='{{ artifact_name }}' --required, 
@version_id='{{ version_id }}' --required
;