models

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

Overview

Name	models
Type	Resource
Id	nvidia.catalog.models

Fields

The following fields are returned by SELECT queries:

get_by_team

Name	Datatype	Description
name	string	Unique name of the model
encryption_key_id	string	ID of the customer managed encryption key associated with this artifact (wire: encryptionKeyId)
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 model belongs to (wire: orgName)
owner_name	string	Name of model's owner (wire: ownerName)
team_name	string	Name of the team that the model belongs to (wire: teamName)
access_type	string	(LISTED, EXCLUSIVE, NOT_LISTED) (wire: accessType)
application	string	Application of the model
bias	string	Text describing bias in the model
built_by	string	organization that built the repository (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 model
explainability	string	Text describing explainability for this model
framework	string	Framework used to train this model
has_playground	boolean	indicate if the Model has AI Playground configured (wire: hasPlayground)
has_signed_version	boolean	Indicates if the model has any signed versions (wire: hasSignedVersion)
is_favourite	boolean	Flag indicating if model is user's favorite (wire: isFavourite)
is_playground_enabled	boolean	indicate if AI Playground is enabled in the catalog (wire: isPlaygroundEnabled)
is_public	boolean	Determines if model is publicly accessible (wire: isPublic)
is_read_only	boolean	indicate if current user has read only permissions (deprecated) (wire: isReadOnly)
labels	array
latest_version_gpu_model	string	GPU model and memory used for the latest version (wire: latestVersionGpuModel)
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 (wire: modelFormat)
policy_labels	array	(wire: policyLabels)
precision	string	Precision this model was trained with
privacy	string	Text describing the privacy for this model
product_names	array	(wire: productNames)
public_dataset_used	object	(wire: publicDatasetUsed)
publisher	string	organization that published the repository
safety_and_security	string	Text for describing the safety and security in the model (wire: safetyAndSecurity)
short_description	string	Short description of the model (wire: shortDescription)
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)
versions	array

get

Name	Datatype	Description
name	string	Unique name of the model
encryption_key_id	string	ID of the customer managed encryption key associated with this artifact (wire: encryptionKeyId)
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 model belongs to (wire: orgName)
owner_name	string	Name of model's owner (wire: ownerName)
team_name	string	Name of the team that the model belongs to (wire: teamName)
access_type	string	(LISTED, EXCLUSIVE, NOT_LISTED) (wire: accessType)
application	string	Application of the model
bias	string	Text describing bias in the model
built_by	string	organization that built the repository (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 model
explainability	string	Text describing explainability for this model
framework	string	Framework used to train this model
has_playground	boolean	indicate if the Model has AI Playground configured (wire: hasPlayground)
has_signed_version	boolean	Indicates if the model has any signed versions (wire: hasSignedVersion)
is_favourite	boolean	Flag indicating if model is user's favorite (wire: isFavourite)
is_playground_enabled	boolean	indicate if AI Playground is enabled in the catalog (wire: isPlaygroundEnabled)
is_public	boolean	Determines if model is publicly accessible (wire: isPublic)
is_read_only	boolean	indicate if current user has read only permissions (deprecated) (wire: isReadOnly)
labels	array
latest_version_gpu_model	string	GPU model and memory used for the latest version (wire: latestVersionGpuModel)
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 (wire: modelFormat)
policy_labels	array	(wire: policyLabels)
precision	string	Precision this model was trained with
privacy	string	Text describing the privacy for this model
product_names	array	(wire: productNames)
public_dataset_used	object	(wire: publicDatasetUsed)
publisher	string	organization that published the repository
safety_and_security	string	Text for describing the safety and security in the model (wire: safetyAndSecurity)
short_description	string	Short description of the model (wire: shortDescription)
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)
versions	array

list

Name	Datatype	Description
name	string	Unique name of the model
encryption_key_id	string	ID of the customer managed encryption key associated with this artifact (wire: encryptionKeyId)
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 model belongs to (wire: orgName)
owner_name	string	Name of model's owner (wire: ownerName)
team_name	string	Name of the team that the model belongs to (wire: teamName)
access_type	string	(LISTED, EXCLUSIVE, NOT_LISTED) (wire: accessType)
application	string	Application of the model
bias	string	Text describing bias in the model
built_by	string	organization that built the repository (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 model
explainability	string	Text describing explainability for this model
framework	string	Framework used to train this model
has_playground	boolean	indicate if the Model has AI Playground configured (wire: hasPlayground)
has_signed_version	boolean	Indicates if the model has any signed versions (wire: hasSignedVersion)
is_favourite	boolean	Flag indicating if model is user's favorite (wire: isFavourite)
is_playground_enabled	boolean	indicate if AI Playground is enabled in the catalog (wire: isPlaygroundEnabled)
is_public	boolean	Determines if model is publicly accessible (wire: isPublic)
is_read_only	boolean	indicate if current user has read only permissions (deprecated) (wire: isReadOnly)
labels	array
latest_version_gpu_model	string	GPU model and memory used for the latest version (wire: latestVersionGpuModel)
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 (wire: modelFormat)
policy_labels	array	(wire: policyLabels)
precision	string	Precision this model was trained with
privacy	string	Text describing the privacy for this model
product_names	array	(wire: productNames)
public_dataset_used	object	(wire: publicDatasetUsed)
publisher	string	organization that published the repository
safety_and_security	string	Text for describing the safety and security in the model (wire: safetyAndSecurity)
short_description	string	Short description of the model (wire: shortDescription)
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)
versions	array

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, model_name	resolve_labels, remove_unresolved_labels	This operation gets info of a model in the org/team as guest.
get	select	org_name, model_name	resolve_labels, remove_unresolved_labels	This operation gets info of a model in the org as guest.
list	select		page_size, page_reference, page_number	This operation lists public models.

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
model_name	string (UTF-8)	Model name
org_name	string (UTF-8)	Organization name
team_name	string (UTF-8)	Team name
page_number	string (UTF-8)	Page number - zero based index
page_reference	string (UTF-8)	Page reference
page_size	string (UTF-8)	Page size
remove_unresolved_labels	boolean	Remove unresolved labels
resolve_labels	boolean	Resolve labels

SELECT examples

get_by_team

This operation gets info of a model in the org/team as guest.

SELECT
name,
encryption_key_id,
latest_version_id,
display_name,
org_name,
owner_name,
team_name,
access_type,
application,
bias,
built_by,
can_guest_download,
created_date,
description,
explainability,
framework,
has_playground,
has_signed_version,
is_favourite,
is_playground_enabled,
is_public,
is_read_only,
labels,
latest_version_gpu_model,
latest_version_id_str,
latest_version_size_in_bytes,
license_terms,
logo,
model_format,
policy_labels,
precision,
privacy,
product_names,
public_dataset_used,
publisher,
safety_and_security,
short_description,
updated_date,
versions
FROM nvidia.catalog.models
WHERE org_name = '{{ org_name }}' -- required
AND team_name = '{{ team_name }}' -- required
AND model_name = '{{ model_name }}' -- required
AND resolve_labels = '{{ resolve_labels }}'
AND remove_unresolved_labels = '{{ remove_unresolved_labels }}'
;

get

This operation gets info of a model in the org as guest.

SELECT
name,
encryption_key_id,
latest_version_id,
display_name,
org_name,
owner_name,
team_name,
access_type,
application,
bias,
built_by,
can_guest_download,
created_date,
description,
explainability,
framework,
has_playground,
has_signed_version,
is_favourite,
is_playground_enabled,
is_public,
is_read_only,
labels,
latest_version_gpu_model,
latest_version_id_str,
latest_version_size_in_bytes,
license_terms,
logo,
model_format,
policy_labels,
precision,
privacy,
product_names,
public_dataset_used,
publisher,
safety_and_security,
short_description,
updated_date,
versions
FROM nvidia.catalog.models
WHERE org_name = '{{ org_name }}' -- required
AND model_name = '{{ model_name }}' -- required
AND resolve_labels = '{{ resolve_labels }}'
AND remove_unresolved_labels = '{{ remove_unresolved_labels }}'
;

list

This operation lists public models.

SELECT
name,
encryption_key_id,
latest_version_id,
display_name,
org_name,
owner_name,
team_name,
access_type,
application,
bias,
built_by,
can_guest_download,
created_date,
description,
explainability,
framework,
has_playground,
has_signed_version,
is_favourite,
is_playground_enabled,
is_public,
is_read_only,
labels,
latest_version_gpu_model,
latest_version_id_str,
latest_version_size_in_bytes,
license_terms,
logo,
model_format,
policy_labels,
precision,
privacy,
product_names,
public_dataset_used,
publisher,
safety_and_security,
short_description,
updated_date,
versions
FROM nvidia.catalog.models
WHERE page_size = '{{ page_size }}'
AND page_reference = '{{ page_reference }}'
AND page_number = '{{ page_number }}'
;