`nemo_microservices.resources.customization.jobs`#

Module Contents#

Classes#

`AsyncJobsResource`
`AsyncJobsResourceWithRawResponse`
`AsyncJobsResourceWithStreamingResponse`
`JobsResource`
`JobsResourceWithRawResponse`
`JobsResourceWithStreamingResponse`

API#

class nemo_microservices.resources.customization.jobs.AsyncJobsResource( client: nemo_microservices._client.AsyncNeMoMicroservices, )#

Bases: nemo_microservices._resource.AsyncAPIResource

Initialization

async cancel( job_id: 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.customization.customization_job.CustomizationJob#

Cancel a customization job.

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 container_logs( job_id: 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.customization.job_logs.JobLogs#

List the metrics emitted from training.

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 create( *, config: nemo_microservices.types.customization.job_create_params.Config, dataset: nemo_microservices.types.customization.job_create_params.Dataset, hyperparameters: nemo_microservices.types.customization.hyperparameters_param.HyperparametersParam, custom_fields: Dict[str, str] | nemo_microservices._types.Omit = omit, dataset_parameters: nemo_microservices.types.customization.dataset_parameters_param.DatasetParametersParam | nemo_microservices._types.Omit = omit, description: str | nemo_microservices._types.Omit = omit, integrations: Iterable[nemo_microservices.types.customization.wand_b_integration_param.WandBIntegrationParam] | nemo_microservices._types.Omit = omit, name: str | nemo_microservices._types.Omit = omit, namespace: str | nemo_microservices._types.Omit = omit, output_model: 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, wandb_api_key: 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.customization.customization_job.CustomizationJob#

Create a new customization job.

Args: config: The customization configuration to be used.

dataset: The dataset to be used for customization.

hyperparameters: The hyperparameters to be used for customization.

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

dataset_parameters: Additional parameters to configure a dataset

description: The description of the entity.

integrations: A list of third party integrations for a job. Example: Weights & Biases integration.

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.

output_model: The output model. If not specified, no output model is created, only the artifact files written.

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 URN of the 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

List available customization jobs.

Args: filter: Filter jobs 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( job_id: 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.customization.customization_job.CustomizationJob#

Get info about a customization job.

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 status( job_id: 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.customization.customization_status_details.CustomizationStatusDetails#

List the metrics emitted from training.

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

property with_raw_response: nemo_microservices.resources.customization.jobs.AsyncJobsResourceWithRawResponse#

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.customization.jobs.AsyncJobsResourceWithStreamingResponse#

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.customization.jobs.AsyncJobsResourceWithRawResponse( jobs: nemo_microservices.resources.customization.jobs.AsyncJobsResource, )#: Initialization

class nemo_microservices.resources.customization.jobs.AsyncJobsResourceWithStreamingResponse( jobs: nemo_microservices.resources.customization.jobs.AsyncJobsResource, )#: Initialization

class nemo_microservices.resources.customization.jobs.JobsResource(client: nemo_microservices._client.NeMoMicroservices)#

Bases: nemo_microservices._resource.SyncAPIResource

Initialization

cancel( job_id: 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.customization.customization_job.CustomizationJob#

Cancel a customization job.

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

container_logs( job_id: 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.customization.job_logs.JobLogs#

List the metrics emitted from training.

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

create( *, config: nemo_microservices.types.customization.job_create_params.Config, dataset: nemo_microservices.types.customization.job_create_params.Dataset, hyperparameters: nemo_microservices.types.customization.hyperparameters_param.HyperparametersParam, custom_fields: Dict[str, str] | nemo_microservices._types.Omit = omit, dataset_parameters: nemo_microservices.types.customization.dataset_parameters_param.DatasetParametersParam | nemo_microservices._types.Omit = omit, description: str | nemo_microservices._types.Omit = omit, integrations: Iterable[nemo_microservices.types.customization.wand_b_integration_param.WandBIntegrationParam] | nemo_microservices._types.Omit = omit, name: str | nemo_microservices._types.Omit = omit, namespace: str | nemo_microservices._types.Omit = omit, output_model: 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, wandb_api_key: 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.customization.customization_job.CustomizationJob#

Create a new customization job.

Args: config: The customization configuration to be used.

dataset: The dataset to be used for customization.

hyperparameters: The hyperparameters to be used for customization.

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

dataset_parameters: Additional parameters to configure a dataset

description: The description of the entity.

integrations: A list of third party integrations for a job. Example: Weights & Biases integration.

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.

output_model: The output model. If not specified, no output model is created, only the artifact files written.

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 URN of the 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

list( *, filter: nemo_microservices.types.customization.customization_job_list_filter_param.CustomizationJobListFilterParam | 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.customization.customization_job.CustomizationJob]#

List available customization jobs.

Args: filter: Filter jobs 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( job_id: 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.customization.customization_job.CustomizationJob#

Get info about a customization job.

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

status( job_id: 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.customization.customization_status_details.CustomizationStatusDetails#

List the metrics emitted from training.

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

property with_raw_response: nemo_microservices.resources.customization.jobs.JobsResourceWithRawResponse#

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.customization.jobs.JobsResourceWithStreamingResponse#

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.customization.jobs.JobsResourceWithRawResponse( jobs: nemo_microservices.resources.customization.jobs.JobsResource, )#: Initialization

class nemo_microservices.resources.customization.jobs.JobsResourceWithStreamingResponse( jobs: nemo_microservices.resources.customization.jobs.JobsResource, )#: Initialization

nemo_microservices.resources.customization.jobs#

Module Contents#

Classes#

API#

`nemo_microservices.resources.customization.jobs`#