nemo_microservices.resources.deployment.model_deployments#

Module Contents#

Classes#

API#

class nemo_microservices.resources.deployment.model_deployments.AsyncModelDeploymentsResource(
client: nemo_microservices._client.AsyncNeMoMicroservices,
)#

Bases: nemo_microservices._resource.AsyncAPIResource

Initialization

async create(
*,
config: nemo_microservices.types.deployment.model_deployment_create_params.Config,
async_enabled: bool | nemo_microservices._types.Omit = omit,
custom_fields: Dict[str, object] | nemo_microservices._types.Omit = omit,
description: str | nemo_microservices._types.Omit = omit,
hf_token: str | nemo_microservices._types.Omit = omit,
models: nemo_microservices._types.SequenceNotStr[str] | nemo_microservices._types.Omit = omit,
name: str | nemo_microservices._types.Omit = omit,
namespace: str | nemo_microservices._types.Omit = omit,
ownership: nemo_microservices.types.shared_params.ownership.Ownership | nemo_microservices._types.Omit = omit,
project: str | nemo_microservices._types.Omit = omit,
extra_headers: nemo_microservices._types.Headers | None = None,
extra_query: nemo_microservices._types.Query | None = None,
extra_body: nemo_microservices._types.Body | None = None,
timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given,
) nemo_microservices.types.deployment.model_deployment.ModelDeployment#

Create a new deployment model_deployment.

Args: config: The deployment configuration.

async_enabled: Whether the async mode is enabled.

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

description: The description of the entity.

hf_token: Hugging Face authentication token for accessing private models and repositories. This token will be stored as a Kubernetes secret and mounted as an environment variable (HF_TOKEN) in the NIM deployment. The secret will be automatically cleaned up when the model deployment is deleted.

models: The models served by this deployment.

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

namespace: The if of 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.

project: The id of project associated with this entity.

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(
deployment_name: str,
*,
namespace: str,
extra_headers: nemo_microservices._types.Headers | None = None,
extra_query: nemo_microservices._types.Query | None = None,
extra_body: nemo_microservices._types.Body | None = None,
timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given,
) nemo_microservices.types.shared.delete_response.DeleteResponse#

Delete Model Deployment

Args: 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: nemo_microservices.types.deployment.model_deployment_filter_param.ModelDeploymentFilterParam | nemo_microservices._types.Omit = omit,
page: int | nemo_microservices._types.Omit = omit,
page_size: int | nemo_microservices._types.Omit = omit,
sort: nemo_microservices.types.shared.generic_sort_field.GenericSortField | nemo_microservices._types.Omit = omit,
extra_headers: nemo_microservices._types.Headers | None = None,
extra_query: nemo_microservices._types.Query | None = None,
extra_body: nemo_microservices._types.Body | None = None,
timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given,
) nemo_microservices._base_client.AsyncPaginator[nemo_microservices.types.deployment.model_deployment.ModelDeployment, nemo_microservices.pagination.AsyncDefaultPagination[nemo_microservices.types.deployment.model_deployment.ModelDeployment]]#

List available deployment model_deployments.

Args: filter: Filter model_deployments on various criteria.

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 retrieve(
deployment_name: str,
*,
namespace: str,
extra_headers: nemo_microservices._types.Headers | None = None,
extra_query: nemo_microservices._types.Query | None = None,
extra_body: nemo_microservices._types.Body | None = None,
timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given,
) nemo_microservices.types.deployment.model_deployment.ModelDeployment#

Get info about a model deployment.

Args: 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(
deployment_name: str,
*,
namespace: str,
async_enabled: bool | nemo_microservices._types.Omit = omit,
config: nemo_microservices.types.deployment.model_deployment_update_params.Config | nemo_microservices._types.Omit = omit,
custom_fields: Dict[str, object] | nemo_microservices._types.Omit = omit,
description: str | nemo_microservices._types.Omit = omit,
hf_token: str | nemo_microservices._types.Omit = omit,
models: nemo_microservices._types.SequenceNotStr[str] | nemo_microservices._types.Omit = omit,
ownership: nemo_microservices.types.shared_params.ownership.Ownership | nemo_microservices._types.Omit = omit,
project: str | nemo_microservices._types.Omit = omit,
schema_version: str | nemo_microservices._types.Omit = omit,
extra_headers: nemo_microservices._types.Headers | None = None,
extra_query: nemo_microservices._types.Query | None = None,
extra_body: nemo_microservices._types.Body | None = None,
timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given,
) nemo_microservices.types.deployment.model_deployment.ModelDeployment#

Update model deployment

Args: async_enabled: Whether the async mode is enabled.

config: The deployment configuration.

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

description: The description of the entity.

hf_token: Hugging Face authentication token for accessing private models and repositories. This token will be stored as a Kubernetes secret and mounted as an environment variable (HF_TOKEN) in the NIM deployment. The secret will be automatically cleaned up when the model deployment is deleted.

models: The models served by this deployment.

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.

project: The id of project associated with this entity.

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

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

property with_raw_response: nemo_microservices.resources.deployment.model_deployments.AsyncModelDeploymentsResourceWithRawResponse#

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: nemo_microservices.resources.deployment.model_deployments.AsyncModelDeploymentsResourceWithStreamingResponse#

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

class nemo_microservices.resources.deployment.model_deployments.AsyncModelDeploymentsResourceWithRawResponse(
model_deployments: nemo_microservices.resources.deployment.model_deployments.AsyncModelDeploymentsResource,
)#

Initialization

class nemo_microservices.resources.deployment.model_deployments.AsyncModelDeploymentsResourceWithStreamingResponse(
model_deployments: nemo_microservices.resources.deployment.model_deployments.AsyncModelDeploymentsResource,
)#

Initialization

class nemo_microservices.resources.deployment.model_deployments.ModelDeploymentsResource(
client: nemo_microservices._client.NeMoMicroservices,
)#

Bases: nemo_microservices._resource.SyncAPIResource

Initialization

create(
*,
config: nemo_microservices.types.deployment.model_deployment_create_params.Config,
async_enabled: bool | nemo_microservices._types.Omit = omit,
custom_fields: Dict[str, object] | nemo_microservices._types.Omit = omit,
description: str | nemo_microservices._types.Omit = omit,
hf_token: str | nemo_microservices._types.Omit = omit,
models: nemo_microservices._types.SequenceNotStr[str] | nemo_microservices._types.Omit = omit,
name: str | nemo_microservices._types.Omit = omit,
namespace: str | nemo_microservices._types.Omit = omit,
ownership: nemo_microservices.types.shared_params.ownership.Ownership | nemo_microservices._types.Omit = omit,
project: str | nemo_microservices._types.Omit = omit,
extra_headers: nemo_microservices._types.Headers | None = None,
extra_query: nemo_microservices._types.Query | None = None,
extra_body: nemo_microservices._types.Body | None = None,
timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given,
) nemo_microservices.types.deployment.model_deployment.ModelDeployment#

Create a new deployment model_deployment.

Args: config: The deployment configuration.

async_enabled: Whether the async mode is enabled.

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

description: The description of the entity.

hf_token: Hugging Face authentication token for accessing private models and repositories. This token will be stored as a Kubernetes secret and mounted as an environment variable (HF_TOKEN) in the NIM deployment. The secret will be automatically cleaned up when the model deployment is deleted.

models: The models served by this deployment.

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

namespace: The if of 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.

project: The id of project associated with this entity.

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(
deployment_name: str,
*,
namespace: str,
extra_headers: nemo_microservices._types.Headers | None = None,
extra_query: nemo_microservices._types.Query | None = None,
extra_body: nemo_microservices._types.Body | None = None,
timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given,
) nemo_microservices.types.shared.delete_response.DeleteResponse#

Delete Model Deployment

Args: 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: nemo_microservices.types.deployment.model_deployment_filter_param.ModelDeploymentFilterParam | nemo_microservices._types.Omit = omit,
page: int | nemo_microservices._types.Omit = omit,
page_size: int | nemo_microservices._types.Omit = omit,
sort: nemo_microservices.types.shared.generic_sort_field.GenericSortField | nemo_microservices._types.Omit = omit,
extra_headers: nemo_microservices._types.Headers | None = None,
extra_query: nemo_microservices._types.Query | None = None,
extra_body: nemo_microservices._types.Body | None = None,
timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given,
) nemo_microservices.pagination.SyncDefaultPagination[nemo_microservices.types.deployment.model_deployment.ModelDeployment]#

List available deployment model_deployments.

Args: filter: Filter model_deployments on various criteria.

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

retrieve(
deployment_name: str,
*,
namespace: str,
extra_headers: nemo_microservices._types.Headers | None = None,
extra_query: nemo_microservices._types.Query | None = None,
extra_body: nemo_microservices._types.Body | None = None,
timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given,
) nemo_microservices.types.deployment.model_deployment.ModelDeployment#

Get info about a model deployment.

Args: 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(
deployment_name: str,
*,
namespace: str,
async_enabled: bool | nemo_microservices._types.Omit = omit,
config: nemo_microservices.types.deployment.model_deployment_update_params.Config | nemo_microservices._types.Omit = omit,
custom_fields: Dict[str, object] | nemo_microservices._types.Omit = omit,
description: str | nemo_microservices._types.Omit = omit,
hf_token: str | nemo_microservices._types.Omit = omit,
models: nemo_microservices._types.SequenceNotStr[str] | nemo_microservices._types.Omit = omit,
ownership: nemo_microservices.types.shared_params.ownership.Ownership | nemo_microservices._types.Omit = omit,
project: str | nemo_microservices._types.Omit = omit,
schema_version: str | nemo_microservices._types.Omit = omit,
extra_headers: nemo_microservices._types.Headers | None = None,
extra_query: nemo_microservices._types.Query | None = None,
extra_body: nemo_microservices._types.Body | None = None,
timeout: float | httpx.Timeout | None | nemo_microservices._types.NotGiven = not_given,
) nemo_microservices.types.deployment.model_deployment.ModelDeployment#

Update model deployment

Args: async_enabled: Whether the async mode is enabled.

config: The deployment configuration.

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

description: The description of the entity.

hf_token: Hugging Face authentication token for accessing private models and repositories. This token will be stored as a Kubernetes secret and mounted as an environment variable (HF_TOKEN) in the NIM deployment. The secret will be automatically cleaned up when the model deployment is deleted.

models: The models served by this deployment.

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.

project: The id of project associated with this entity.

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

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

property with_raw_response: nemo_microservices.resources.deployment.model_deployments.ModelDeploymentsResourceWithRawResponse#

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: nemo_microservices.resources.deployment.model_deployments.ModelDeploymentsResourceWithStreamingResponse#

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

class nemo_microservices.resources.deployment.model_deployments.ModelDeploymentsResourceWithRawResponse(
model_deployments: nemo_microservices.resources.deployment.model_deployments.ModelDeploymentsResource,
)#

Initialization

class nemo_microservices.resources.deployment.model_deployments.ModelDeploymentsResourceWithStreamingResponse(
model_deployments: nemo_microservices.resources.deployment.model_deployments.ModelDeploymentsResource,
)#

Initialization