recipes

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

Overview

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

Fields

The following fields are returned by SELECT queries:

get_by_team
get
list

Name	Datatype	Description
`name`	`string`	Unique name of the recipe
`latest_version_id`	`integer (int64)`	Deprecated: Please use latestVersionIdStr instead. ID of the latest version (wire: latestVersionId)
`display_name`	`string`	Display name (wire: displayName)
`org_name`	`string`	Name of the org that the recipe belongs to (wire: orgName)
`team_name`	`string`	Name of the team that the recipe belongs to (wire: teamName)
`access_type`	`string`	(LISTED, EXCLUSIVE, NOT_LISTED) (wire: accessType)
`advanced`	`string`	Text for describing advanced information
`application`	`string`	(CLASSIFICATION, OBJECT_DETECTION, SEGMENTATION, TRANSLATION, TEXT_TO_SPEECH, RECOMMENDER, SENTIMENT, NLP, KUBEFLOW_PIPELINE, OTHER, SPEAKER_VERIFICATION, PUNCTUATION_AND_CAPITALIZATION, DIALOG_STATE_TRACKING, SPEAKER_DIARIZATION, SPEAKER_RECOGNITION, SPEECH_SYNTHESIS, VOICE_ACTIVITY_DETECTION, SPEECH_RECOGNITION, LANGUAGE_MODELING, NAMED_ENTITY_RECOGNITION, TEXT_CLASSIFICATION, TEXT_PROCESSING, QUESTION_ANSWERING, CONTENT_GENERATION)
`built_by`	`string`	Organization that built the recipe (wire: builtBy)
`can_guest_download`	`boolean`	Indicates if a guest user can download (wire: canGuestDownload)
`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)
`description`	`string`	Description of the recipe
`has_signed_version`	`boolean`	Indicates if the recipe has any signed versions (wire: hasSignedVersion)
`is_favourite`	`boolean`	Flag indicating if recipe is user's favorite (wire: isFavourite)
`is_public`	`boolean`	Determines if this recipe is publicly accessible (wire: isPublic)
`is_read_only`	`boolean`	indicate if current user has read only permissions (deprecated) (wire: isReadOnly)
`labels`	`array`
`latest_version_id_str`	`string`	ID of the latest version (wire: latestVersionIdStr)
`latest_version_size_in_bytes`	`integer (int64)`	Size of the latest version in bytes (wire: latestVersionSizeInBytes)
`license_terms`	`array`	(wire: licenseTerms)
`logo`	`string`	URL for the logo image
`model_format`	`string`	Format of the model this recipe produces (wire: modelFormat)
`performance`	`string`	Text describing performance of the recipe results
`policy_labels`	`array`	(wire: policyLabels)
`precision`	`string`	(FP16, FP32, INT8, FPBOTH, OTHER, ALL)
`product_names`	`array`	(wire: productNames)
`public_dataset_used`	`object`	(wire: publicDatasetUsed)
`publisher`	`string`	Organization that published this recipe
`quick_start_guide`	`string`	Text with a guide to getting started (wire: quickStartGuide)
`related_models`	`array`	(wire: relatedModels)
`setup`	`string`	Text describing recipe setup
`short_description`	`string`	Short description of the recipe (wire: shortDescription)
`training_framework`	`string`	(TensorFlow, Caffe2, CNTK, Torch, PyTorch, MXNet, Keras, Other, TransferLearningToolkit, TensorFlow2) (wire: trainingFramework)
`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
`name`	`string`	Unique name of the recipe
`latest_version_id`	`integer (int64)`	Deprecated: Please use latestVersionIdStr instead. ID of the latest version (wire: latestVersionId)
`display_name`	`string`	Display name (wire: displayName)
`org_name`	`string`	Name of the org that the recipe belongs to (wire: orgName)
`team_name`	`string`	Name of the team that the recipe belongs to (wire: teamName)
`access_type`	`string`	(LISTED, EXCLUSIVE, NOT_LISTED) (wire: accessType)
`advanced`	`string`	Text for describing advanced information
`application`	`string`	(CLASSIFICATION, OBJECT_DETECTION, SEGMENTATION, TRANSLATION, TEXT_TO_SPEECH, RECOMMENDER, SENTIMENT, NLP, KUBEFLOW_PIPELINE, OTHER, SPEAKER_VERIFICATION, PUNCTUATION_AND_CAPITALIZATION, DIALOG_STATE_TRACKING, SPEAKER_DIARIZATION, SPEAKER_RECOGNITION, SPEECH_SYNTHESIS, VOICE_ACTIVITY_DETECTION, SPEECH_RECOGNITION, LANGUAGE_MODELING, NAMED_ENTITY_RECOGNITION, TEXT_CLASSIFICATION, TEXT_PROCESSING, QUESTION_ANSWERING, CONTENT_GENERATION)
`built_by`	`string`	Organization that built the recipe (wire: builtBy)
`can_guest_download`	`boolean`	Indicates if a guest user can download (wire: canGuestDownload)
`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)
`description`	`string`	Description of the recipe
`has_signed_version`	`boolean`	Indicates if the recipe has any signed versions (wire: hasSignedVersion)
`is_favourite`	`boolean`	Flag indicating if recipe is user's favorite (wire: isFavourite)
`is_public`	`boolean`	Determines if this recipe is publicly accessible (wire: isPublic)
`is_read_only`	`boolean`	indicate if current user has read only permissions (deprecated) (wire: isReadOnly)
`labels`	`array`
`latest_version_id_str`	`string`	ID of the latest version (wire: latestVersionIdStr)
`latest_version_size_in_bytes`	`integer (int64)`	Size of the latest version in bytes (wire: latestVersionSizeInBytes)
`license_terms`	`array`	(wire: licenseTerms)
`logo`	`string`	URL for the logo image
`model_format`	`string`	Format of the model this recipe produces (wire: modelFormat)
`performance`	`string`	Text describing performance of the recipe results
`policy_labels`	`array`	(wire: policyLabels)
`precision`	`string`	(FP16, FP32, INT8, FPBOTH, OTHER, ALL)
`product_names`	`array`	(wire: productNames)
`public_dataset_used`	`object`	(wire: publicDatasetUsed)
`publisher`	`string`	Organization that published this recipe
`quick_start_guide`	`string`	Text with a guide to getting started (wire: quickStartGuide)
`related_models`	`array`	(wire: relatedModels)
`setup`	`string`	Text describing recipe setup
`short_description`	`string`	Short description of the recipe (wire: shortDescription)
`training_framework`	`string`	(TensorFlow, Caffe2, CNTK, Torch, PyTorch, MXNet, Keras, Other, TransferLearningToolkit, TensorFlow2) (wire: trainingFramework)
`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
`name`	`string`	Unique name of the recipe
`latest_version_id`	`integer (int64)`	Deprecated: Please use latestVersionIdStr instead. ID of the latest version (wire: latestVersionId)
`display_name`	`string`	Display name (wire: displayName)
`org_name`	`string`	Name of the org that the recipe belongs to (wire: orgName)
`team_name`	`string`	Name of the team that the recipe belongs to (wire: teamName)
`access_type`	`string`	(LISTED, EXCLUSIVE, NOT_LISTED) (wire: accessType)
`advanced`	`string`	Text for describing advanced information
`application`	`string`	(CLASSIFICATION, OBJECT_DETECTION, SEGMENTATION, TRANSLATION, TEXT_TO_SPEECH, RECOMMENDER, SENTIMENT, NLP, KUBEFLOW_PIPELINE, OTHER, SPEAKER_VERIFICATION, PUNCTUATION_AND_CAPITALIZATION, DIALOG_STATE_TRACKING, SPEAKER_DIARIZATION, SPEAKER_RECOGNITION, SPEECH_SYNTHESIS, VOICE_ACTIVITY_DETECTION, SPEECH_RECOGNITION, LANGUAGE_MODELING, NAMED_ENTITY_RECOGNITION, TEXT_CLASSIFICATION, TEXT_PROCESSING, QUESTION_ANSWERING, CONTENT_GENERATION)
`built_by`	`string`	Organization that built the recipe (wire: builtBy)
`can_guest_download`	`boolean`	Indicates if a guest user can download (wire: canGuestDownload)
`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)
`description`	`string`	Description of the recipe
`has_signed_version`	`boolean`	Indicates if the recipe has any signed versions (wire: hasSignedVersion)
`is_favourite`	`boolean`	Flag indicating if recipe is user's favorite (wire: isFavourite)
`is_public`	`boolean`	Determines if this recipe is publicly accessible (wire: isPublic)
`is_read_only`	`boolean`	indicate if current user has read only permissions (deprecated) (wire: isReadOnly)
`labels`	`array`
`latest_version_id_str`	`string`	ID of the latest version (wire: latestVersionIdStr)
`latest_version_size_in_bytes`	`integer (int64)`	Size of the latest version in bytes (wire: latestVersionSizeInBytes)
`license_terms`	`array`	(wire: licenseTerms)
`logo`	`string`	URL for the logo image
`model_format`	`string`	Format of the model this recipe produces (wire: modelFormat)
`performance`	`string`	Text describing performance of the recipe results
`policy_labels`	`array`	(wire: policyLabels)
`precision`	`string`	(FP16, FP32, INT8, FPBOTH, OTHER, ALL)
`product_names`	`array`	(wire: productNames)
`public_dataset_used`	`object`	(wire: publicDatasetUsed)
`publisher`	`string`	Organization that published this recipe
`quick_start_guide`	`string`	Text with a guide to getting started (wire: quickStartGuide)
`related_models`	`array`	(wire: relatedModels)
`setup`	`string`	Text describing recipe setup
`short_description`	`string`	Short description of the recipe (wire: shortDescription)
`training_framework`	`string`	(TensorFlow, Caffe2, CNTK, Torch, PyTorch, MXNet, Keras, Other, TransferLearningToolkit, TensorFlow2) (wire: trainingFramework)
`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`, `recipe_name`	`resolve_labels`, `remove_unresolved_labels`	Get recipe details in team as guest
`get`	`select`	`org_name`, `recipe_name`	`resolve_labels`, `remove_unresolved_labels`	Get recipe details in org as guest
`list`	`select`		`page_size`, `page_number`	List public recipes

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
`page_number`	`string (UTF-8)`	Page number - zero based index
`page_size`	`string (UTF-8)`	Page size
`remove_unresolved_labels`	`boolean`	Remove unresolved labels
`resolve_labels`	`boolean`	Resolve labels

`SELECT` examples

get_by_team
get
list

Get recipe details in team as guest

SELECT
name,
latest_version_id,
display_name,
org_name,
team_name,
access_type,
advanced,
application,
built_by,
can_guest_download,
created_date,
description,
has_signed_version,
is_favourite,
is_public,
is_read_only,
labels,
latest_version_id_str,
latest_version_size_in_bytes,
license_terms,
logo,
model_format,
performance,
policy_labels,
precision,
product_names,
public_dataset_used,
publisher,
quick_start_guide,
related_models,
setup,
short_description,
training_framework,
updated_date
FROM nvidia.catalog.recipes
WHERE org_name = '{{ org_name }}' -- required
AND team_name = '{{ team_name }}' -- required
AND recipe_name = '{{ recipe_name }}' -- required
AND resolve_labels = '{{ resolve_labels }}'
AND remove_unresolved_labels = '{{ remove_unresolved_labels }}'
;

Get recipe details in org as guest

SELECT
name,
latest_version_id,
display_name,
org_name,
team_name,
access_type,
advanced,
application,
built_by,
can_guest_download,
created_date,
description,
has_signed_version,
is_favourite,
is_public,
is_read_only,
labels,
latest_version_id_str,
latest_version_size_in_bytes,
license_terms,
logo,
model_format,
performance,
policy_labels,
precision,
product_names,
public_dataset_used,
publisher,
quick_start_guide,
related_models,
setup,
short_description,
training_framework,
updated_date
FROM nvidia.catalog.recipes
WHERE org_name = '{{ org_name }}' -- required
AND recipe_name = '{{ recipe_name }}' -- required
AND resolve_labels = '{{ resolve_labels }}'
AND remove_unresolved_labels = '{{ remove_unresolved_labels }}'
;

List public recipes

SELECT
name,
latest_version_id,
display_name,
org_name,
team_name,
access_type,
advanced,
application,
built_by,
can_guest_download,
created_date,
description,
has_signed_version,
is_favourite,
is_public,
is_read_only,
labels,
latest_version_id_str,
latest_version_size_in_bytes,
license_terms,
logo,
model_format,
performance,
policy_labels,
precision,
product_names,
public_dataset_used,
publisher,
quick_start_guide,
related_models,
setup,
short_description,
training_framework,
updated_date
FROM nvidia.catalog.recipes
WHERE page_size = '{{ page_size }}'
AND page_number = '{{ page_number }}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

Overview

Fields

Methods

Parameters

`SELECT` examples