Customization Jobs Resource#

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

Bases: SyncAPIResource

property with_raw_response: 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: 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

create( *, config: job_create_params.Config, dataset: job_create_params.Dataset, hyperparameters: HyperparametersParam, dataset_parameters: DatasetParametersParam | NotGiven = NOT_GIVEN, description: str | NotGiven = NOT_GIVEN, integrations: Iterable[WandBIntegrationParam] | NotGiven = NOT_GIVEN, name: str | NotGiven = NOT_GIVEN, output_model: str | NotGiven = NOT_GIVEN, ownership: Ownership | NotGiven = NOT_GIVEN, project: str | NotGiven = NOT_GIVEN, wandb_api_key: str | 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, ) → CustomizationJob#

Create a new customization job.

Parameters:

config – The customization configuration to be used.
dataset – The dataset to be used for customization.
hyperparameters – The hyperparameters to be used for customization.
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.
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

Get info about a customization job.

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

List available customization jobs.

Parameters:

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

Cancel a customization job.

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

List the metrics emitted from training.

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

List the metrics emitted from training.

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.customization.AsyncJobsResource(client: AsyncNeMoMicroservices)#

Bases: AsyncAPIResource

property with_raw_response: 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: 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

async create( *, config: job_create_params.Config, dataset: job_create_params.Dataset, hyperparameters: HyperparametersParam, dataset_parameters: DatasetParametersParam | NotGiven = NOT_GIVEN, description: str | NotGiven = NOT_GIVEN, integrations: Iterable[WandBIntegrationParam] | NotGiven = NOT_GIVEN, name: str | NotGiven = NOT_GIVEN, output_model: str | NotGiven = NOT_GIVEN, ownership: Ownership | NotGiven = NOT_GIVEN, project: str | NotGiven = NOT_GIVEN, wandb_api_key: str | 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, ) → CustomizationJob#

Create a new customization job.

Parameters:

config – The customization configuration to be used.
dataset – The dataset to be used for customization.
hyperparameters – The hyperparameters to be used for customization.
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.
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

Get info about a customization job.

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

List available customization jobs.

Parameters:

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

Cancel a customization job.

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

List the metrics emitted from training.

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

List the metrics emitted from training.

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#