PipelineEndpoint Kelas
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.
- Warisan
-
builtins.objectPipelineEndpoint
Konstruktor
PipelineEndpoint(workspace, id, name, description, status, default_version, endpoint, pipeline_version_list, _pipeline_endpoint_provider=None, _published_pipeline_provider=None, _swaggerurl=None)Parameter
- default_version
- str
Versi default alur di PipelineEndpoint, penambahan otomatis, dimulai dengan "0".
- endpoint
- str
URL titik akhir REST untuk PipelineEndpoint, yang dapat digunakan untuk mengirimkan eksekusi alur.
- _pipeline_endpoint_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaPublishedPipelineProvider>
Penyedia PipelineEndpoint.
- _pipeline_endpoint_provider
Penyedia PublishedPipeline.
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
add_default
Tambahkan alur yang ditentukan ke PipelineEndpoint dan atur versi default ke versi alur yang ditambahkan.
add_default(pipeline)Parameter
- pipeline
- PublishedPipeline
Alur yang diterbitkan untuk ditambahkan sebagai versi default.
archive
Mengarsipkan PipelineEndpoint.
archive()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
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
Penyedia alur kerja.
Mengembalikan
Objek PipelineEndpoint.
Tipe hasil
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
- active_only
- bool
Jika true, hanya menampilkan PipelineEndpoint yang saat ini aktif.
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
Penyedia alur kerja.
Mengembalikan
Daftar PipelineEndpoint objek.
Tipe hasil
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
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
Penyedia alur kerja.
Mengembalikan
Daftar PublishedPipeline objek.
Tipe hasil
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
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
Penyedia alur kerja.
Mengembalikan
Daftar PipelineVersion objek.
Tipe hasil
get_default_version
Dapatkan versi default PipelineEndpoint.
get_default_version()Mengembalikan
Versi default titik akhir alur.
Tipe hasil
get_pipeline
Dapatkan alur dari versi tertentu atau default; memberikan pengecualian jika versi tidak ditemukan.
get_pipeline(version=None)Parameter
Mengembalikan
Alur yang diterbitkan.
Tipe hasil
list
Buat daftar PipelineEndpoint aktif di ruang kerja saat ini.
static list(workspace, active_only=True, _workflow_provider=None, _service_endpoint=None)Parameter
- active_only
- bool
Jika true, hanya menampilkan PipelineEndpoint yang saat ini aktif.
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
Penyedia alur kerja.
Mengembalikan
Daftar PipelineEndpoint objek.
Tipe hasil
list_pipelines
Dapatkan daftar alur yang terkait dengan PipelineEndpoint.
list_pipelines(active_only=True, _workflow_provider=None, _service_endpoint=None)Parameter
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
Penyedia alur kerja.
Mengembalikan
Daftar PublishedPipeline objek.
Tipe hasil
list_versions
Dapatkan daftar alur dan versi PipelineEndpoint yang sesuai.
list_versions(_workflow_provider=None, _service_endpoint=None)Parameter
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
Penyedia alur kerja.
Mengembalikan
Daftar PipelineVersion objek.
Tipe hasil
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
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
Penyedia alur kerja.
Mengembalikan
PipelineEndpoint baru.
Tipe hasil
Pengecualian
reactivate
Mengaktifkan kembali PipelineEndpoint yang diarsipkan.
reactivate(name)Parameter
Mengembalikan
Objek PipelineEndpoint.
Tipe hasil
set_default
Atur versi default PipelineEndpoint, berikan pengecualian jika alur yang ditentukan tidak ditemukan.
set_default(pipeline)Parameter
Pengecualian
set_default_version
Atur versi default PipelineEndpoint, berikan pengecualian jika versi yang ditentukan tidak ditemukan.
set_default_version(version)Parameter
Pengecualian
set_name
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
- pipeline_parameters
- dict
Parameter yang akan digunakan dalam eksekusi alur, diteruskan sebagai kamus {name: value}. Lihat PipelineParameter untuk detail selengkapnya.
- 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.
Mengembalikan
Alur yang dikirimkan berjalan.
Tipe hasil
Pengecualian
Atribut
default_version
description
endpoint
Dapatkan URL titik akhir REST dari PipelineEndpoint.
Titik akhir dapat digunakan untuk memicu eksekusi alur.
Mengembalikan
Titik akhir REST untuk PipelineEndpoint untuk menjalankan alur.
Tipe hasil
id
name
pipeline_version_list
status
swaggerurl
Dapatkan URL REST Swagger pada PipelineEndpoint.
Url Swagger dapat melihat skema titik akhir alur.
Mengembalikan
REST Swagger untuk PipelineEndpoint untuk menjalankan alur.
Tipe hasil
Saran dan Komentar
Kirim dan lihat umpan balik untuk