PipelineEndpoint Klasa

Odwołanie

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

Punkty końcowe potoku 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.

Dziedziczenie: builtins.object

PipelineEndpoint

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 potokuEndpoint.
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 punktu Końcowego potoku: "Aktywny" lub "Wyłączony".
default_version Wymagane	str Domyślna wersja potoku w usłudze PipelineEndpoint, automatyczne przyrosty, rozpoczyna 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 punkt 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 punktu Końcowego potoku: "Aktywny" lub "Wyłączony".
default_version Wymagane	str Domyślna wersja potoku w usłudze PipelineEndpoint, automatyczne przyrosty, rozpoczyna się od "0"
endpoint Wymagane	str Adres URL punktu końcowego REST dla potokuEndpoint 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 elementu PipelineEndpoint 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 elementu PublishedPipeline 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 element PipelineEndpoint przy użyciu polecenia submit. Po wywołaniu przesyłania tworzony jest obiekt, PipelineRun który z kolei tworzy StepRun obiekty dla każdego kroku w przepływie pracy.

Przykład 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ą one następujące:

pipeline_parameters: Parametry wykonywania potoku, słownik {name: value}. Zobacz PipelineParameter , aby uzyskać więcej informacji.
parent_run_id: możesz podać identyfikator uruchomienia, aby ustawić nadrzędne uruchomienie tego uruchomienia potoku, które znajduje odzwierciedlenie w runHistory. Przebieg nadrzędny 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 punktu końcowego potoku 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 polecenia:


   from azureml.pipeline.core import PipelineEndpoint

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

Zapoznaj się z następującym notesem, aby uzyskać dodatkowe informacje na temat tworzenia i używania elementów PipelineEndpoints: https://aka.ms/pl-ver-endpoint.

Metody

add	Dodaj określony potok do potokuEndpoint.
add_default	Dodaj określony potok do pozycji PipelineEndpoint i ustaw wersję domyślną 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 wartość PipelineEndpoint na wartość "Aktywne" i dostępną do uruchomienia.
get	Pobierz element PipelineEndpoint według nazwy lub identyfikatora, zgłasza wyjątek, jeśli nie zostanie podany.
get_all	Pobierz wszystkie aktywne punkty PipelineEndpoint w bieżącym obszarze roboczym. Pobierz wszystkie aktywne punkty potokuEndpoint. UWAGA: Ta metoda jest przestarzała na rzecz potokuEndpoint.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ę potokuEndpoint.
get_pipeline	Pobierz potok określonej wersji lub domyślnej; zgłasza wyjątek, jeśli wersja nie zostanie znaleziona.
list	Wyświetl listę aktywnych punktów końcowych potoku w bieżącym obszarze roboczym.
list_pipelines	Pobierz listę potoków skojarzonych z punktem końcowym potoku.
list_versions	Pobierz listę potoków i odpowiednich wersji punktu końcowego potoku.
publish	Utwórz punkt końcowy potoku z określoną nazwą i potokiem/opublikowanym potokiem. Punkt końcowy potoku jest interfejsem 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 punkt końcowy potoku o podanej nazwie już istnieje.
reactivate	Uaktywnij ponownie zarchiwizowany punkt końcowy potoku.
set_default	Ustaw domyślną wersję potokuEndpoint, 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ę elementu PipelineEndpoint.
submit	Prześlij eksperyment potoku dla danej wersji; Jeśli wersja to none, wyzwala 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 pozycji PipelineEndpoint i ustaw wersję domyślną na dodaną wersję potoku.

add_default(pipeline)

Parametry

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

disable

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

disable()

enable

Ustaw wartość PipelineEndpoint na wartość "Aktywne" i dostępną do uruchomienia.

enable()

get

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

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

Parametry

Nazwa	Opis
workspace Wymagane	Workspace Obszar roboczy, w ramach którego utworzono punkt PipelineEndpoint.
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 PipelineEndpoint w bieżącym obszarze roboczym.

Pobierz wszystkie aktywne punkty potokuEndpoint. UWAGA: Ta metoda jest przestarzała na rzecz potokuEndpoint.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, zwracaj 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ę potokuEndpoint.

get_default_version()

Zwraca

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

get_pipeline

Pobierz potok określonej wersji lub domyślnej; 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świetl listę aktywnych punktów końcowych potoku 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, zwracaj tylko punkty potoku, które są obecnie aktywne. Domyślna wartość: True
max_results	int maksymalna liczba wierszy zwracanych punktów końcowych 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 końcowym potoku.

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 odpowiednich wersji punktu końcowego potoku.

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 jest interfejsem 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 punkt końcowy potoku 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

Uaktywnij ponownie zarchiwizowany punkt końcowy potoku.

reactivate(name)

Parametry

Nazwa	Opis
name Wymagane	str Nazwa do ustawienia.

Zwraca

Typ	Opis
PipelineEndpoint	Obiekt PipelineEndpoint.

set_default

Ustaw domyślną wersję potokuEndpoint, 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, która ma być ustawiona jako domyślna wersja w usłudze PipelineEndpoint.

Wyjątki

Typ	Opis
ValueError

set_name

Ustaw nazwę elementu PipelineEndpoint.

set_name(name)

Parametry

Nazwa	Opis
name Wymagane	str Nazwa do ustawienia.

submit

Prześlij eksperyment potoku dla danej wersji; Jeśli wersja to none, wyzwala 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 wykonaniu potoku, przekazywane jako słownik {name: value}. Zobacz PipelineParameter , aby uzyskać więcej informacji. Domyślna wartość: None
parent_run_id	str Możesz podać identyfikator przebiegu, aby ustawić nadrzędne uruchomienie tego uruchomienia potoku, który jest odzwierciedlony 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ę punktu końcowego PipelineEndpoint.

Zwraca

Typ	Opis
str	Wersja domyślna.

description

Pobierz 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 PotokEndpoint 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

Uzyskaj stan punktu końcowego potoku.

Zwraca

Typ	Opis
str	Stan.

swaggerurl

Pobierz adres URL struktury 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.

Udostępnij za pośrednictwem

PipelineEndpoint Klasa

Konstruktor

Parametry

Uwagi

Metody

add

Parametry

add_default

Parametry

archive

disable

enable

get

Parametry

Zwraca

get_all

Parametry

Zwraca

get_all_pipelines

Parametry

Zwraca

get_all_versions

Parametry

Zwraca

get_default_version

Zwraca

get_pipeline

Parametry

Zwraca

list

Parametry

Zwraca

list_pipelines

Parametry

Zwraca

list_versions

Parametry

Zwraca

publish

Parametry

Zwraca

Wyjątki

reactivate

Parametry

Zwraca

set_default

Parametry

Wyjątki

set_default_version

Parametry

Wyjątki

set_name

Parametry

submit

Parametry

Zwraca

Wyjątki

Atrybuty

default_version

Zwraca

description

Zwraca

endpoint

Zwraca

id

Zwraca

name

Zwraca

pipeline_version_list

Zwraca

status

Zwraca

swaggerurl

Zwraca

Opinia

Dodatkowe zasoby