resource_versions

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

Overview

Name	resource_versions
Type	Resource
Id	nvidia.private_registry.resource_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)
accuracy_reached	number (float)	Accuracy this recipe reached (wire: accuracyReached)
batch_size	integer (int64)	Batch size this recipe was trained with (wire: batchSize)
created_by_user	string	Id of the user who created this recipe (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 recipe 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	recipe size/memory footprint for inference (wire: memoryFootprint)
number_of_epochs	integer (int64)	Number of epochs this recipe trained (wire: numberOfEpochs)
other_contents	array	(wire: otherContents)
performance	string	Text describing performance of the recipe results
policy	array
quick_start_guide	string	Text with a guide to getting started (wire: quickStartGuide)
release_notes	string	Text describing this release (wire: releaseNotes)
release_type	string	Release type enum for the artifact version in the product lifecycle. (BETA, GA, EA, FEATURE, PRODUCTION, LTSB) (wire: releaseType)
setup	string	Text describing recipe setup
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 recipe in bytes (wire: totalSizeInBytes)

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)
accuracy_reached	number (float)	Accuracy this recipe reached (wire: accuracyReached)
batch_size	integer (int64)	Batch size this recipe was trained with (wire: batchSize)
created_by_user	string	Id of the user who created this recipe (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 recipe 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	recipe size/memory footprint for inference (wire: memoryFootprint)
number_of_epochs	integer (int64)	Number of epochs this recipe trained (wire: numberOfEpochs)
other_contents	array	(wire: otherContents)
performance	string	Text describing performance of the recipe results
policy	array
quick_start_guide	string	Text with a guide to getting started (wire: quickStartGuide)
release_notes	string	Text describing this release (wire: releaseNotes)
release_type	string	Release type enum for the artifact version in the product lifecycle. (BETA, GA, EA, FEATURE, PRODUCTION, LTSB) (wire: releaseType)
setup	string	Text describing recipe setup
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 recipe in bytes (wire: totalSizeInBytes)

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)
accuracy_reached	number (float)	Accuracy this recipe reached (wire: accuracyReached)
batch_size	integer (int64)	Batch size this recipe was trained with (wire: batchSize)
created_by_user	string	Id of the user who created this recipe (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 recipe 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	recipe size/memory footprint for inference (wire: memoryFootprint)
number_of_epochs	integer (int64)	Number of epochs this recipe trained (wire: numberOfEpochs)
other_contents	array	(wire: otherContents)
performance	string	Text describing performance of the recipe results
policy	array
quick_start_guide	string	Text with a guide to getting started (wire: quickStartGuide)
release_notes	string	Text describing this release (wire: releaseNotes)
release_type	string	Release type enum for the artifact version in the product lifecycle. (BETA, GA, EA, FEATURE, PRODUCTION, LTSB) (wire: releaseType)
setup	string	Text describing recipe setup
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 recipe in bytes (wire: totalSizeInBytes)

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)
accuracy_reached	number (float)	Accuracy this recipe reached (wire: accuracyReached)
batch_size	integer (int64)	Batch size this recipe was trained with (wire: batchSize)
created_by_user	string	Id of the user who created this recipe (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 recipe 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	recipe size/memory footprint for inference (wire: memoryFootprint)
number_of_epochs	integer (int64)	Number of epochs this recipe trained (wire: numberOfEpochs)
other_contents	array	(wire: otherContents)
performance	string	Text describing performance of the recipe results
policy	array
quick_start_guide	string	Text with a guide to getting started (wire: quickStartGuide)
release_notes	string	Text describing this release (wire: releaseNotes)
release_type	string	Release type enum for the artifact version in the product lifecycle. (BETA, GA, EA, FEATURE, PRODUCTION, LTSB) (wire: releaseType)
setup	string	Text describing recipe setup
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 recipe in bytes (wire: totalSizeInBytes)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_by_team	select	team_name, recipe_name, version_id		Get recipe version in team
get	select	recipe_name, version_id		Get recipe version in org
list_by_team	select	team_name, recipe_name	page_size, page_number, sort_order, release_type	List recipe versions in team
list	select	recipe_name	page_size, page_number, sort_order, release_type	List recipe versions in org
create_by_team	insert	team_name, recipe_name		Create recipe version in team. Please use the string versionId and not the deprecated numeric id. Semantic Versioning is recommended https:​//semver.org
create	insert	recipe_name		Create recipe 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, recipe_name, version_id	create_zip, set_latest	Update recipe version information in team e.g. upload status
update	update	recipe_name, version_id	create_zip, set_latest	Update recipe version information in org e.g. upload status

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
recipe_name	string (UTF-8)	Recipe 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 recipe version in team

SELECT
id,
version_id,
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,
other_contents,
performance,
policy,
quick_start_guide,
release_notes,
release_type,
setup,
status,
storage_version,
total_file_count,
total_size_in_bytes
FROM nvidia.private_registry.resource_versions
WHERE team_name = '{{ team_name }}' -- required
AND recipe_name = '{{ recipe_name }}' -- required
AND version_id = '{{ version_id }}' -- required
;

get

Get recipe version in org

SELECT
id,
version_id,
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,
other_contents,
performance,
policy,
quick_start_guide,
release_notes,
release_type,
setup,
status,
storage_version,
total_file_count,
total_size_in_bytes
FROM nvidia.private_registry.resource_versions
WHERE recipe_name = '{{ recipe_name }}' -- required
AND version_id = '{{ version_id }}' -- required
;

list_by_team

List recipe versions in team

SELECT
id,
version_id,
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,
other_contents,
performance,
policy,
quick_start_guide,
release_notes,
release_type,
setup,
status,
storage_version,
total_file_count,
total_size_in_bytes
FROM nvidia.private_registry.resource_versions
WHERE team_name = '{{ team_name }}' -- required
AND recipe_name = '{{ recipe_name }}' -- required
AND page_size = '{{ page_size }}'
AND page_number = '{{ page_number }}'
AND sort_order = '{{ sort_order }}'
AND release_type = '{{ release_type }}'
;

list

List recipe versions in org

SELECT
id,
version_id,
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,
other_contents,
performance,
policy,
quick_start_guide,
release_notes,
release_type,
setup,
status,
storage_version,
total_file_count,
total_size_in_bytes
FROM nvidia.private_registry.resource_versions
WHERE recipe_name = '{{ recipe_name }}' -- required
AND page_size = '{{ page_size }}'
AND page_number = '{{ page_number }}'
AND sort_order = '{{ sort_order }}'
AND release_type = '{{ release_type }}'
;

INSERT examples

create_by_team

Create recipe 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.resource_versions (
accuracy_reached,
batch_size,
custom_metrics,
description,
gpu_model,
id,
memory_footprint,
number_of_epochs,
other_contents,
performance,
quick_start_guide,
release_notes,
setup,
version_id,
team_name,
recipe_name
)
SELECT 
{{ accuracy_reached }},
{{ batch_size }},
'{{ custom_metrics }}',
'{{ description }}',
'{{ gpu_model }}',
{{ id }},
'{{ memory_footprint }}',
{{ number_of_epochs }},
'{{ other_contents }}',
'{{ performance }}',
'{{ quick_start_guide }}',
'{{ release_notes }}',
'{{ setup }}',
'{{ version_id }}',
'{{ team_name }}',
'{{ recipe_name }}'
RETURNING
recipe,
recipe_version,
request_status
;

create

Create recipe 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.resource_versions (
accuracy_reached,
batch_size,
custom_metrics,
description,
gpu_model,
id,
memory_footprint,
number_of_epochs,
other_contents,
performance,
quick_start_guide,
release_notes,
setup,
version_id,
recipe_name
)
SELECT 
{{ accuracy_reached }},
{{ batch_size }},
'{{ custom_metrics }}',
'{{ description }}',
'{{ gpu_model }}',
{{ id }},
'{{ memory_footprint }}',
{{ number_of_epochs }},
'{{ other_contents }}',
'{{ performance }}',
'{{ quick_start_guide }}',
'{{ release_notes }}',
'{{ setup }}',
'{{ version_id }}',
'{{ recipe_name }}'
RETURNING
recipe,
recipe_version,
request_status
;

Manifest

# Description fields are for documentation purposes
- name: resource_versions
props:
  - name: team_name
    value: "{{ team_name }}"
    description: Required parameter for the resource_versions resource.
  - name: recipe_name
    value: "{{ recipe_name }}"
    description: Required parameter for the resource_versions resource.
  - name: accuracy_reached
    value: {{ accuracy_reached }}
    description: |
      Accuracy this recipe reached
  - name: batch_size
    value: {{ batch_size }}
    description: |
      Batch size this recipe was trained with
  - name: custom_metrics
    value:
      - attributes: "{{ attributes }}"
        name: "{{ name }}"
  - name: description
    value: "{{ description }}"
    description: |
      Description of the recipe 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: |
      Recipe size/memory footprint for inference
  - name: number_of_epochs
    value: {{ number_of_epochs }}
    description: |
      Number of epochs this recipe trained
  - name: other_contents
    value:
      - key: "{{ key }}"
        value: "{{ value }}"
  - name: performance
    value: "{{ performance }}"
    description: |
      Text describing performance of the recipe results
  - name: quick_start_guide
    value: "{{ quick_start_guide }}"
    description: |
      Text with a guide to getting started
  - name: release_notes
    value: "{{ release_notes }}"
    description: |
      Text describing this release
  - name: setup
    value: "{{ setup }}"
    description: |
      Text describing recipe setup
  - name: version_id
    value: "{{ version_id }}"
    description: |
      Unique version id. Please use this instead of 'id'

UPDATE examples

update_by_team

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

UPDATE nvidia.private_registry.resource_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 }},
other_contents = '{{ other_contents }}',
performance = '{{ performance }}',
quick_start_guide = '{{ quick_start_guide }}',
release_notes = '{{ release_notes }}',
setup = '{{ setup }}',
status = '{{ status }}'
WHERE 
team_name = '{{ team_name }}' --required
AND recipe_name = '{{ recipe_name }}' --required
AND version_id = '{{ version_id }}' --required
AND create-zip = {{ create-zip}}
AND set-latest = {{ set-latest}}
RETURNING
recipe,
recipe_version,
request_status;

update

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

UPDATE nvidia.private_registry.resource_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 }},
other_contents = '{{ other_contents }}',
performance = '{{ performance }}',
quick_start_guide = '{{ quick_start_guide }}',
release_notes = '{{ release_notes }}',
setup = '{{ setup }}',
status = '{{ status }}'
WHERE 
recipe_name = '{{ recipe_name }}' --required
AND version_id = '{{ version_id }}' --required
AND create-zip = {{ create-zip}}
AND set-latest = {{ set-latest}}
RETURNING
recipe,
recipe_version,
request_status;