JobOperations Sınıf

JobOperations örneğini başlatır

Bu sınıf doğrudan örneklenmemelidir. Bunun yerine, MLClient nesnesinin jobs özniteliğini kullanın.

Devralma

azure.ai.ml._scope_dependent_operations._ScopeDependentOperations

JobOperations

Oluşturucu

JobOperations(operation_scope: OperationScope, operation_config: OperationConfig, service_client_02_2023_preview: AzureMachineLearningWorkspaces, all_operations: OperationsContainer, credential: TokenCredential, **kwargs: Any)

Parametreler

operation_scope

<xref:azure.ai.ml._scope_dependent_operations.OperationScope>

Gerekli

MLClient nesnesinin işlem sınıfları için kapsam değişkenleri.

operation_config

<xref:azure.ai.ml._scope_dependent_operations.OperationConfig>

Gerekli

MLClient nesnesinin işlem sınıfları için ortak yapılandırma.

service_client_02_2023_preview

<xref:azure.ai.ml._restclient.v2023_02_01_preview.AzureMachineLearningWorkspaces>

Gerekli

Son kullanıcıların Azure Machine Learning Çalışma Alanı kaynakları üzerinde çalışmasına izin veren hizmet istemcisi.

all_operations

<xref:azure.ai.ml._scope_dependent_operations.OperationsContainer>

Gerekli

MLClient nesnesinin tüm işlem sınıfları.

credential

TokenCredential

Gerekli

Kimlik doğrulaması için kullanılacak kimlik bilgileri.

Yöntemler

archive	Bir işi arşivler.
begin_cancel	bir işi iptal eder.
create_or_update	bir iş oluşturur veya güncelleştirir. Ortam veya Kod gibi varlıklar satır içinde tanımlanırsa, iş ile birlikte oluşturulur.
download	Bir işin günlüklerini ve çıkışını indirir.
get	bir iş kaynağı alır.
list	Çalışma alanında işleri listeler.
restore	Arşivlenmiş işi geri yükler.
show_services	bir işin düğümüyle ilişkili hizmetleri alır.
stream	Çalışan bir işin günlüklerini akışla aktarır.
validate	Not Bu deneysel bir yöntemdir ve herhangi bir zamanda değişebilir. Daha fazla bilgi için lütfen bkz. https://aka.ms/azuremlexperimental. Hizmete göndermeden önce bir İş nesnesini doğrular. Bileşen, Ortam ve Kod gibi satır içi tanımlı varlıklar varsa anonim varlıklar oluşturulabilir. Şu anda doğrulama için yalnızca işlem hattı işleri desteklenmektedir.

archive

Bir işi arşivler.

archive(name: str) -> None

Parametreler

name

str

Gerekli

İşin adı.

Özel durumlar

ResourceNotFoundError

Verilen ada sahip bir iş bulunamazsa oluşturulur.

Örnekler

Bir işi arşivleme.

   ml_client.jobs.archive(name=job_name)

begin_cancel

bir işi iptal eder.

begin_cancel(name: str, **kwargs) -> LROPoller[None]

Parametreler

name

str

Gerekli

İşin adı.

Döndürülenler

İşlem durumunu izlemek için bir poller.

Dönüş türü

LROPoller[None]

Özel durumlar

ResourceNotFoundError

Verilen ada sahip bir iş bulunamazsa oluşturulur.

create_or_update

bir iş oluşturur veya güncelleştirir. Ortam veya Kod gibi varlıklar satır içinde tanımlanırsa, iş ile birlikte oluşturulur.

create_or_update(job: Job, *, description: str | None = None, compute: str | None = None, tags: dict | None = None, experiment_name: str | None = None, skip_validation: bool = False, **kwargs) -> Job

Parametreler

job

Job

Gerekli

İş nesnesi.

description

Optional[str]

İş açıklaması.

compute

Optional[str]

İşin işlem hedefi.

tags

Optional[dict]

İşin etiketleri.

experiment_name

Optional[str]

İşin altında oluşturulacağı denemenin adı. Hiçbiri sağlanmışsa, iş 'Varsayılan' denemesi altında oluşturulur.

skip_validation

bool

İşi oluşturmadan veya güncelleştirmeden önce doğrulamanın atlanıp atlanmayacağını belirtir. Anonim bileşen gibi bağımlı kaynaklar için doğrulamanın atlanmayacağını unutmayın. Varsayılan değer False'tur.

Döndürülenler

İş oluşturuldu veya güncelleştirildi.

Dönüş türü

Job

Özel durumlar

Union

UserErrorException

ValidationException

İş başarıyla doğrulanamazsa oluşturulur. Ayrıntılar hata iletisinde sağlanacaktır.

AssetException

İş varlıkları (ör. Veri, Kod, Model, Ortam) başarıyla doğrulanamazsa oluşturulur. Ayrıntılar hata iletisinde sağlanacaktır.

ModelException

İş modeli başarıyla doğrulanamazsa oluşturulur. Ayrıntılar hata iletisinde sağlanacaktır.

JobException

İş nesnesi veya öznitelikleri doğru biçimlendirilmişse oluşturulur. Ayrıntılar hata iletisinde sağlanacaktır.

EmptyDirectoryError

Sağlanan yerel yol boş bir dizine işaret ederse oluşturulur.

DockerEngineNotAvailableError

Docker Altyapısı yerel iş için kullanılamıyorsa oluşturulur.

Örnekler

Yeni bir iş oluşturma ve ardından işlem güncelleştirme.

   from azure.ai.ml import load_job

   created_job = ml_client.jobs.create_or_update(
       name=job_name,
       job=load_job(
           "./sdk/ml/azure-ai-ml/tests/test_configs/command_job/command_job_test_local_env.yml",
           params_override=[{"name": job_name}, {"compute": "cpucluster"}],
       ),
   )

download

Bir işin günlüklerini ve çıkışını indirir.

download(name: str, *, download_path: PathLike | str = '.', output_name: str | None = None, all: bool = False) -> None

Parametreler

name

str

Gerekli

bir işin adı.

download_path

Union[<xref:PathLike>, str]

İndirme hedefi olarak kullanılacak yerel yol. Varsayılan değer "." olur.

output_name

Optional[str]

İndirilmesi gereken çıkışın adı. Varsayılan değer Yok'tır.

all

bool

Tüm günlüklerin ve adlandırılmış çıkışların indirilip indirilmemesi gerektiğini belirtir. Varsayılan değer False'tur.

Özel durumlar

JobException

İş henüz terminal durumunda değilse oluşturulur. Ayrıntılar hata iletisinde sağlanacaktır.

MlException

Günlükler ve çıkışlar başarıyla indirilemiyorsa oluşturulur. Ayrıntılar hata iletisinde sağlanacaktır.

Örnekler

"job-1" işinin tüm günlüklerini ve adlandırılmış çıkışlarını "job-1-logs" yerel dizinine indirme.

   ml_client.jobs.download(name=job_name, download_path="./job-1-logs", all=True)

get

bir iş kaynağı alır.

get(name: str) -> Job

Parametreler

name

str

Gerekli

İşin adı.

Döndürülenler

Hizmetten alınan iş nesnesi.

Dönüş türü

Job

Özel durumlar

ResourceNotFoundError

Verilen ada sahip bir iş bulunamazsa oluşturulur.

UserErrorException

Ad parametresi bir dize değilse oluşturulur.

Örnekler

"iris-dataset-job-1" adlı bir iş alınıyor.

   retrieved_job = ml_client.jobs.get(job_name)

list

Çalışma alanında işleri listeler.

list(*, parent_job_name: str | None = None, list_view_type: ListViewType = ListViewType.ACTIVE_ONLY, **kwargs) -> Iterable[Job]

Parametreler

parent_job_name

Optional[str]

Sağlandığında, yalnızca adlandırılmış işin alt öğeleri olan işleri döndürür. Varsayılan olarak Yok olur ve çalışma alanında tüm işler listelenir.

list_view_type

ListViewType

Arşivlenmiş işleri dahil etme/dışlama için görünüm türü. Arşivlenmiş işler hariç~ azure.mgt.machinelearningservices.models.ListViewType.ACTIVE_ONLY varsayılan olarak ayarlanır.

Döndürülenler

İş nesnelerinin yineleyici benzeri bir örneği.

Dönüş türü

ItemPaged[Job]

Özel durumlar

ResourceNotFoundError

Verilen ada sahip bir iş bulunamazsa oluşturulur.

Örnekler

"iris-dataset-jobs" adlı üst işe sahip bir çalışma alanında arşivlenen işlerin listesini alma.

   from azure.ai.ml._restclient.v2023_04_01_preview.models import ListViewType

   list_of_jobs = ml_client.jobs.list(parent_job_name=job_name, list_view_type=ListViewType.ARCHIVED_ONLY)

restore

Arşivlenmiş işi geri yükler.

restore(name: str) -> None

Parametreler

name

str

Gerekli

İşin adı.

Özel durumlar

ResourceNotFoundError

Verilen ada sahip bir iş bulunamazsa oluşturulur.

Örnekler

Arşivlenmiş işi geri yükleme.

   ml_client.jobs.restore(name=job_name)

show_services

bir işin düğümüyle ilişkili hizmetleri alır.

show_services(name: str, node_index: int = 0) -> Dict[str, ServiceInstance]

Parametreler

name

str

Gerekli

İşin adı.

node_index

int

Gerekli

Düğümün dizini (sıfır tabanlı). Varsayılan değer 0'dır.

Döndürülenler

Verilen düğüm için işle ilişkili hizmetler.

Dönüş türü

dict[str, ServiceInstance]

Özel durumlar

ResourceNotFoundError

Verilen ada sahip bir iş bulunamazsa oluşturulur.

Örnekler

bir işin 1. düğümüyle ilişkili hizmetleri alma.

   job_services = ml_client.jobs.show_services(job_name)

stream

Çalışan bir işin günlüklerini akışla aktarır.

stream(name: str) -> None

Parametreler

name

str

Gerekli

İşin adı.

Özel durumlar

ResourceNotFoundError

Verilen ada sahip bir iş bulunamazsa oluşturulur.

Örnekler

Çalışan bir işin akışını sağlama.

   running_job = ml_client.jobs.create_or_update(
       load_job(
           "./sdk/ml/azure-ai-ml/tests/test_configs/command_job/command_job_test_local_env.yml",
           params_override=[{"name": job_name}, {"compute": "cpucluster"}],
       )
   )
   ml_client.jobs.stream(running_job.name)

validate

Not

Bu deneysel bir yöntemdir ve herhangi bir zamanda değişebilir. Daha fazla bilgi için lütfen bkz. https://aka.ms/azuremlexperimental.

Hizmete göndermeden önce bir İş nesnesini doğrular. Bileşen, Ortam ve Kod gibi satır içi tanımlı varlıklar varsa anonim varlıklar oluşturulabilir. Şu anda doğrulama için yalnızca işlem hattı işleri desteklenmektedir.

validate(job: Job, *, raise_on_failure: bool = False, **kwargs) -> ValidationResult

Parametreler

job

Job

Gerekli

Doğrulanacak iş nesnesi.

raise_on_failure

bool

Doğrulama başarısız olursa hatanın tetiklenip tetiklenmemesi gerektiğini belirtir. Varsayılan değer False'tur.

Döndürülenler

Bulunan tüm hataları içeren bir ValidationResult nesnesi.

Dönüş türü

ValidationResult

Özel durumlar

ResourceNotFoundError

Verilen ada sahip bir iş bulunamazsa oluşturulur.

Örnekler

PipelineJob nesnesini doğrulama ve bulunan hataları yazdırma.

   from azure.ai.ml import load_job
   from azure.ai.ml.entities import PipelineJob

   pipeline_job: PipelineJob = load_job(
       "./sdk/ml/azure-ai-ml/tests/test_configs/pipeline_jobs/invalid/combo.yml",
       params_override=[{"name": job_name}, {"compute": "cpucluster"}],
   )
   print(ml_client.jobs.validate(pipeline_job).error_messages)