Skip to main content

resources

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

Overview​

Nameresources
TypeResource
Idnvidia.private_registry.resources

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
namestringUnique name of the recipe
latest_version_idinteger (int64)Deprecated: Please use latestVersionIdStr instead. ID of the latest version (wire: latestVersionId)
display_namestringDisplay name (wire: displayName)
org_namestringName of the org that the recipe belongs to (wire: orgName)
team_namestringName of the team that the recipe belongs to (wire: teamName)
access_typestring (LISTED, EXCLUSIVE, NOT_LISTED) (wire: accessType)
advancedstringText for describing advanced information
applicationstring (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_bystringOrganization that built the recipe (wire: builtBy)
can_guest_downloadbooleanIndicates if a guest user can download (wire: canGuestDownload)
created_datestringCreation 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)
descriptionstringDescription of the recipe
has_signed_versionbooleanIndicates if the recipe has any signed versions (wire: hasSignedVersion)
is_favouritebooleanFlag indicating if recipe is user's favorite (wire: isFavourite)
is_publicbooleanDetermines if this recipe is publicly accessible (wire: isPublic)
is_read_onlybooleanindicate if current user has read only permissions (deprecated) (wire: isReadOnly)
labelsarray
latest_version_id_strstringID of the latest version (wire: latestVersionIdStr)
latest_version_size_in_bytesinteger (int64)Size of the latest version in bytes (wire: latestVersionSizeInBytes)
license_termsarray (wire: licenseTerms)
logostringURL for the logo image
model_formatstringFormat of the model this recipe produces (wire: modelFormat)
performancestringText describing performance of the recipe results
policy_labelsarray (wire: policyLabels)
precisionstring (FP16, FP32, INT8, FPBOTH, OTHER, ALL)
product_namesarray (wire: productNames)
public_dataset_usedobject (wire: publicDatasetUsed)
publisherstringOrganization that published this recipe
quick_start_guidestringText with a guide to getting started (wire: quickStartGuide)
related_modelsarray (wire: relatedModels)
setupstringText describing recipe setup
short_descriptionstringShort description of the recipe (wire: shortDescription)
training_frameworkstring (TensorFlow, Caffe2, CNTK, Torch, PyTorch, MXNet, Keras, Other, TransferLearningToolkit, TensorFlow2) (wire: trainingFramework)
updated_datestringUpdated 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:

NameAccessible byRequired ParamsOptional ParamsDescription
get_by_teamselectteam_name, recipe_nameresolve_labels, remove_unresolved_labelsGet recipe details in team
getselectrecipe_nameresolve_labels, remove_unresolved_labelsGet recipe in org
list_by_teamselectteam_nameapp_name, page_size, page_number, resolve_labels, remove_unresolved_labelsList recipes the user can access in the specified org and team
listselectapp_name, page_size, page_number, resolve_labels, remove_unresolved_labelsList recipes the user can access in the specified org
create_by_teaminsertteam_name, application, model_format, name, precision, public_dataset_used, short_description, training_frameworkCreate recipe in team
createinsertapplication, model_format, name, precision, public_dataset_used, short_description, training_frameworkCreate recipe in org
update_by_teamupdateteam_name, recipe_nameUpdate recipe details in team
updateupdaterecipe_nameUpdate recipe details in org
delete_by_teamdeleteteam_name, recipe_nameThis operation deletes a resource in the org/team (SDK evidence: ngcsdk registry/api/resources.py remove; not declared in the published definition).
deletedeleterecipe_nameThis operation deletes a resource in the org (SDK evidence: ngcsdk registry/api/resources.py remove; not declared in the published definition).

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.

NameDatatypeDescription
recipe_namestring (UTF-8)Recipe name
team_namestring (UTF-8)Team name
app_namestring (UTF-8)Application name
page_numberstring (UTF-8)Page number - zero based index
page_sizestring (UTF-8)Page size
remove_unresolved_labelsbooleanRemove unresolved labels
resolve_labelsbooleanResolve labels

SELECT examples​

Get recipe details in team

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.private_registry.resources
WHERE team_name = '{{ team_name }}' -- required
AND recipe_name = '{{ recipe_name }}' -- required
AND resolve_labels = '{{ resolve_labels }}'
AND remove_unresolved_labels = '{{ remove_unresolved_labels }}'
;

INSERT examples​

Create recipe in team

INSERT INTO nvidia.private_registry.resources (
advanced,
application,
built_by,
description,
display_name,
labels,
labels_v2,
license_terms,
logo,
model_format,
name,
performance,
precision,
public_dataset_used,
publisher,
quick_start_guide,
setup,
short_description,
training_framework,
team_name
)
SELECT 
'{{ advanced }}',
'{{ application }}' /* required */,
'{{ built_by }}',
'{{ description }}',
'{{ display_name }}',
'{{ labels }}',
'{{ labels_v2 }}',
'{{ license_terms }}',
'{{ logo }}',
'{{ model_format }}' /* required */,
'{{ name }}' /* required */,
'{{ performance }}',
'{{ precision }}' /* required */,
'{{ public_dataset_used }}' /* required */,
'{{ publisher }}',
'{{ quick_start_guide }}',
'{{ setup }}',
'{{ short_description }}' /* required */,
'{{ training_framework }}' /* required */,
'{{ team_name }}'
RETURNING
recipe,
request_status
;

UPDATE examples​

Update recipe details in team

UPDATE nvidia.private_registry.resources
SET 
advanced = '{{ advanced }}',
application = '{{ application }}',
built_by = '{{ built_by }}',
description = '{{ description }}',
display_name = '{{ display_name }}',
labels = '{{ labels }}',
labels_v2 = '{{ labels_v2 }}',
license_terms = '{{ license_terms }}',
logo = '{{ logo }}',
model_format = '{{ model_format }}',
performance = '{{ performance }}',
precision = '{{ precision }}',
public_dataset_used = '{{ public_dataset_used }}',
publisher = '{{ publisher }}',
quick_start_guide = '{{ quick_start_guide }}',
related_models = '{{ related_models }}',
setup = '{{ setup }}',
short_description = '{{ short_description }}',
training_framework = '{{ training_framework }}'
WHERE 
team_name = '{{ team_name }}' --required
AND recipe_name = '{{ recipe_name }}' --required
RETURNING
recipe,
request_status;

DELETE examples​

This operation deletes a resource in the org/team (SDK evidence: ngcsdk registry/api/resources.py remove; not declared in the published definition).

DELETE FROM nvidia.private_registry.resources
WHERE team_name = '{{ team_name }}' --required
AND recipe_name = '{{ recipe_name }}' --required
;
Last updated on