JobOperations Klasa

Inicjuje wystąpienie funkcji JobOperations

Nie należy bezpośrednio utworzyć wystąpienia tej klasy. Zamiast tego należy użyć atrybutu jobs obiektu MLClient.

Dziedziczenie

azure.ai.ml._scope_dependent_operations._ScopeDependentOperations

JobOperations

Konstruktor

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

Parametry

operation_scope

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

Wymagane

Zmienne zakresu dla klas operacji obiektu MLClient.

operation_config

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

Wymagane

Typowa konfiguracja dla klas operacji obiektu MLClient.

service_client_02_2023_preview

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

Wymagane

Klient usługi umożliwia użytkownikom końcowym korzystanie z zasobów obszaru roboczego usługi Azure Machine Learning.

all_operations

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

Wymagane

Wszystkie klasy operacji obiektu MLClient.

credential

TokenCredential

Wymagane

Poświadczenia do użycia na potrzeby uwierzytelniania.

Metody

archive	Archiwizuje zadanie.
begin_cancel	Anuluje zadanie.
create_or_update	Tworzy lub aktualizuje zadanie. Jeśli jednostki, takie jak Środowisko lub Kod, są zdefiniowane w tekście, zostaną utworzone razem z zadaniem.
download	Pobiera dzienniki i dane wyjściowe zadania.
get	Pobiera zasób zadania.
list	Wyświetla listę zadań w obszarze roboczym.
restore	Przywraca zarchiwizowane zadanie.
show_services	Pobiera usługi skojarzone z węzłem zadania.
stream	Przesyła strumieniowo dzienniki uruchomionego zadania.
validate	Uwaga Jest to metoda eksperymentalna i może ulec zmianie w dowolnym momencie. Aby uzyskać więcej informacji, zobacz https://aka.ms/azuremlexperimental. Sprawdza poprawność obiektu zadania przed przesłaniem do usługi. Zasoby anonimowe mogą być tworzone, jeśli istnieją wbudowane zdefiniowane jednostki, takie jak Składnik, Środowisko i Kod. Obecnie tylko zadania potoku są obsługiwane na potrzeby walidacji.

archive

Archiwizuje zadanie.

archive(name: str) -> None

Parametry

name

str

Wymagane

Nazwa zadania.

Wyjątki

ResourceNotFoundError

Podniesione, jeśli nie można odnaleźć zadania o podanej nazwie.

Przykłady

Archiwizowanie zadania.

   ml_client.jobs.archive(name=job_name)

begin_cancel

Anuluje zadanie.

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

Parametry

name

str

Wymagane

Nazwa zadania.

Zwraca

Poller do śledzenia stanu operacji.

Typ zwracany

LROPoller[None]

Wyjątki

ResourceNotFoundError

Podniesione, jeśli nie można odnaleźć zadania o podanej nazwie.

create_or_update

Tworzy lub aktualizuje zadanie. Jeśli jednostki, takie jak Środowisko lub Kod, są zdefiniowane w tekście, zostaną utworzone razem z zadaniem.

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

Parametry

job

Job

Wymagane

Obiekt zadania.

description

Optional[str]

Opis zadania.

compute

Optional[str]

Docelowy obiekt obliczeniowy zadania.

tags

Optional[dict]

Tagi zadania.

experiment_name

Optional[str]

Nazwa eksperymentu, w ramach których zostanie utworzone zadanie. Jeśli parametr Brak zostanie podany, zadanie zostanie utworzone w ramach eksperymentu "Default".

skip_validation

bool

Określa, czy należy pominąć walidację przed utworzeniem lub zaktualizowaniem zadania. Należy pamiętać, że weryfikacja zasobów zależnych, takich jak składnik anonimowy, nie zostanie pominięta. Wartość domyślna to False.

Zwraca

Utworzono lub zaktualizowano zadanie.

Typ zwracany

Job

Wyjątki

Union

UserErrorException

ValidationException

Podniesione, jeśli nie można pomyślnie zweryfikować zadania. Szczegóły zostaną podane w komunikacie o błędzie.

AssetException

Podniesione, jeśli nie można pomyślnie zweryfikować zasobów zadania (np. danych, kodu, modelu, środowiska). Szczegóły zostaną podane w komunikacie o błędzie.

ModelException

Zgłoszone, jeśli nie można pomyślnie zweryfikować modelu zadań. Szczegóły zostaną podane w komunikacie o błędzie.

JobException

Zgłaszane, jeśli obiekt zadania lub atrybuty są poprawnie sformatowane. Szczegóły zostaną podane w komunikacie o błędzie.

EmptyDirectoryError

Podniesiono, jeśli ścieżka lokalna wskazuje pusty katalog.

DockerEngineNotAvailableError

Zgłaszane, jeśli aparat platformy Docker nie jest dostępny dla zadania lokalnego.

Przykłady

Utworzenie nowego zadania, a następnie zaktualizowanie jego zasobów obliczeniowych.

   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

Pobiera dzienniki i dane wyjściowe zadania.

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

Parametry

name

str

Wymagane

Nazwa zadania.

download_path

Union[<xref:PathLike>, str]

Ścieżka lokalna, która ma być używana jako miejsce docelowe pobierania. Wartość domyślna to ".".

output_name

Optional[str]

Nazwa danych wyjściowych do pobrania. Wartość domyślna to None (Brak).

all

bool

Określa, czy należy pobrać wszystkie dzienniki i nazwane dane wyjściowe. Wartość domyślna to False.

Wyjątki

JobException

Podniesione, jeśli zadanie nie jest jeszcze w stanie terminalu. Szczegóły zostaną podane w komunikacie o błędzie.

MlException

Zgłaszane, jeśli nie można pomyślnie pobrać dzienników i danych wyjściowych. Szczegóły zostaną podane w komunikacie o błędzie.

Przykłady

Pobranie wszystkich dzienników i nazwanych danych wyjściowych zadania "job-1" do katalogu lokalnego "job-1-logs".

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

get

Pobiera zasób zadania.

get(name: str) -> Job

Parametry

name

str

Wymagane

Nazwa zadania.

Zwraca

Obiekt zadania pobrany z usługi.

Typ zwracany

Job

Wyjątki

ResourceNotFoundError

Podniesione, jeśli nie można odnaleźć zadania o podanej nazwie.

UserErrorException

Zgłaszane, jeśli parametr name nie jest ciągiem.

Przykłady

Pobieranie zadania o nazwie "iris-dataset-job-1".

   retrieved_job = ml_client.jobs.get(job_name)

list

Wyświetla listę zadań w obszarze roboczym.

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

Parametry

parent_job_name

Optional[str]

Po podaniu funkcja zwraca tylko zadania podrzędne nazwanego zadania. Domyślnie ma wartość Brak, wyświetlając listę wszystkich zadań w obszarze roboczym.

list_view_type

ListViewType

Typ widoku dla dołączania/wykluczania zarchiwizowanych zadań. Wartość domyślna to ~azure.mgt.machinelearningservices.models.ListViewType.ACTIVE_ONLY z wyłączeniem zarchiwizowanych zadań.

Zwraca

Wystąpienie podobne do iteratora obiektów zadania.

Typ zwracany

ItemPaged[Job]

Wyjątki

ResourceNotFoundError

Podniesione, jeśli nie można odnaleźć zadania o podanej nazwie.

Przykłady

Pobieranie listy zarchiwizowanych zadań w obszarze roboczym z zadaniem nadrzędnym o nazwie "iris-dataset-jobs".

   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

Przywraca zarchiwizowane zadanie.

restore(name: str) -> None

Parametry

name

str

Wymagane

Nazwa zadania.

Wyjątki

ResourceNotFoundError

Podniesione, jeśli nie można odnaleźć zadania o podanej nazwie.

Przykłady

Przywracanie zarchiwizowanego zadania.

   ml_client.jobs.restore(name=job_name)

show_services

Pobiera usługi skojarzone z węzłem zadania.

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

Parametry

name

str

Wymagane

Nazwa zadania.

node_index

int

Wymagane

Indeks węzła (oparty na zerze). Wartość domyślna to 0.

Zwraca

Usługi skojarzone z zadaniem dla danego węzła.

Typ zwracany

dict[str, ServiceInstance]

Wyjątki

ResourceNotFoundError

Podniesione, jeśli nie można odnaleźć zadania o podanej nazwie.

Przykłady

Pobieranie usług skojarzonych z węzłem 1 zadania.

   job_services = ml_client.jobs.show_services(job_name)

stream

Przesyła strumieniowo dzienniki uruchomionego zadania.

stream(name: str) -> None

Parametry

name

str

Wymagane

Nazwa zadania.

Wyjątki

ResourceNotFoundError

Podniesione, jeśli nie można odnaleźć zadania o podanej nazwie.

Przykłady

Przesyłanie strumieniowe uruchomionego zadania.

   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

Uwaga

Jest to metoda eksperymentalna i może ulec zmianie w dowolnym momencie. Aby uzyskać więcej informacji, zobacz https://aka.ms/azuremlexperimental.

Sprawdza poprawność obiektu zadania przed przesłaniem do usługi. Zasoby anonimowe mogą być tworzone, jeśli istnieją wbudowane zdefiniowane jednostki, takie jak Składnik, Środowisko i Kod. Obecnie tylko zadania potoku są obsługiwane na potrzeby walidacji.

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

Parametry

job

Job

Wymagane

Obiekt zadania, który ma zostać zweryfikowany.

raise_on_failure

bool

Określa, czy w przypadku niepowodzenia walidacji powinien zostać zgłoszony błąd. Wartość domyślna to False.

Zwraca

Obiekt ValidationResult zawierający wszystkie znalezione błędy.

Typ zwracany

ValidationResult

Wyjątki

ResourceNotFoundError

Podniesione, jeśli nie można odnaleźć zadania o podanej nazwie.

Przykłady

Sprawdzanie poprawności obiektu PipelineJob i drukowanie znalezionych błędów.

   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)