PipelineEndpoint Kelas

Referensi

Mewakili alur kerja Pipeline yang dapat dipicu dari URL titik akhir yang unik.

PipelineEndpoints dapat digunakan untuk membuat versi baru PublishedPipeline sekaligus mempertahankan titik akhir yang sama. PipelineEndpoints diberi nama unik di dalam ruang kerja.

Dengan menggunakan atribut titik akhir pada objek PipelineEndpoint, Anda dapat memicu alur baru berjalan dari aplikasi eksternal dengan panggilan REST. Untuk informasi tentang cara mengautentikasi saat memanggil titik akhir REST, lihat https://aka.ms/pl-restep-auth.

Untuk informasi selengkapnya tentang membuat dan menjalankan alur pembelajaran mesin, lihat https://aka.ms/pl-first-pipeline.

Menginisialisasi PipelineEndpoint.

Warisan: 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)

Parameter

Nama	Deskripsi
workspace Diperlukan	Workspace Ruang kerja PipelineEndpoint didefinisikan.
id Diperlukan	str ID PipelineEndpoint.
name Diperlukan	str Nama PipelineEndpoint.
description Diperlukan	str Deskripsi PipelineEndpoint.
status Diperlukan	str Status baru PipelineEndpoint: 'Aktif' atau 'Dinonaktifkan'.
default_version Diperlukan	str Versi default alur di PipelineEndpoint, penambahan otomatis, dimulai dengan "0".
endpoint Diperlukan	str URL titik akhir REST untuk PipelineEndpoint, yang dapat digunakan untuk mengirimkan eksekusi alur.
pipeline_version_list Diperlukan	list Daftar PipelineIdVersion objek.
_pipeline_endpoint_provider Diperlukan	<xref:azureml.pipeline.core._aeva_provider._AevaPublishedPipelineProvider> Penyedia PipelineEndpoint.
_pipeline_endpoint_provider Diperlukan	Penyedia PublishedPipeline.
workspace Diperlukan	Workspace Objek ruang kerja tempat PipelineEndpoint ini berada.
id Diperlukan	str ID PipelineEndpoint.
name Diperlukan	str Nama PipelineEndpoint.
description Diperlukan	str Deskripsi PipelineEndpoint.
status Diperlukan	str Status baru PipelineEndpoint: 'Aktif' atau 'Dinonaktifkan'.
default_version Diperlukan	str Versi default alur di PipelineEndpoint, kenaikan otomatis, dimulai dengan "0"
endpoint Diperlukan	str URL titik akhir REST untuk PipelineEndpoint untuk mengirimkan eksekusi alur.
pipeline_version_list Diperlukan	list Daftar PipelineIdVersion
_pipeline_endpoint_provider Diperlukan	<xref:azureml.pipeline.core._aeva_provider._AevaPublishedPipelineProvider> Penyedia PipelineEndpoint.
_pipeline_endpoint_provider Diperlukan	Penyedia PublishedPipeline.
swaggerendpoint Diperlukan	URL titik akhir Swagger REST untuk PipelineEndpoint untuk mengirimkan eksekusi alur.

Keterangan

PipelineEndpoint dapat dibuat dari Pipeline atau PublishedPipeline.

Contoh untuk diterbitkan dari Alur atau PublishedPipeline adalah sebagai berikut:


   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")

Kirim PipelineEndpoint menggunakan submit. Saat pengiriman dipanggil, PipelineRun dibuat yang pada gilirannya membuat objek StepRun untuk setiap langkah dalam alur kerja.

Contoh cara mengirimkan PipelineEndpoint adalah sebagai berikut:


   from azureml.pipeline.core import PipelineEndpoint

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

Ada sejumlah pengaturan opsional yang dapat ditentukan saat mengirimkan PipelineEndpoint. Hal ini termasuk:

pipeline_parameters: Parameter untuk eksekusi alur, kamus {name: value}. Lihat PipelineParameter untuk detail selengkapnya.
parent_run_id: Anda dapat memberikan ID eksekusi untuk mengatur eksekusi induk dari eksekusi alur ini, yang tercermin dalam RunHistory. Proses induk harus termasuk dalam eksperimen yang sama dengan eksperimen yang menjadi tujuan pengiriman alur ini.
pipeline_version: Versi alur yang akan dijalankan.

Contoh untuk mengirimkan PipelineEndpoint menggunakan pengaturan ini adalah sebagai berikut:


   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")

Untuk menambahkan versi baru penggunaan PipelineEndpoint:


   from azureml.pipeline.core import PipelineEndpoint

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

Lihat notebook berikut sebagai informasi tambahan tentang membuat dan menggunakan PipelineEndpoint: https://aka.ms/pl-ver-endpoint.

Metode

add	Tambahkan alur yang ditentukan ke PipelineEndpoint.
add_default	Tambahkan alur yang ditentukan ke PipelineEndpoint dan atur versi default ke versi alur yang ditambahkan.
archive	Mengarsipkan PipelineEndpoint.
disable	Atur PipelineEndpoint ke 'Dinonaktifkan' dan tidak tersedia untuk dijalankan.
enable	Atur PipelineEndpoint ke 'Aktif' dan tersedia untuk dijalankan.
get	Dapatkan PipelineEndpoint berdasarkan nama atau ID, berikan pengecualian jika salah satu tidak tersedia.
get_all	Dapatkan semua PipelineEndpoint aktif di ruang kerja saat ini. Dapatkan semua PipelineEndpoint yang aktif. CATATAN: Metode ini tidak digunakan lagi demi PipelineEndpoint.list().
get_all_pipelines	Dapatkan daftar alur di PipelineEndpoint. CATATAN: Metode ini tidak digunakan lagi demi list_pipelines()
get_all_versions	Dapatkan daftar alur dan versi terkait di PipelineEndpoint. CATATAN: Metode ini tidak digunakan lagi demi list_versions()
get_default_version	Dapatkan versi default PipelineEndpoint.
get_pipeline	Dapatkan alur dari versi tertentu atau default; memberikan pengecualian jika versi tidak ditemukan.
list	Buat daftar PipelineEndpoint aktif di ruang kerja saat ini.
list_pipelines	Dapatkan daftar alur yang terkait dengan PipelineEndpoint.
list_versions	Dapatkan daftar alur dan versi PipelineEndpoint yang sesuai.
publish	Buat PipelineEndpoint dengan nama dan alur yang ditentukan/alur yang diterbitkan. Titik akhir alur adalah REST API yang dapat digunakan dari aplikasi eksternal. Untuk informasi tentang cara mengautentikasi saat memanggil titik akhir REST, lihat https://aka.ms/pl-restep-auth. Untuk informasi selengkapnya tentang bekerja dengan titik akhir alur, lihat https://aka.ms/pl-first-pipeline. Menghilangkan Pengecualian jika PipelineEndpoint dengan nama yang diberikan sudah ada.
reactivate	Mengaktifkan kembali PipelineEndpoint yang diarsipkan.
set_default	Atur versi default PipelineEndpoint, berikan pengecualian jika alur yang ditentukan tidak ditemukan.
set_default_version	Atur versi default PipelineEndpoint, berikan pengecualian jika versi yang ditentukan tidak ditemukan.
set_name	Atur nama PipelineEndpoint.
submit	Mengirimkan eksperimen alur versi yang diberikan; jika versi tidak ada yang memicu versi default alur.

add

Tambahkan alur yang ditentukan ke PipelineEndpoint.

add(pipeline)

Parameter

Nama	Deskripsi
pipeline Diperlukan	PublishedPipeline Alur yang diterbitkan ditambahkan.

add_default

Tambahkan alur yang ditentukan ke PipelineEndpoint dan atur versi default ke versi alur yang ditambahkan.

add_default(pipeline)

Parameter

Nama	Deskripsi
pipeline Diperlukan	PublishedPipeline Alur yang diterbitkan untuk ditambahkan sebagai versi default.

disable

Atur PipelineEndpoint ke 'Dinonaktifkan' dan tidak tersedia untuk dijalankan.

disable()

enable

Atur PipelineEndpoint ke 'Aktif' dan tersedia untuk dijalankan.

enable()

get

Dapatkan PipelineEndpoint berdasarkan nama atau ID, berikan pengecualian jika salah satu tidak tersedia.

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

Parameter

Nama	Deskripsi
workspace Diperlukan	Workspace Ruang kerja tempat PipelineEndpoint dibuat.
id	str ID PipelineEndpoint. Nilai default: None
name	str Nama PipelineEndpoint. Nilai default: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Penyedia alur kerja. Nilai default: None
_service_endpoint	str Titik akhir layanan. Nilai default: None

Mengembalikan

Jenis	Deskripsi
PipelineEndpoint	Objek PipelineEndpoint.

get_all

Dapatkan semua PipelineEndpoint aktif di ruang kerja saat ini.

Dapatkan semua PipelineEndpoint yang aktif. CATATAN: Metode ini tidak digunakan lagi demi PipelineEndpoint.list().

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

Parameter

Nama	Deskripsi
workspace Diperlukan	Workspace Ruang kerja.
active_only	bool Jika true, hanya menampilkan PipelineEndpoint yang saat ini aktif. Nilai default: True
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Penyedia alur kerja. Nilai default: None
_service_endpoint	str Titik akhir layanan. Nilai default: None

Mengembalikan

Jenis	Deskripsi
list	Daftar PipelineEndpoint objek.

get_all_pipelines

Dapatkan daftar alur di PipelineEndpoint.

CATATAN: Metode ini tidak digunakan lagi demi list_pipelines()

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

Parameter

Nama	Deskripsi
active_only	bool Beri bendera untuk mengembalikan alur aktif saja. Nilai default: True
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Penyedia alur kerja. Nilai default: None
_service_endpoint	str Titik akhir layanan. Nilai default: None

Mengembalikan

Jenis	Deskripsi
list	Daftar PublishedPipeline objek.

get_all_versions

Dapatkan daftar alur dan versi terkait di PipelineEndpoint.

CATATAN: Metode ini tidak digunakan lagi demi list_versions()

get_all_versions(_workflow_provider=None, _service_endpoint=None)

Parameter

Nama	Deskripsi
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Penyedia alur kerja. Nilai default: None
_service_endpoint	str Titik akhir layanan. Nilai default: None

Mengembalikan

Jenis	Deskripsi
list	Daftar PipelineVersion objek.

get_default_version

Dapatkan versi default PipelineEndpoint.

get_default_version()

Mengembalikan

Jenis	Deskripsi
str	Versi default titik akhir alur.

get_pipeline

Dapatkan alur dari versi tertentu atau default; memberikan pengecualian jika versi tidak ditemukan.

get_pipeline(version=None)

Parameter

Nama	Deskripsi
version	str Versi alur untuk kembali. Nilai default: None

Mengembalikan

Jenis	Deskripsi
PublishedPipeline	Alur yang diterbitkan.

list

Buat daftar PipelineEndpoint aktif di ruang kerja saat ini.

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

Parameter

Nama	Deskripsi
workspace Diperlukan	Workspace Ruang kerja.
active_only	bool Jika true, hanya menampilkan PipelineEndpoint yang saat ini aktif. Nilai default: True
max_results	int baris maks dari PipelineEndpoints yang dikembalikan Nilai default: 100
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Penyedia alur kerja. Nilai default: None
_service_endpoint	str Titik akhir layanan. Nilai default: None

Mengembalikan

Jenis	Deskripsi
list	Daftar PipelineEndpoint objek.

list_pipelines

Dapatkan daftar alur yang terkait dengan PipelineEndpoint.

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

Parameter

Nama	Deskripsi
active_only	bool Menunjukkan apakah hanya alur aktif yang dikembalikan. Nilai default: True
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Penyedia alur kerja. Nilai default: None
_service_endpoint	str Titik akhir layanan. Nilai default: None

Mengembalikan

Jenis	Deskripsi
list	Daftar PublishedPipeline objek.

list_versions

Dapatkan daftar alur dan versi PipelineEndpoint yang sesuai.

list_versions(_workflow_provider=None, _service_endpoint=None)

Parameter

Nama	Deskripsi
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Penyedia alur kerja. Nilai default: None
_service_endpoint	str Titik akhir layanan. Nilai default: None

Mengembalikan

Jenis	Deskripsi
list	Daftar PipelineVersion objek.

publish

Buat PipelineEndpoint dengan nama dan alur yang ditentukan/alur yang diterbitkan.

Titik akhir alur adalah REST API yang dapat digunakan dari aplikasi eksternal. Untuk informasi tentang cara mengautentikasi saat memanggil titik akhir REST, lihat https://aka.ms/pl-restep-auth.

Untuk informasi selengkapnya tentang bekerja dengan titik akhir alur, lihat https://aka.ms/pl-first-pipeline.

Menghilangkan Pengecualian jika PipelineEndpoint dengan nama yang diberikan sudah ada.

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

Parameter

Nama	Deskripsi
workspace Diperlukan	Workspace Ruang kerja untuk membuat PipelineEndpoint.
name Diperlukan	str Nama PipelineEndpoint.
description Diperlukan	str Deskripsi PipelineEndpoint.
pipeline Diperlukan	PublishedPipeline atau Pipeline Alur atau alur yang diterbitkan.
_service_endpoint	str Titik akhir layanan. Nilai default: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Penyedia alur kerja. Nilai default: None

Mengembalikan

Jenis	Deskripsi
PipelineEndpoint	PipelineEndpoint baru.

Pengecualian

Jenis	Deskripsi
ValueError

reactivate

Mengaktifkan kembali PipelineEndpoint yang diarsipkan.

reactivate(name)

Parameter

Nama	Deskripsi
name Diperlukan	str Nama yang akan ditetapkan.

Mengembalikan

Jenis	Deskripsi
PipelineEndpoint	Objek PipelineEndpoint.

set_default

Atur versi default PipelineEndpoint, berikan pengecualian jika alur yang ditentukan tidak ditemukan.

set_default(pipeline)

Parameter

Nama	Deskripsi
pipeline Diperlukan	PublishedPipeline Alur yang diterbitkan untuk ditetapkan sebagai default.

Pengecualian

Jenis	Deskripsi
ValueError

set_default_version

Atur versi default PipelineEndpoint, berikan pengecualian jika versi yang ditentukan tidak ditemukan.

set_default_version(version)

Parameter

Nama	Deskripsi
version Diperlukan	str Versi yang akan ditetapkan sebagai versi default di PipelineEndpoint.

Pengecualian

Jenis	Deskripsi
ValueError

set_name

Atur nama PipelineEndpoint.

set_name(name)

Parameter

Nama	Deskripsi
name Diperlukan	str Nama yang akan ditetapkan.

submit

Mengirimkan eksperimen alur versi yang diberikan; jika versi tidak ada yang memicu versi default alur.

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

Parameter

Nama	Deskripsi
experiment_name Diperlukan	str Nama eksperimen untuk mengirimkan alur.
pipeline_parameters	dict Parameter yang akan digunakan dalam eksekusi alur, diteruskan sebagai kamus {name: value}. Lihat PipelineParameter untuk detail selengkapnya. Nilai default: None
parent_run_id	str Anda dapat memberikan ID eksekusi untuk mengatur eksekusi induk dari eksekusi alur ini, yang tercermin dalam RunHistory. Eksekusi induk harus termasuk dalam eksperimen yang sama dengan alur pengiriman ini. Nilai default: None
pipeline_version	str Versi alur yang akan dijalankan. Nilai default: None

Mengembalikan

Jenis	Deskripsi
PipelineRun	Alur yang dikirimkan berjalan.

Pengecualian

Jenis	Deskripsi
ValueError

Atribut

default_version

Dapatkan versi default PipelineEndpoint.

Mengembalikan

Jenis	Deskripsi
str	Versi default.

description

Deskripsi PipelineEndpoint.

Mengembalikan

Jenis	Deskripsi
str	Deskripsi.

endpoint

Dapatkan URL titik akhir REST dari PipelineEndpoint.

Titik akhir dapat digunakan untuk memicu eksekusi alur.

Mengembalikan

Jenis	Deskripsi
str	Titik akhir REST untuk PipelineEndpoint untuk menjalankan alur.

id

Dapatkan ID dari PipelineEndpoint.

Mengembalikan

Jenis	Deskripsi
str	ID PipelineEndpoint.

name

Dapatkan nama PipelineEndpoint.

Mengembalikan

Jenis	Deskripsi
str	Nama.

pipeline_version_list

Dapatkan daftar versi alur.

Mengembalikan

Jenis	Deskripsi
list	Daftar PipelineIdVersion objek.

status

Dapatkan status PipelineEndpoint.

Mengembalikan

Jenis	Deskripsi
str	Status.

swaggerurl

Dapatkan URL REST Swagger pada PipelineEndpoint.

Url Swagger dapat melihat skema titik akhir alur.

Mengembalikan

Jenis	Deskripsi
str	REST Swagger untuk PipelineEndpoint untuk menjalankan alur.

Bagikan melalui

PipelineEndpoint Kelas

Konstruktor

Parameter

Keterangan

Metode

add

Parameter

add_default

Parameter

archive

disable

enable

get

Parameter

Mengembalikan

get_all

Parameter

Mengembalikan

get_all_pipelines

Parameter

Mengembalikan

get_all_versions

Parameter

Mengembalikan

get_default_version

Mengembalikan

get_pipeline

Parameter

Mengembalikan

list

Parameter

Mengembalikan

list_pipelines

Parameter

Mengembalikan

list_versions

Parameter

Mengembalikan

publish

Parameter

Mengembalikan

Pengecualian

reactivate

Parameter

Mengembalikan

set_default

Parameter

Pengecualian

set_default_version

Parameter

Pengecualian

set_name

Parameter

submit

Parameter

Mengembalikan

Pengecualian

Atribut

default_version

Mengembalikan

description

Mengembalikan

endpoint

Mengembalikan

id

Mengembalikan

name

Mengembalikan

pipeline_version_list

Mengembalikan

status

Mengembalikan

swaggerurl

Mengembalikan

Saran dan Komentar

Sumber Daya Tambahan: