Entity Models Resource#

class nemo_microservices.resources.ModelsResource(client: NeMoMicroservices)#

Bases: SyncAPIResource

property with_raw_response: ModelsResourceWithRawResponse#

This property can be used as a prefix for any HTTP method call to return the raw response object instead of the parsed content.

For more information, see https://docs.nvidia.com/nemo/microservices/latest/pysdk/index.html#accessing-raw-response-data-e-g-headers

property with_streaming_response: ModelsResourceWithStreamingResponse#

An alternative to .with_raw_response that doesn’t eagerly read the response body.

For more information, see https://docs.nvidia.com/nemo/microservices/latest/pysdk/index.html#with_streaming_response

create(
*,
api_endpoint: APIEndpointData | NotGiven = NOT_GIVEN,
artifact: ModelArtifact | NotGiven = NOT_GIVEN,
base_model: str | object | NotGiven = NOT_GIVEN,
custom_fields: Dict[str, str] | NotGiven = NOT_GIVEN,
description: str | NotGiven = NOT_GIVEN,
guardrails: GuardrailConfigParam | NotGiven = NOT_GIVEN,
name: str | NotGiven = NOT_GIVEN,
namespace: str | NotGiven = NOT_GIVEN,
ownership: Ownership | NotGiven = NOT_GIVEN,
peft: ParameterEfficientFinetuningData | NotGiven = NOT_GIVEN,
project: str | NotGiven = NOT_GIVEN,
prompt: PromptData | NotGiven = NOT_GIVEN,
spec: ModelSpec | NotGiven = NOT_GIVEN,
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) Model#

Create a new model.

Parameters:
  • api_endpoint – Data about an API endpoint.

  • artifact

    Data about a model artifact (a set of checkpoint files, configs, and other auxiliary info).

    The files_url field can point to a DataStore location.

    Example:

    • nds://models/rdinu/my-lora-customization

    The rdinu/my-lora-customization part above is the actual repository.

    If a specific revision needs to be referred, the HuggingFace syntax is used.

    • nds://models/rdinu/my-lora-customization@v1

    • nds://models/rdinu/my-lora-customization@8df79a8

  • base_model – Link to another model which is used as a base for the current model.

  • custom_fields – A set of custom fields that the user can define and use for various purposes.

  • description – The description of the entity.

  • guardrails – A guardrail configuration

  • name – The name of the entity. Must be unique inside the namespace. If not specified, it will be the same as the automatically generated id.

  • namespace – The namespace of the entity. This can be missing for namespace entities or in deployments that don’t use namespaces.

  • ownership

    Information about ownership of an entity.

    If the entity is a namespace, the access_policies will typically apply to all entities inside the namespace.

  • peft – Data about a parameter-efficient finetuning.

  • project – The URN of the project associated with this entity.

  • prompt – Prompt engineering data.

  • spec – Detailed specification about a model.

  • extra_headers – Send extra headers

  • extra_query – Add additional query parameters to the request

  • extra_body – Add additional JSON properties to the request

  • timeout – Override the client-level default timeout for this request, in seconds

retrieve(
model_name: str,
*,
namespace: str,
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) Model#

Get model info.

Parameters:
  • extra_headers – Send extra headers

  • extra_query – Add additional query parameters to the request

  • extra_body – Add additional JSON properties to the request

  • timeout – Override the client-level default timeout for this request, in seconds

update(
model_name: str,
*,
namespace: str,
api_endpoint: APIEndpointData | NotGiven = NOT_GIVEN,
artifact: ModelArtifact | NotGiven = NOT_GIVEN,
base_model: model_update_params.BaseModel | NotGiven = NOT_GIVEN,
custom_fields: Dict[str, str] | NotGiven = NOT_GIVEN,
description: str | NotGiven = NOT_GIVEN,
guardrails: GuardrailConfigParam | NotGiven = NOT_GIVEN,
ownership: Ownership | NotGiven = NOT_GIVEN,
peft: ParameterEfficientFinetuningData | NotGiven = NOT_GIVEN,
project: str | NotGiven = NOT_GIVEN,
prompt: PromptData | NotGiven = NOT_GIVEN,
schema_version: str | NotGiven = NOT_GIVEN,
spec: ModelSpec | NotGiven = NOT_GIVEN,
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) Model#

Update model metadata.

If the request body has an empty field, keep the old value.

Parameters:
  • api_endpoint – Data about an API endpoint.

  • artifact

    Data about a model artifact (a set of checkpoint files, configs, and other auxiliary info).

    The files_url field can point to a DataStore location.

    Example:

    • nds://models/rdinu/my-lora-customization

    The rdinu/my-lora-customization part above is the actual repository.

    If a specific revision needs to be referred, the HuggingFace syntax is used.

    • nds://models/rdinu/my-lora-customization@v1

    • nds://models/rdinu/my-lora-customization@8df79a8

  • base_model – Link to another model which is used as a base for the current model.

  • custom_fields – A set of custom fields that the user can define and use for various purposes.

  • description – The description of the entity.

  • guardrails – A guardrail configuration

  • ownership

    Information about ownership of an entity.

    If the entity is a namespace, the access_policies will typically apply to all entities inside the namespace.

  • peft – Data about a parameter-efficient finetuning.

  • project – The URN of the project associated with this entity.

  • prompt – Prompt engineering data.

  • schema_version – The version of the schema for the object. Internal use only.

  • spec – Detailed specification about a model.

  • extra_headers – Send extra headers

  • extra_query – Add additional query parameters to the request

  • extra_body – Add additional JSON properties to the request

  • timeout – Override the client-level default timeout for this request, in seconds

list(
*,
filter: ModelFilterParam | NotGiven = NOT_GIVEN,
page: int | NotGiven = NOT_GIVEN,
page_size: int | NotGiven = NOT_GIVEN,
sort: ModelSortField | NotGiven = NOT_GIVEN,
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) SyncDefaultPagination[Model]#

Return the list of available models.

Parameters:
  • filter

    Filter models on various criteria.

    Where it makes sense, you can also filter on the existence of a property. For example:

    • ?filter[peft]=true: would filter all models with peft attribute set.

  • page – Page number.

  • page_size – Page size.

  • sort – The field to sort by. To sort in decreasing order, use - in front of the field name.

  • extra_headers – Send extra headers

  • extra_query – Add additional query parameters to the request

  • extra_body – Add additional JSON properties to the request

  • timeout – Override the client-level default timeout for this request, in seconds

delete(
model_name: str,
*,
namespace: str,
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) DeleteResponse#

Delete Model

Parameters:
  • extra_headers – Send extra headers

  • extra_query – Add additional query parameters to the request

  • extra_body – Add additional JSON properties to the request

  • timeout – Override the client-level default timeout for this request, in seconds

create_from_dict(data: dict[str, object]) object#
class nemo_microservices.resources.AsyncModelsResource(client: AsyncNeMoMicroservices)#

Bases: AsyncAPIResource

property with_raw_response: AsyncModelsResourceWithRawResponse#

This property can be used as a prefix for any HTTP method call to return the raw response object instead of the parsed content.

For more information, see https://docs.nvidia.com/nemo/microservices/latest/pysdk/index.html#accessing-raw-response-data-e-g-headers

property with_streaming_response: AsyncModelsResourceWithStreamingResponse#

An alternative to .with_raw_response that doesn’t eagerly read the response body.

For more information, see https://docs.nvidia.com/nemo/microservices/latest/pysdk/index.html#with_streaming_response

async create(
*,
api_endpoint: APIEndpointData | NotGiven = NOT_GIVEN,
artifact: ModelArtifact | NotGiven = NOT_GIVEN,
base_model: str | object | NotGiven = NOT_GIVEN,
custom_fields: Dict[str, str] | NotGiven = NOT_GIVEN,
description: str | NotGiven = NOT_GIVEN,
guardrails: GuardrailConfigParam | NotGiven = NOT_GIVEN,
name: str | NotGiven = NOT_GIVEN,
namespace: str | NotGiven = NOT_GIVEN,
ownership: Ownership | NotGiven = NOT_GIVEN,
peft: ParameterEfficientFinetuningData | NotGiven = NOT_GIVEN,
project: str | NotGiven = NOT_GIVEN,
prompt: PromptData | NotGiven = NOT_GIVEN,
spec: ModelSpec | NotGiven = NOT_GIVEN,
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) Model#

Create a new model.

Parameters:
  • api_endpoint – Data about an API endpoint.

  • artifact

    Data about a model artifact (a set of checkpoint files, configs, and other auxiliary info).

    The files_url field can point to a DataStore location.

    Example:

    • nds://models/rdinu/my-lora-customization

    The rdinu/my-lora-customization part above is the actual repository.

    If a specific revision needs to be referred, the HuggingFace syntax is used.

    • nds://models/rdinu/my-lora-customization@v1

    • nds://models/rdinu/my-lora-customization@8df79a8

  • base_model – Link to another model which is used as a base for the current model.

  • custom_fields – A set of custom fields that the user can define and use for various purposes.

  • description – The description of the entity.

  • guardrails – A guardrail configuration

  • name – The name of the entity. Must be unique inside the namespace. If not specified, it will be the same as the automatically generated id.

  • namespace – The namespace of the entity. This can be missing for namespace entities or in deployments that don’t use namespaces.

  • ownership

    Information about ownership of an entity.

    If the entity is a namespace, the access_policies will typically apply to all entities inside the namespace.

  • peft – Data about a parameter-efficient finetuning.

  • project – The URN of the project associated with this entity.

  • prompt – Prompt engineering data.

  • spec – Detailed specification about a model.

  • extra_headers – Send extra headers

  • extra_query – Add additional query parameters to the request

  • extra_body – Add additional JSON properties to the request

  • timeout – Override the client-level default timeout for this request, in seconds

async retrieve(
model_name: str,
*,
namespace: str,
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) Model#

Get model info.

Parameters:
  • extra_headers – Send extra headers

  • extra_query – Add additional query parameters to the request

  • extra_body – Add additional JSON properties to the request

  • timeout – Override the client-level default timeout for this request, in seconds

async update(
model_name: str,
*,
namespace: str,
api_endpoint: APIEndpointData | NotGiven = NOT_GIVEN,
artifact: ModelArtifact | NotGiven = NOT_GIVEN,
base_model: model_update_params.BaseModel | NotGiven = NOT_GIVEN,
custom_fields: Dict[str, str] | NotGiven = NOT_GIVEN,
description: str | NotGiven = NOT_GIVEN,
guardrails: GuardrailConfigParam | NotGiven = NOT_GIVEN,
ownership: Ownership | NotGiven = NOT_GIVEN,
peft: ParameterEfficientFinetuningData | NotGiven = NOT_GIVEN,
project: str | NotGiven = NOT_GIVEN,
prompt: PromptData | NotGiven = NOT_GIVEN,
schema_version: str | NotGiven = NOT_GIVEN,
spec: ModelSpec | NotGiven = NOT_GIVEN,
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) Model#

Update model metadata.

If the request body has an empty field, keep the old value.

Parameters:
  • api_endpoint – Data about an API endpoint.

  • artifact

    Data about a model artifact (a set of checkpoint files, configs, and other auxiliary info).

    The files_url field can point to a DataStore location.

    Example:

    • nds://models/rdinu/my-lora-customization

    The rdinu/my-lora-customization part above is the actual repository.

    If a specific revision needs to be referred, the HuggingFace syntax is used.

    • nds://models/rdinu/my-lora-customization@v1

    • nds://models/rdinu/my-lora-customization@8df79a8

  • base_model – Link to another model which is used as a base for the current model.

  • custom_fields – A set of custom fields that the user can define and use for various purposes.

  • description – The description of the entity.

  • guardrails – A guardrail configuration

  • ownership

    Information about ownership of an entity.

    If the entity is a namespace, the access_policies will typically apply to all entities inside the namespace.

  • peft – Data about a parameter-efficient finetuning.

  • project – The URN of the project associated with this entity.

  • prompt – Prompt engineering data.

  • schema_version – The version of the schema for the object. Internal use only.

  • spec – Detailed specification about a model.

  • extra_headers – Send extra headers

  • extra_query – Add additional query parameters to the request

  • extra_body – Add additional JSON properties to the request

  • timeout – Override the client-level default timeout for this request, in seconds

list(
*,
filter: ModelFilterParam | NotGiven = NOT_GIVEN,
page: int | NotGiven = NOT_GIVEN,
page_size: int | NotGiven = NOT_GIVEN,
sort: ModelSortField | NotGiven = NOT_GIVEN,
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) AsyncPaginator[Model, AsyncDefaultPagination[Model]]#

Return the list of available models.

Parameters:
  • filter

    Filter models on various criteria.

    Where it makes sense, you can also filter on the existence of a property. For example:

    • ?filter[peft]=true: would filter all models with peft attribute set.

  • page – Page number.

  • page_size – Page size.

  • sort – The field to sort by. To sort in decreasing order, use - in front of the field name.

  • extra_headers – Send extra headers

  • extra_query – Add additional query parameters to the request

  • extra_body – Add additional JSON properties to the request

  • timeout – Override the client-level default timeout for this request, in seconds

async delete(
model_name: str,
*,
namespace: str,
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) DeleteResponse#

Delete Model

Parameters:
  • extra_headers – Send extra headers

  • extra_query – Add additional query parameters to the request

  • extra_body – Add additional JSON properties to the request

  • timeout – Override the client-level default timeout for this request, in seconds

create_from_dict(
data: dict[str, object],
) object#