PipelineJob Třída

Úloha kanálu.

Neměli byste vytvořit instanci této třídy přímo. Místo toho byste měli k vytvoření úlohy PipelineJob použít dekorátor @pipeline.

] :p aram compute: Název cílového výpočetního objektu vytvořeného kanálu. Výchozí hodnota je None :type compute: str :p aram tags: Tag dictionary. Značky je možné přidávat, odebírat a aktualizovat. Defaults to None :type tags: dict[str, str] :p aram kwargs: Slovník dalších parametrů konfigurace. Výchozí hodnota : type kwargs: dict

Dědičnost

azure.ai.ml.entities._job.job.Job

PipelineJob

azure.ai.ml.entities._mixins.YamlTranslatableMixin

PipelineJob

azure.ai.ml.entities._job.pipeline._io.mixin.PipelineJobIOMixin

PipelineJob

azure.ai.ml.entities._validation.path_aware_schema.PathAwareSchemaValidatableMixin

PipelineJob

Konstruktor

PipelineJob(*, component: str | PipelineComponent | None = None, inputs: Dict[str, int | str | float | bool | Input] | None = None, outputs: Dict[str, Output] | None = None, name: str | None = None, description: str | None = None, display_name: str | None = None, experiment_name: str | None = None, jobs: Dict[str, BaseNode] | None = None, settings: PipelineJobSettings | None = None, identity: ManagedIdentityConfiguration | AmlTokenConfiguration | UserIdentityConfiguration | None = None, compute: str | None = None, tags: Dict[str, str] | None = None, **kwargs)

Parametry

component

Union[str, PipelineComponent]

Vyžadováno

Verze součásti kanálu. Pole se vzájemně vylučuje s "úlohami".

inputs

dict[str, Union[<xref:azure.ai.ml.entities.Input>, str, bool, int, float]]

Vyžadováno

Vstupy do úlohy kanálu.

outputs

dict[str, <xref:azure.ai.ml.entities.Output>]

Vyžadováno

Výstupy úlohy kanálu.

name

str

Vyžadováno

Název úlohy kanálu. Výchozí hodnota není žádná.

description

str

Vyžadováno

Popis úlohy kanálu Výchozí hodnota není žádná.

display_name

str

Vyžadováno

Zobrazovaný název úlohy kanálu Výchozí hodnota není žádná.

experiment_name

str

Vyžadováno

Název experimentu, ve které bude úloha vytvořena. Pokud je zadaný žádný, experiment se nastaví na aktuální adresář. Výchozí hodnota není žádná.

jobs

dict[str, <xref:azure.ai.ml.entities._builders.BaseNode>]

Vyžadováno

Název uzlu komponenty kanálu do objektu komponenty. Výchozí hodnota není žádná.

settings

PipelineJobSettings

Vyžadováno

Nastavení úlohy kanálu Výchozí hodnota není žádná.

identity

Union[ ManagedIdentityConfiguration, AmlTokenConfiguration, UserIdentityConfiguration

Vyžadováno

Identita, kterou bude trénovací úloha používat při běhu na výpočetních prostředcích Výchozí hodnota není žádná.

Příklady

Ukazuje, jak vytvořit kanál pomocí této třídy.

   from azure.ai.ml.entities import PipelineJob, PipelineJobSettings

   pipeline_job = PipelineJob(
       description="test pipeline job",
       tags={},
       display_name="test display name",
       experiment_name="pipeline_job_samples",
       properties={},
       settings=PipelineJobSettings(force_rerun=True, default_compute="cpu-cluster"),
       jobs={"component1": component_func(component_in_number=1.0, component_in_path=uri_file_input)},
   )
   ml_client.jobs.create_or_update(pipeline_job)

Metody

dump	Vytvoří výpis obsahu úlohy do souboru ve formátu YAML.

dump

Vytvoří výpis obsahu úlohy do souboru ve formátu YAML.

dump(dest: str | PathLike | IO, **kwargs) -> None

Parametry

dest

Union[<xref:PathLike>, str, IO[AnyStr]]

Vyžadováno

Místní cesta nebo datový proud souboru, do které chcete zapsat obsah YAML. Pokud je dest cesta k souboru, vytvoří se nový soubor. Pokud je soubor dest otevřený, zapíše se přímo do souboru.

kwargs

dict

Další argumenty, které se mají předat serializátoru YAML.

Výjimky

FileExistsError

Vyvolána, pokud je dest cesta k souboru a soubor již existuje.

IOError

Vyvolána, pokud je soubor dest otevřený a soubor není zapisovatelný.

Atributy

base_path

Základní cesta prostředku.

Návraty

Základní cesta prostředku.

Návratový typ

str

creation_context

Kontext vytvoření prostředku.

Návraty

Metadata vytvoření prostředku.

Návratový typ

Optional[SystemData]

id

ID prostředku.

Návraty

Globální ID prostředku, ID Azure Resource Manager (ARM).

Návratový typ

Optional[str]

inputs

Vstupy úlohy kanálu.

Návraty

Vstupy úlohy kanálu.

Návratový typ

dict[str, Union[Input, str, bool, int, float]]

jobs

Vrácení úloh kanálu

Návraty

Úlohy úlohy kanálu.

Návratový typ

dict

log_files

Výstupní soubory úlohy.

Návraty

Slovník názvů protokolů a adres URL.

Návratový typ

Optional[Dict[str, str]]

outputs

Výstupy úlohy kanálu.

Návraty

Výstupy úlohy kanálu.

Návratový typ

dict[str, Union[str, Output]]

settings

Nastavení úlohy kanálu.

Návraty

Nastavení úlohy kanálu.

Návratový typ

PipelineJobSettings

status

Stav úlohy.

Mezi běžné vrácené hodnoty patří "Spuštěno", "Dokončeno" a "Selhání". Všechny možné hodnoty jsou:

• NotStarted – jedná se o dočasný stav, ve který jsou objekty Spuštění na straně klienta před odesláním do cloudu.

• Spuštění – Spuštění se začalo zpracovávat v cloudu. Volající má v tuto chvíli ID spuštění.

• Zřizování – pro odeslání dané úlohy se vytváří výpočetní prostředky na vyžádání.

• Příprava – Prostředí spuštění se připravuje a je v jedné ze dvou fází:

  • Sestavení image Dockeru

  • Nastavení prostředí conda

• Ve frontě – úloha je zařazená do fronty v cílovém výpočetním objektu. Například ve službě BatchAI je úloha ve stavu zařazená do fronty.

  při čekání na připravenost všech požadovaných uzlů.

• Spuštěno – Úloha se začala spouštět na cílovém výpočetním objektu.

• Finalizace – Spuštění uživatelského kódu bylo dokončeno a spuštění je ve fázích následného zpracování.

• CancelRequested – pro úlohu bylo požadováno zrušení.

• Dokončeno – spuštění bylo úspěšně dokončeno. To zahrnuje jak spuštění uživatelského kódu, tak spuštění.

  fáze následného zpracování.

• Selhání – Spuštění se nezdařilo. Vlastnost Error při spuštění obvykle obsahuje podrobnosti o důvodech.

• Zrušeno – následuje žádost o zrušení a označuje, že spuštění se teď úspěšně zrušilo.

• Nereaguje – u spuštění, která mají povolené prezenční signály, se v nedávné době neodeslal žádný prezenční signál.

Návraty

Stav úlohy.

Návratový typ

Optional[str]

studio_url

Koncový bod studia Azure ML.

Návraty

Adresa URL stránky s podrobnostmi o úloze

Návratový typ

Optional[str]

type

Typ úlohy.

Návraty

Typ úlohy.

Návratový typ

Optional[str]