JobOperations Klas

Start een exemplaar van JobOperations

Deze klasse mag niet rechtstreeks worden geïnstantieerd. Gebruik in plaats daarvan het kenmerk jobs van een MLClient-object.

Overname

azure.ai.ml._scope_dependent_operations._ScopeDependentOperations

JobOperations

Constructor

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

Parameters

operation_scope

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

Vereist

Bereikvariabelen voor de bewerkingsklassen van een MLClient-object.

operation_config

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

Vereist

Algemene configuratie voor bewerkingsklassen van een MLClient-object.

service_client_02_2023_preview

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

Vereist

Serviceclient om eindgebruikers in staat te stellen te werken op Azure Machine Learning-werkruimteresources.

all_operations

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

Vereist

Alle bewerkingsklassen van een MLClient-object.

credential

TokenCredential

Vereist

Referenties die moeten worden gebruikt voor verificatie.

Methoden

archive	Archiveert een baan.
begin_cancel	Hiermee annuleert u een taak.
create_or_update	Hiermee maakt of werkt u een taak bij. Als entiteiten zoals Omgeving of Code inline worden gedefinieerd, worden ze samen met de taak gemaakt.
download	Hiermee downloadt u de logboeken en uitvoer van een taak.
get	Hiermee haalt u een taakresource op.
list	Een lijst met taken in de werkruimte.
restore	Hiermee herstelt u een gearchiveerde taak.
show_services	Hiermee haalt u services op die zijn gekoppeld aan het knooppunt van een taak.
stream	Streamt de logboeken van een actieve taak.
validate	Notitie Dit is een experimentele methode en kan op elk gewenst moment worden gewijzigd. Zie https://aka.ms/azuremlexperimental voor meer informatie. Hiermee valideert u een taakobject voordat deze naar de service wordt verzonden. Anonieme assets kunnen worden gemaakt als er inline gedefinieerde entiteiten zijn, zoals Onderdeel, Omgeving en Code. Alleen pijplijntaken worden momenteel ondersteund voor validatie.

archive

Archiveert een baan.

archive(name: str) -> None

Parameters

name

str

Vereist

De naam van de taak.

Uitzonderingen

ResourceNotFoundError

Gegenereerd als er geen taak met de opgegeven naam kan worden gevonden.

Voorbeelden

Een taak archiveren.

   ml_client.jobs.archive(name=job_name)

begin_cancel

Hiermee annuleert u een taak.

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

Parameters

name

str

Vereist

De naam van de taak.

Retouren

Een poller om de bewerkingsstatus bij te houden.

Retourtype

LROPoller[None]

Uitzonderingen

ResourceNotFoundError

Gegenereerd als er geen taak met de opgegeven naam kan worden gevonden.

create_or_update

Hiermee maakt of werkt u een taak bij. Als entiteiten zoals Omgeving of Code inline worden gedefinieerd, worden ze samen met de taak gemaakt.

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

Parameters

job

Job

Vereist

Het taakobject.

description

Optional[str]

De functiebeschrijving.

compute

Optional[str]

Het rekendoel voor de taak.

tags

Optional[dict]

De tags voor de taak.

experiment_name

Optional[str]

De naam van het experiment waaronder de taak wordt gemaakt. Als Geen is opgegeven, wordt de taak gemaakt onder experiment 'Standaard'.

skip_validation

bool

Hiermee geeft u op of validatie moet worden overgeslagen voordat u de taak maakt of bijwerkt. Houd er rekening mee dat validatie voor afhankelijke resources, zoals een anoniem onderdeel, niet wordt overgeslagen. Standaard ingesteld op False.

Retouren

Gemaakte of bijgewerkte taak.

Retourtype

Job

Uitzonderingen

Union

UserErrorException

ValidationException

Gegenereerd als de taak niet kan worden gevalideerd. Details worden opgegeven in het foutbericht.

AssetException

Gegenereerd als taakassets (bijvoorbeeld gegevens, code, model, omgeving) niet kunnen worden gevalideerd. Details worden opgegeven in het foutbericht.

ModelException

Gegenereerd als het taakmodel niet kan worden gevalideerd. Details worden opgegeven in het foutbericht.

JobException

Gegenereerd als taakobject of -kenmerken correct zijn opgemaakt. Details worden opgegeven in het foutbericht.

EmptyDirectoryError

Wordt gegenereerd als het opgegeven lokale pad verwijst naar een lege map.

DockerEngineNotAvailableError

Gegenereerd als Docker Engine niet beschikbaar is voor een lokale taak.

Voorbeelden

Een nieuwe taak maken en vervolgens de berekening bijwerken.

   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

Hiermee downloadt u de logboeken en uitvoer van een taak.

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

Parameters

name

str

Vereist

De naam van een taak.

download_path

Union[<xref:PathLike>, str]

Het lokale pad dat moet worden gebruikt als downloadbestemming. Standaard ingesteld op '.'.

output_name

Optional[str]

De naam van de uitvoer die moet worden gedownload. De standaardwaarde is Geen.

all

bool

Hiermee geeft u op of alle logboeken en benoemde uitvoer moeten worden gedownload. Standaard ingesteld op False.

Uitzonderingen

JobException

Gegenereerd als de taak zich nog niet in een terminale status bevindt. Details worden opgegeven in het foutbericht.

MlException

Gegenereerd als logboeken en uitvoer niet kunnen worden gedownload. Details worden opgegeven in het foutbericht.

Voorbeelden

Het downloaden van alle logboeken en benoemde uitvoer van de taak 'job-1' in de lokale map 'job-1-logs'.

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

get

Hiermee haalt u een taakresource op.

get(name: str) -> Job

Parameters

name

str

Vereist

De naam van de taak.

Retouren

Taakobject opgehaald uit de service.

Retourtype

Job

Uitzonderingen

ResourceNotFoundError

Gegenereerd als er geen taak met de opgegeven naam kan worden gevonden.

UserErrorException

Wordt gegenereerd als de naamparameter geen tekenreeks is.

Voorbeelden

Een taak met de naam iris-dataset-job-1 ophalen.

   retrieved_job = ml_client.jobs.get(job_name)

list

Een lijst met taken in de werkruimte.

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

Parameters

parent_job_name

Optional[str]

Indien opgegeven, worden alleen taken geretourneerd die onderliggende elementen van de benoemde taak zijn. De standaardwaarde is Geen, waarbij alle taken in de werkruimte worden weergegeven.

list_view_type

ListViewType

Het weergavetype voor het opnemen/uitsluiten van gearchiveerde taken. De standaardwaarde is ~azure.mgt.machinelearningservices.models.ListViewType.ACTIVE_ONLY, met uitzondering van gearchiveerde taken.

Retouren

Een iterator-achtig exemplaar van taakobjecten.

Retourtype

ItemPaged[Job]

Uitzonderingen

ResourceNotFoundError

Gegenereerd als er geen taak met de opgegeven naam kan worden gevonden.

Voorbeelden

Een lijst met gearchiveerde taken ophalen in een werkruimte met de bovenliggende taak met de naam 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

Hiermee herstelt u een gearchiveerde taak.

restore(name: str) -> None

Parameters

name

str

Vereist

De naam van de taak.

Uitzonderingen

ResourceNotFoundError

Gegenereerd als er geen taak met de opgegeven naam kan worden gevonden.

Voorbeelden

Een gearchiveerde taak herstellen.

   ml_client.jobs.restore(name=job_name)

show_services

Hiermee haalt u services op die zijn gekoppeld aan het knooppunt van een taak.

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

Parameters

name

str

Vereist

De naam van de taak.

node_index

int

Vereist

De index van het knooppunt (op basis van nul). De standaardwaarde is 0.

Retouren

De services die zijn gekoppeld aan de taak voor het opgegeven knooppunt.

Retourtype

dict[str, ServiceInstance]

Uitzonderingen

ResourceNotFoundError

Gegenereerd als er geen taak met de opgegeven naam kan worden gevonden.

Voorbeelden

De services ophalen die zijn gekoppeld aan het 1e knooppunt van een taak.

   job_services = ml_client.jobs.show_services(job_name)

stream

Streamt de logboeken van een actieve taak.

stream(name: str) -> None

Parameters

name

str

Vereist

De naam van de taak.

Uitzonderingen

ResourceNotFoundError

Gegenereerd als er geen taak met de opgegeven naam kan worden gevonden.

Voorbeelden

Een actieve taak streamen.

   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

Notitie

Dit is een experimentele methode en kan op elk gewenst moment worden gewijzigd. Zie https://aka.ms/azuremlexperimental voor meer informatie.

Hiermee valideert u een taakobject voordat deze naar de service wordt verzonden. Anonieme assets kunnen worden gemaakt als er inline gedefinieerde entiteiten zijn, zoals Onderdeel, Omgeving en Code. Alleen pijplijntaken worden momenteel ondersteund voor validatie.

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

Parameters

job

Job

Vereist

Het taakobject dat moet worden gevalideerd.

raise_on_failure

bool

Hiermee geeft u op of een fout moet worden gegenereerd als de validatie mislukt. Standaard ingesteld op False.

Retouren

Een ValidationResult-object met alle gevonden fouten.

Retourtype

ValidationResult

Uitzonderingen

ResourceNotFoundError

Gegenereerd als er geen taak met de opgegeven naam kan worden gevonden.

Voorbeelden

Een PipelineJob-object valideren en de gevonden fouten afdrukken.

   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)