Delen via


PublishedPipeline Klas

Vertegenwoordigt een pijplijn die moet worden verzonden zonder de Python-code waarmee deze is samengesteld.

Bovendien kan een PublishedPipeline worden gebruikt om een Pipeline opnieuw in te dienen met verschillende PipelineParameter waarden en invoer.

Initialiseer PublishedPipeline.

:p aram-eindpunt De REST-eindpunt-URL voor het verzenden van pijplijnuitvoeringen voor deze pijplijn. :type eindpunt: str :p aram total_run_steps: Het aantal stappen in deze pijplijn:type total_run_steps: int :p aram-werkruimte: De werkruimte van de gepubliceerde pijplijn. :type werkruimte: azureml.core.Workspace :p aram continue_on_step_failure: of u wilt doorgaan met de uitvoering van andere stappen in de PipelineRun

Als een stap mislukt, is de standaardwaarde false.

Overname
azureml.core._portal.HasPipelinePortal
PublishedPipeline

Constructor

PublishedPipeline(name, graph_id, description, version, published_pipeline_id, status, endpoint, total_run_steps, workspace, continue_on_step_failure=None, _pipeline_provider=None, **kwargs)

Parameters

Name Description
name
Vereist
str

De naam van de gepubliceerde pijplijn.

graph_id
Vereist
str

De id van de grafiek voor deze gepubliceerde pijplijn.

description
Vereist
str

De beschrijving van de gepubliceerde pijplijn.

version
Vereist
str

De gepubliceerde pijplijnversie.

published_pipeline_id
Vereist
str

De id van de gepubliceerde pijplijn.

status
Vereist
str

De status van de gepubliceerde pijplijn ('Actief' of 'Uitgeschakeld').

endpoint
Vereist
str

De REST-eindpunt-URL die moet worden verzonden, wordt uitgevoerd voor deze pijplijn.

total_run_steps
Vereist
int

Het aantal stappen in deze pijplijn.

workspace
Vereist

De werkruimte van de gepubliceerde pijplijn.

continue_on_step_failure
Vereist

Of u wilt doorgaan met de uitvoering van andere stappen in De PijplijnUitvoeren als een stap mislukt. De standaardwaarde is false.

_pipeline_provider
Vereist
<xref:azureml.pipeline.core._workflow_provider._PublishedPipelineProvider>

De gepubliceerde pijplijnprovider.

kwargs
Vereist

Aangepaste trefwoordargumenten, gereserveerd voor toekomstige ontwikkeling

name
Vereist
str

De naam van de gepubliceerde pijplijn.

graph_id
Vereist
str

De id van de grafiek voor deze gepubliceerde pijplijn.

description
Vereist
str

De beschrijving van de gepubliceerde pijplijn.

version
Vereist
str

De gepubliceerde pijplijnversie.

published_pipeline_id
Vereist
str

De id van de gepubliceerde pijplijn.

status
Vereist
str

Status van de gepubliceerde pijplijn ('Actief' of 'Uitgeschakeld').

_pipeline_provider
Vereist
<xref:azureml.pipeline.core._workflow_provider._PublishedPipelineProvider>

De gepubliceerde pijplijnprovider.

kwargs
Vereist

Aangepaste trefwoordargumenten, gereserveerd voor toekomstige ontwikkeling

Opmerkingen

Een PublishedPipeline kan worden gemaakt op basis van een Pipeline of een PipelineRun.

Een voorbeeld om te publiceren vanuit een pijplijn is als volgt:


   from azureml.pipeline.core import Pipeline

   pipeline = Pipeline(workspace=ws, steps=steps)
   published_pipeline = pipeline.publish(name="My_New_Pipeline",
                                         description="My New Pipeline Description",
                                         version="1.0",
                                         continue_on_step_failure=True)

Als u wilt publiceren vanuit een PijplijnUitvoeren, gebruikt u:


   from azureml.pipeline.core import PipelineRun

   pipeline_run = PipelineRun(experiment=Experiment(ws, "Pipeline_experiment"), run_id="run_id")
   published_pipeline = pipeline_run.publish_pipeline(name="My_New_Pipeline",
                                                      description="My New Pipeline Description",
                                                      version="1.0",
                                                      continue_on_step_failure=True)

Opmerking: de parameter continue_on_step_failure geeft aan of de uitvoering van stappen in de pijplijn wordt voortgezet als één stap mislukt. De standaardwaarde is False, wat betekent dat wanneer één stap mislukt, de uitvoering van de pijplijn wordt gestopt, waardoor alle actieve stappen worden geannuleerd.

Dien een PublishedPipeline in met behulp van submit. Wanneer verzenden wordt aangeroepen, wordt er een PipelineRun gemaakt die op zijn beurt objecten maakt StepRun voor elke stap in de werkstroom.

Een voorbeeld voor het indienen van een PublishedPipeline is als volgt:


   from azureml.pipeline.core import PublishedPipeline

   published_pipeline = PublishedPipeline.get(workspace=ws, id="published_pipeline_id")
   pipeline_run = experiment.submit(published_pipeline)

Er zijn een aantal optionele instellingen die kunnen worden opgegeven bij het indienen van een PublishedPipeline. Deze omvatten:

  • continue_on_step_failure: optioneel of u wilt doorgaan met de uitvoering van andere stappen in De PijplijnUitvoeren als een stap mislukt. Alleen stappen die niet afhankelijk zijn van de uitvoer van de mislukte stap, worden uitgevoerd. Indien opgegeven, overschrijft deze parameterinstelling de instelling op de pijplijn.

  • pipeline_parameters: Parameters voor pijplijnuitvoering, woordenlijst van {name: value}. Zie PipelineParameter voor meer informatie.

  • parent_run_id: u kunt een uitvoerings-id opgeven om de bovenliggende uitvoering van deze pijplijnuitvoering in te stellen. Dit wordt weergegeven in RunHistory. De bovenliggende uitvoering moet deel uitmaken van hetzelfde experiment als de pijplijn die wordt verzonden.

Een voorbeeld om een PublishedPipeline te verzenden met behulp van deze instellingen is als volgt:


   from azureml.pipeline.core import PublishedPipeline

   published_pipeline = PublishedPipeline.get(workspace=ws, id="published_pipeline_id")
   pipeline_run = experiment.submit(published_pipeline,
                                    continue_on_step_failure=True,
                                    pipeline_parameters={"param1": "value1"},
                                    parent_run_id="<run_id>")

Alle gepubliceerde pijplijnen hebben een REST-eindpunt. Met het pijplijneindpunt kunt u een uitvoering van de pijplijn activeren vanuit externe systemen, zoals niet-Python-clients. Zie voor meer informatie over het verifiëren bij het aanroepen van REST-eindpunten https://aka.ms/pl-restep-auth.

Het gebruik van het eindpunt maakt 'beheerde herhaalbaarheid' mogelijk in scenario's voor batchgewijs scoren en opnieuw trainen, bijvoorbeeld. Voor meer informatie raadpleegt u https://aka.ms/pl-first-pipeline.

Methoden

disable

Stel de gepubliceerde pijplijn in op Uitgeschakeld en niet beschikbaar om uit te voeren.

enable

Stel de gepubliceerde pijplijn in op Actief en beschikbaar om uit te voeren.

get

Haal de gepubliceerde pijplijn op.

get_all

Alle gepubliceerde pijplijnen in de huidige werkruimte ophalen.

AFGESCHAFT: deze methode wordt afgeschaft ten gunste van de methode PublishedPipeline list .

get_graph

Haal de grafiek van de PublishedPipeline op.

get_step_names

Haal de lijst met namen van stappen op in de PublishedPipeline.

list

Alle gepubliceerde pijplijnen in de huidige werkruimte ophalen.

save

Sla de YAML van de pijplijn op in een bestand.

Momenteel worden alleen pijplijnen die bestaan uit ModuleSteps ondersteund voor YAML-export.

submit

Verzend de gepubliceerde pijplijn. Dit komt overeen met het gebruik van submit.

Retourneert de verzonden PipelineRun. Gebruik dit object om details van de uitvoering te bewaken en weer te geven.

disable

Stel de gepubliceerde pijplijn in op Uitgeschakeld en niet beschikbaar om uit te voeren.

disable()

enable

Stel de gepubliceerde pijplijn in op Actief en beschikbaar om uit te voeren.

enable()

get

Haal de gepubliceerde pijplijn op.

static get(workspace, id, _workflow_provider=None, _service_endpoint=None)

Parameters

Name Description
workspace
Vereist

De werkruimte waarin de gepubliceerde pijplijn is gemaakt.

id
Vereist
str

De id van de gepubliceerde pijplijn.

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

De werkstroomprovider.

Default value: None
_service_endpoint
str

Het service-eindpunt.

Default value: None

Retouren

Type Description

Een PublishedPipeline-object.

get_all

Alle gepubliceerde pijplijnen in de huidige werkruimte ophalen.

AFGESCHAFT: deze methode wordt afgeschaft ten gunste van de methode PublishedPipeline list .

static get_all(workspace, active_only=True, _service_endpoint=None)

Parameters

Name Description
workspace
Vereist

De werkruimte waarop de gepubliceerde pijplijn is gemaakt.

active_only

Of alleen gepubliceerde pijplijnen moeten worden geretourneerd die momenteel actief zijn.

Default value: True
_service_endpoint
str

Het service-eindpunt.

Default value: None

Retouren

Type Description

Een lijst met PublishedPipeline-objecten.

get_graph

Haal de grafiek van de PublishedPipeline op.

get_graph(_workflow_provider=None)

Parameters

Name Description
_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

De werkstroomprovider.

Default value: None

Retouren

Type Description

De grafiek.

get_step_names

Haal de lijst met namen van stappen op in de PublishedPipeline.

get_step_names(_workflow_provider=None)

Parameters

Name Description
_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

De werkstroomprovider.

Default value: None

Retouren

Type Description

De lijst met de namen van stappen in de PublishedPipeline.

list

Alle gepubliceerde pijplijnen in de huidige werkruimte ophalen.

static list(workspace, active_only=True, _service_endpoint=None)

Parameters

Name Description
workspace
Vereist

De werkruimte waarin de gepubliceerde pijplijn is gemaakt.

active_only

Of alleen gepubliceerde pijplijnen moeten worden geretourneerd die momenteel actief zijn.

Default value: True
_service_endpoint
str

Het service-eindpunt.

Default value: None

Retouren

Type Description

Een lijst met PublishedPipeline-objecten.

save

Sla de YAML van de pijplijn op in een bestand.

Momenteel worden alleen pijplijnen die bestaan uit ModuleSteps ondersteund voor YAML-export.

save(path=None, _workflow_provider=None)

Parameters

Name Description
path
str

Het pad om de YAML in op te slaan. Als het pad een map is, wordt het YAML-bestand pijplijn opgeslagen op path/pipeline_name.yml. Als het pad Geen is, wordt de huidige map gebruikt.

Default value: None
_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

De werkstroomprovider.

Default value: None

Retouren

Type Description

submit

Verzend de gepubliceerde pijplijn. Dit komt overeen met het gebruik van submit.

Retourneert de verzonden PipelineRun. Gebruik dit object om details van de uitvoering te bewaken en weer te geven.

submit(workspace, experiment_name, pipeline_parameters=None, _workflow_provider=None, _service_endpoint=None, parent_run_id=None, continue_on_step_failure=None)

Parameters

Name Description
workspace
Vereist

De werkruimte waarop de gepubliceerde pijplijn moet worden verzonden.

experiment_name
Vereist
str

De naam van het experiment waar u naar wilt verzenden.

pipeline_parameters

Een woordenlijst met parameters voor het toewijzen van nieuwe waarden {param name, param value}. Zie PipelineParameter voor meer informatie.

Default value: None
_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

De werkstroomprovider.

Default value: None
_service_endpoint
str

Het service-eindpunt.

Default value: None
parent_run_id
str

Optionele uitvoerings-id die moet worden ingesteld voor de bovenliggende uitvoering van deze pijplijnuitvoering, die wordt weergegeven in RunHistory. De bovenliggende uitvoering moet deel uitmaken van hetzelfde experiment als waar deze pijplijn naar wordt verzonden.

Default value: None
continue_on_step_failure

Of u wilt doorgaan met de uitvoering van andere stappen in De PijplijnUitvoeren als een stap mislukt, optioneel. Indien opgegeven, wordt de instelling voor de pijplijn overschreven.

Default value: None

Retouren

Type Description

De verzonden pijplijnuitvoering.

Kenmerken

continue_on_step_failure

Haal de waarde van de instelling op continue_on_step_failure .

Retouren

Type Description

De waarde van de continue_on_step_failure instelling.

description

Haal de beschrijving van de gepubliceerde pijplijn op.

Retouren

Type Description
str

De beschrijving van de gepubliceerde pijplijn.

endpoint

Haal de REST-eindpunt-URL op voor het uitvoeren van een gepubliceerde pijplijn.

Retouren

Type Description
str

De REST-eindpunt-URL voor het uitvoeren van de gepubliceerde pijplijn.

graph_id

Haal de id van de grafiek op voor deze gepubliceerde pijplijn.

Retouren

Type Description
str

De id van de grafiek.

id

Haal de gepubliceerde pijplijn-id op.

Retouren

Type Description
str

De id van de gepubliceerde pijplijn.

name

Haal de naam van de gepubliceerde pijplijn op.

Retouren

Type Description
str

De naam van de gepubliceerde pijplijn.

status

Haal de status van de gepubliceerde pijplijn op.

Retouren

Type Description
str

De status van de gepubliceerde pijplijn.

total_run_steps

Haal het aantal stappen in de pijplijn op.

Retouren

Type Description
int

Het aantal stappen in de pijplijn.

version

Haal de versie van de gepubliceerde pijplijn op.

Retouren

Type Description
str

De versie van de gepubliceerde pijplijn.