PipelineEndpoint Klasa

Pipeline Reprezentuje przepływ pracy, który można wyzwolić z unikatowego adresu URL punktu końcowego.

Punkty pipelineEndpoint mogą służyć do tworzenia nowych wersji elementu PublishedPipeline przy zachowaniu tego samego punktu końcowego. Punkty potoku są unikatowo nazwane w obszarze roboczym.

Za pomocą atrybutu punktu końcowego obiektu PipelineEndpoint można wyzwalać nowe uruchomienia potoków z aplikacji zewnętrznych za pomocą wywołań REST. Aby uzyskać informacje o sposobie uwierzytelniania podczas wywoływania punktów końcowych REST, zobacz https://aka.ms/pl-restep-auth.

Aby uzyskać więcej informacji na temat tworzenia i uruchamiania potoków uczenia maszynowego, zobacz https://aka.ms/pl-first-pipeline.

Inicjowanie potokuEndpoint.

Konstruktor

PipelineEndpoint(workspace, id, name, description, status, default_version, endpoint, pipeline_version_list, _pipeline_endpoint_provider=None, _published_pipeline_provider=None, _swaggerurl=None)

Parametry

Nazwa	Opis
workspace Wymagane	Workspace W obszarze roboczym zdefiniowany jest punkt końcowy potoku.
id Wymagane	str Identyfikator punktu końcowego potoku.
name Wymagane	str Nazwa punktu końcowego potoku.
description Wymagane	str Opis punktu końcowego potoku.
status Wymagane	str Nowy stan potokuEndpoint: "Aktywny" lub "Wyłączony".
default_version Wymagane	str Domyślna wersja potoku w usłudze PipelineEndpoint, przyrostach automatycznych, zaczyna się od "0".
endpoint Wymagane	str Adres URL punktu końcowego REST dla punktu końcowego PipelineEndpoint, który może służyć do przesyłania przebiegów potoku.
pipeline_version_list Wymagane	list Lista PipelineIdVersion obiektów.
_pipeline_endpoint_provider Wymagane	<xref:azureml.pipeline.core._aeva_provider._AevaPublishedPipelineProvider> Dostawca PipelineEndpoint.
_pipeline_endpoint_provider Wymagane	Dostawca PublishedPipeline.
workspace Wymagane	Workspace Obiekt obszaru roboczego, do którego będzie należeć ten element PipelineEndpoint.
id Wymagane	str Identyfikator punktu końcowego potoku.
name Wymagane	str Nazwa punktu końcowego potoku.
description Wymagane	str Opis punktu końcowego potoku.
status Wymagane	str Nowy stan potokuEndpoint: "Aktywny" lub "Wyłączony".
default_version Wymagane	str Domyślna wersja potoku w usłudze PipelineEndpoint, przyrosty automatyczne, zaczyna się od "0"
endpoint Wymagane	str Adres URL punktu końcowego REST dla elementu PipelineEndpoint do przesyłania przebiegów potoku.
pipeline_version_list Wymagane	list Lista PipelineIdVersion
_pipeline_endpoint_provider Wymagane	<xref:azureml.pipeline.core._aeva_provider._AevaPublishedPipelineProvider> Dostawca PipelineEndpoint.
_pipeline_endpoint_provider Wymagane	Dostawca PublishedPipeline.
swaggerendpoint Wymagane	Adres URL punktu końcowego REST struktury Swagger dla potokuEndpoint do przesyłania przebiegów potoku.

Uwagi

Punkt końcowy potoku można utworzyć na podstawie elementu Pipeline lub PublishedPipeline.

Przykład publikowania z potoku lub opublikowanejpipeline jest następujący:

   from azureml.pipeline.core import PipelineEndpoint

   # The pipeline argument can be either a Pipeline or a PublishedPipeline
   pipeline_endpoint = PipelineEndpoint.publish(workspace=ws,
                                                name="PipelineEndpointName",
                                                pipeline=pipeline,
                                                description="New Pipeline Endpoint")

Prześlij punkt końcowy potoku przy użyciu polecenia submit. Po wywołaniu przesyłania tworzony jest element PipelineRun , który z kolei tworzy StepRun obiekty dla każdego kroku w przepływie pracy.

Przykład sposobu przesyłania punktu końcowego potoku jest następujący:

   from azureml.pipeline.core import PipelineEndpoint

   pipeline_endpoint = PipelineEndpoint.get(workspace=ws, name="PipelineEndpointName")
   pipeline_run = experiment.submit(pipeline_endpoint)

Istnieje wiele opcjonalnych ustawień, które można określić podczas przesyłania potokuEndpoint. Są to:

• pipeline_parameters: Parametry wykonywania potoku, słownik {name: value}. Aby uzyskać więcej informacji, zobacz PipelineParameter.

• parent_run_id: możesz podać identyfikator uruchomienia, aby ustawić nadrzędne uruchomienie tego uruchomienia potoku, które jest odzwierciedlone w elememencie RunHistory. Uruchomienie nadrzędne musi należeć do tego samego eksperymentu, do którego jest przesyłany ten potok.

• pipeline_version: wersja potoku do uruchomienia.

Przykład przesyłania elementu PipelineEndpoint przy użyciu tych ustawień jest następujący:

   from azureml.pipeline.core import PipelineEndpoint

   pipeline_endpoint = PipelineEndpoint.get(workspace=ws, name="PipelineEndpointName")
   pipeline_run = experiment.submit(pipeline_endpoint,
                                    pipeline_parameters={"param1": "value1"},
                                    parent_run_id="<run_id>",
                                    pipeline_version="0")

Aby dodać nową wersję elementu PipelineEndpoint, użyj:

   from azureml.pipeline.core import PipelineEndpoint

   pipeline_endpoint = PipelineEndpoint.get(workspace=ws, name="PipelineEndpointName")
   pipeline_endpoint.add(published_pipeline)

Aby uzyskać dodatkowe informacje na temat tworzenia i używania potokuEndpoints, zobacz następujący notes: https://aka.ms/pl-ver-endpoint.

Metody

add	Dodaj określony potok do potokuEndpoint.
add_default	Dodaj określony potok do potoku PipelineEndpoint i ustaw domyślną wersję na dodaną wersję potoku.
archive	Zarchiwizuj punkt końcowy potoku.
disable	Ustaw pozycję PipelineEndpoint na wartość "Disabled" (Wyłączone) i niedostępną do uruchomienia.
enable	Ustaw parametr PipelineEndpoint na "Aktywny" i dostępny do uruchomienia.
get	Pobierz element PipelineEndpoint według nazwy lub identyfikatora, zgłasza wyjątek, jeśli nie został podany.
get_all	Pobierz wszystkie aktywne punkty potoku w bieżącym obszarze roboczym. Pobierz wszystkie aktywne punkty potoku. UWAGA: Ta metoda jest przestarzała na rzecz elementu PipelineEndpoint.list().
get_all_pipelines	Pobieranie listy potoków w usłudze PipelineEndpoint. UWAGA: Ta metoda jest przestarzała na rzecz list_pipelines()
get_all_versions	Pobierz listę potoków i odpowiednich wersji w usłudze PipelineEndpoint. UWAGA: Ta metoda jest przestarzała na rzecz list_versions()
get_default_version	Pobierz domyślną wersję elementu PipelineEndpoint.
get_pipeline	Pobierz potok określonej wersji lub wartość domyślną; zgłasza wyjątek, jeśli wersja nie zostanie znaleziona.
list	Wyświetlanie listy aktywnych punktów pipelineEndpoint w bieżącym obszarze roboczym.
list_pipelines	Pobierz listę potoków skojarzonych z punktem potokuEndpoint.
list_versions	Pobierz listę potoków i odpowiadające im wersje elementu PipelineEndpoint.
publish	Utwórz punkt końcowy potoku z określoną nazwą i potokiem/opublikowanym potokiem. Punkt końcowy potoku to interfejs API REST, którego można używać z aplikacji zewnętrznych. Aby uzyskać informacje o sposobie uwierzytelniania podczas wywoływania punktów końcowych REST, zobacz https://aka.ms/pl-restep-auth. Aby uzyskać więcej informacji na temat pracy z punktami końcowymi potoku, zobacz https://aka.ms/pl-first-pipeline. Zgłasza wyjątek, jeśli element PipelineEndpoint o podanej nazwie już istnieje.
reactivate	Ponowne aktywowanie punktu końcowego potoku, który został zarchiwizowany.
set_default	Ustaw domyślną wersję elementu PipelineEndpoint, zgłasza wyjątek, jeśli określony potok nie zostanie znaleziony.
set_default_version	Ustaw domyślną wersję elementu PipelineEndpoint, zgłasza wyjątek, jeśli określona wersja nie zostanie znaleziona.
set_name	Ustaw nazwę potokuEndpoint.
submit	Prześlij eksperyment potoku dla danej wersji; jeśli wersja nie jest wyzwalaną domyślną wersją potoku.

add

Dodaj określony potok do potokuEndpoint.

add(pipeline)

Parametry

Nazwa	Opis
pipeline Wymagane	PublishedPipeline Opublikowany potok do dodania.

add_default

Dodaj określony potok do potoku PipelineEndpoint i ustaw domyślną wersję na dodaną wersję potoku.

add_default(pipeline)

Parametry

Nazwa	Opis
pipeline Wymagane	PublishedPipeline Opublikowany potok do dodania jako wersja domyślna.

archive

Zarchiwizuj punkt końcowy potoku.

archive()

disable

Ustaw pozycję PipelineEndpoint na wartość "Disabled" (Wyłączone) i niedostępną do uruchomienia.

disable()

enable

Ustaw parametr PipelineEndpoint na "Aktywny" i dostępny do uruchomienia.

enable()

get

Pobierz element PipelineEndpoint według nazwy lub identyfikatora, zgłasza wyjątek, jeśli nie został podany.

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

Parametry

Nazwa	Opis
workspace Wymagane	Workspace W obszarze roboczym został utworzony punkt końcowy potoku.
id	str Identyfikator punktu końcowego potoku. Domyślna wartość: None
name	str Nazwa punktu końcowego potoku. Domyślna wartość: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Dostawca przepływu pracy. Domyślna wartość: None
_service_endpoint	str Punkt końcowy usługi. Domyślna wartość: None

Zwraca

Typ	Opis
PipelineEndpoint	Obiekt PipelineEndpoint.

get_all

Pobierz wszystkie aktywne punkty potoku w bieżącym obszarze roboczym.

Pobierz wszystkie aktywne punkty potoku. UWAGA: Ta metoda jest przestarzała na rzecz elementu PipelineEndpoint.list().

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

Parametry

Nazwa	Opis
workspace Wymagane	Workspace Obszar roboczy.
active_only	bool Jeśli wartość true, zwraca tylko punkty potoku, które są obecnie aktywne. Domyślna wartość: True
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Dostawca przepływu pracy. Domyślna wartość: None
_service_endpoint	str Punkt końcowy usługi. Domyślna wartość: None

Zwraca

Typ	Opis
list	Lista PipelineEndpoint obiektów.

get_all_pipelines

Pobieranie listy potoków w usłudze PipelineEndpoint.

UWAGA: Ta metoda jest przestarzała na rzecz list_pipelines()

get_all_pipelines(active_only=True, _workflow_provider=None, _service_endpoint=None)

Parametry

Nazwa	Opis
active_only	bool Flaga zwracająca aktywne tylko potoki. Domyślna wartość: True
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Dostawca przepływu pracy. Domyślna wartość: None
_service_endpoint	str Punkt końcowy usługi. Domyślna wartość: None

Zwraca

Typ	Opis
list	Lista PublishedPipeline obiektów.

get_all_versions

Pobierz listę potoków i odpowiednich wersji w usłudze PipelineEndpoint.

UWAGA: Ta metoda jest przestarzała na rzecz list_versions()

get_all_versions(_workflow_provider=None, _service_endpoint=None)

Parametry

Nazwa	Opis
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Dostawca przepływu pracy. Domyślna wartość: None
_service_endpoint	str Punkt końcowy usługi. Domyślna wartość: None

Zwraca

Typ	Opis
list	Lista PipelineVersion obiektów.

get_default_version

Pobierz domyślną wersję elementu PipelineEndpoint.

get_default_version()

Zwraca

Typ	Opis
str	Domyślna wersja punktu końcowego potoku.

get_pipeline

Pobierz potok określonej wersji lub wartość domyślną; zgłasza wyjątek, jeśli wersja nie zostanie znaleziona.

get_pipeline(version=None)

Parametry

Nazwa	Opis
version	str Wersja potoku do zwrócenia. Domyślna wartość: None

Zwraca

Typ	Opis
PublishedPipeline	Opublikowany potok.

list

Wyświetlanie listy aktywnych punktów pipelineEndpoint w bieżącym obszarze roboczym.

static list(workspace, active_only=True, max_results=100, _workflow_provider=None, _service_endpoint=None)

Parametry

Nazwa	Opis
workspace Wymagane	Workspace Obszar roboczy.
active_only	bool Jeśli wartość true, zwraca tylko punkty potoku, które są obecnie aktywne. Domyślna wartość: True
max_results	int maksymalna liczba wierszy zwróconych punktów potoku Domyślna wartość: 100
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Dostawca przepływu pracy. Domyślna wartość: None
_service_endpoint	str Punkt końcowy usługi. Domyślna wartość: None

Zwraca

Typ	Opis
list	Lista PipelineEndpoint obiektów.

list_pipelines

Pobierz listę potoków skojarzonych z punktem potokuEndpoint.

list_pipelines(active_only=True, _workflow_provider=None, _service_endpoint=None)

Parametry

Nazwa	Opis
active_only	bool Wskazuje, czy zwracać tylko aktywne potoki. Domyślna wartość: True
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Dostawca przepływu pracy. Domyślna wartość: None
_service_endpoint	str Punkt końcowy usługi. Domyślna wartość: None

Zwraca

Typ	Opis
list	Lista PublishedPipeline obiektów.

list_versions

Pobierz listę potoków i odpowiadające im wersje elementu PipelineEndpoint.

list_versions(_workflow_provider=None, _service_endpoint=None)

Parametry

Nazwa	Opis
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Dostawca przepływu pracy. Domyślna wartość: None
_service_endpoint	str Punkt końcowy usługi. Domyślna wartość: None

Zwraca

Typ	Opis
list	Lista PipelineVersion obiektów.

publish

Utwórz punkt końcowy potoku z określoną nazwą i potokiem/opublikowanym potokiem.

Punkt końcowy potoku to interfejs API REST, którego można używać z aplikacji zewnętrznych. Aby uzyskać informacje o sposobie uwierzytelniania podczas wywoływania punktów końcowych REST, zobacz https://aka.ms/pl-restep-auth.

Aby uzyskać więcej informacji na temat pracy z punktami końcowymi potoku, zobacz https://aka.ms/pl-first-pipeline.

Zgłasza wyjątek, jeśli element PipelineEndpoint o podanej nazwie już istnieje.

static publish(workspace, name, description, pipeline, _workflow_provider=None, _service_endpoint=None)

Parametry

Nazwa	Opis
workspace Wymagane	Workspace Obszar roboczy do utworzenia elementu PipelineEndpoint w programie.
name Wymagane	str Nazwa punktu końcowego potoku.
description Wymagane	str Opis punktu końcowego potoku.
pipeline Wymagane	PublishedPipeline lub Pipeline Opublikowany potok lub potok.
_service_endpoint	str Punkt końcowy usługi. Domyślna wartość: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Dostawca przepływu pracy. Domyślna wartość: None

Zwraca

Typ	Opis
PipelineEndpoint	Nowy punkt końcowy potoku.

Wyjątki

Typ	Opis
ValueError

reactivate

Ponowne aktywowanie punktu końcowego potoku, który został zarchiwizowany.

reactivate(name)

Parametry

Nazwa	Opis
name Wymagane	str Nazwa do ustawienia.

Zwraca

Typ	Opis
PipelineEndpoint	Obiekt PipelineEndpoint.

set_default

Ustaw domyślną wersję elementu PipelineEndpoint, zgłasza wyjątek, jeśli określony potok nie zostanie znaleziony.

set_default(pipeline)

Parametry

Nazwa	Opis
pipeline Wymagane	PublishedPipeline Opublikowany potok do ustawienia jako domyślny.

Wyjątki

Typ	Opis
ValueError

set_default_version

Ustaw domyślną wersję elementu PipelineEndpoint, zgłasza wyjątek, jeśli określona wersja nie zostanie znaleziona.

set_default_version(version)

Parametry

Nazwa	Opis
version Wymagane	str Wersja do ustawienia jako domyślna wersja w usłudze PipelineEndpoint.

Wyjątki

Typ	Opis
ValueError

set_name

Ustaw nazwę potokuEndpoint.

set_name(name)

Parametry

Nazwa	Opis
name Wymagane	str Nazwa do ustawienia.

submit

Prześlij eksperyment potoku dla danej wersji; jeśli wersja nie jest wyzwalaną domyślną wersją potoku.

submit(experiment_name, pipeline_parameters=None, parent_run_id=None, pipeline_version=None)

Parametry

Nazwa	Opis
experiment_name Wymagane	str Nazwa eksperymentu do przesłania potoku.
pipeline_parameters	dict Parametry do użycia w wykonywaniu potoku, przekazywane jako słownik {name: value}. Aby uzyskać więcej informacji, zobacz PipelineParameter. Domyślna wartość: None
parent_run_id	str Możesz podać identyfikator przebiegu, aby ustawić nadrzędne uruchomienie tego uruchomienia potoku, które jest odzwierciedlone w runHistory. Przebieg nadrzędny musi należeć do tego samego eksperymentu, do którego jest przesyłany ten potok. Domyślna wartość: None
pipeline_version	str Wersja potoku do uruchomienia. Domyślna wartość: None

Zwraca

Typ	Opis
PipelineRun	Przesłane uruchomienie potoku.

Wyjątki

Typ	Opis
ValueError

Atrybuty

default_version

Pobierz domyślną wersję elementu PipelineEndpoint.

Zwraca

Typ	Opis
str	Wersja domyślna.

description

Uzyskaj opis punktu końcowego potoku.

Zwraca

Typ	Opis
str	Opis.

endpoint

Pobierz adres URL punktu końcowego REST potokuEndpoint.

Punkt końcowy może służyć do wyzwalania przebiegów potoku.

Zwraca

Typ	Opis
str	Punkt końcowy REST dla potoku PipelineEndpoint do uruchomienia potoku.

id

Pobierz identyfikator punktu końcowego potoku.

Zwraca

Typ	Opis
str	Identyfikator punktu końcowego potoku.

name

Pobierz nazwę punktu końcowego potoku.

Zwraca

Typ	Opis
str	Nazwa.

pipeline_version_list

Pobierz listę wersji potoku.

Zwraca

Typ	Opis
list	Lista PipelineIdVersion obiektów.

status

Pobierz stan potokuEndpoint.

Zwraca

Typ	Opis
str	Stan.

swaggerurl

Pobierz adres URL programu Swagger REST w punkcie PipelineEndpoint.

Adres URL programu Swagger może być wyświetlany schemat punktu końcowego potoku.

Zwraca

Typ	Opis
str	Program REST Swagger dla potoku PipelineEndpoint do uruchomienia potoku.