recipe_versions

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

Overview

Name	recipe_versions
Type	Resource
Id	nvidia.catalog.recipe_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	org_name, team_name, recipe_name, version_id		Get recipe version in team as guest
get	select	org_name, recipe_name, version_id		Get recipe version in org as guest
list_by_team	select	org_name, team_name, recipe_name	page_size, page_number, sort_order, release_type	List recipe versions in team as guest
list	select	org_name, recipe_name	page_size, page_number, sort_order, release_type	List recipe 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
org_name	string (UTF-8)	Organization name
recipe_name	string (UTF-8)	Recipe 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 recipe version in team as guest

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.catalog.recipe_versions
WHERE org_name = '{{ org_name }}' -- required
AND team_name = '{{ team_name }}' -- required
AND recipe_name = '{{ recipe_name }}' -- required
AND version_id = '{{ version_id }}' -- required
;

get

Get recipe version in org as guest

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.catalog.recipe_versions
WHERE org_name = '{{ org_name }}' -- required
AND recipe_name = '{{ recipe_name }}' -- required
AND version_id = '{{ version_id }}' -- required
;

list_by_team

List recipe versions in team as guest

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.catalog.recipe_versions
WHERE org_name = '{{ org_name }}' -- required
AND 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 as guest

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.catalog.recipe_versions
WHERE org_name = '{{ org_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 }}'
;