CustomizationJob#

class nemo_microservices.types.customization.CustomizationJob(*args: Any, **kwargs: Any)

Bases: BaseModel

config: str | CustomizationConfig

The customization configuration template used.

dataset: str | DatasetCu | DatasetCuParam

The dataset to be used for customization.

hyperparameters: Hyperparameters

The hyperparameters to be used for customization.

id: str | None = None

The ID of the entity.

With the exception of namespaces, this is always a semantically-prefixed base58-encoded uuid4 [<prefix>-base58(uuid4())].

config_snapshot: CustomizationConfigJobValue | None = None

Config object as a value for CustomizationJob.config in /v1/customization/jobs

created_at: datetime | None = None

Timestamp for when the entity was created.

dataset_parameters: DatasetParameters | None = None

Additional parameters to configure a dataset.

description: str | None = None

The description of the entity.

integrations: List[WandBIntegration] | None = None

A list of third party integrations for a job.

Example: Weights & Biases integration.

namespace: str | None = None

The namespace of the entity.

This can be missing for namespace entities or in deployments that don’t use namespaces.

output_model: str | None = None

The output model.

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

ownership: Ownership | None = None

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: str | None = None

The URN of the project associated with this entity.

status: Literal['created', 'pending', 'running', 'cancelled', 'cancelling', 'failed', 'completed', 'ready', 'unknown'] | None = None

Normalized statuses for all jobs.

  • CREATED: The job is created, but not yet scheduled.

  • PENDING: The job is waiting for resource allocation.

  • RUNNING: The job is currently running.

  • CANCELLING: The job is being cancelled at the user’s request.

  • CANCELLED: The job has been cancelled by the user.

  • CANCELLING: The job is being cancelled at the user’s request.

  • FAILED: The job failed to execute and terminated.

  • COMPLETED: The job has completed successfully.

  • READY: The job is ready to be used.

  • UNKNOWN: The job status is unknown.

status_details: CustomizationStatusDetails | None = None

Detailed information about the customization

updated_at: datetime | None = None

Timestamp for when the entity was last updated.

warnings: List[JobWarning] | None = None

Warnings when creating a job.