Bagikan melalui


PipelineRun Kelas

Mewakili eksekusi dari Pipeline.

Kelas ini dapat digunakan untuk mengelola, memeriksa status, dan mengambil detail eksekusi setelah alur dijalankan. Gunakan get_steps untuk mengambil objek StepRun yang dibuat oleh alur yang dijalankan. Kegunaan lain termasuk mengambil objek Graph yang terkait dengan eksekusi alur, mengambil status eksekusi alur, dan menunggu penyelesaian eksekusi.

Menginisialisasi eksekusi Alur.

Warisan
PipelineRun

Konstruktor

PipelineRun(experiment, run_id, _service_endpoint=None, **kwags)

Parameter

experiment
Experiment
Diperlukan

Objek eksperimen yang terkait dengan eksekusi alur.

run_id
str
Diperlukan

ID eksekusi dari eksekusi alur.

_service_endpoint
str
nilai default: None

Titik akhir yang akan dihubungkan.

experiment
Experiment
Diperlukan

Objek eksperimen yang terkait dengan eksekusi alur.

run_id
str
Diperlukan

ID eksekusi dari eksekusi alur.

_service_endpoint
str
Diperlukan

Titik akhir yang akan dihubungkan.

Keterangan

Objek PipelineRun ditampilkan saat mengirimkan Pipeline melalui submit. metode Experiment. Untuk informasi selengkapnya tentang cara membuat dan mengirimkan Alur, lihat: https://aka.ms/pl-first-pipeline.

PipelineRun juga dapat dibuat dengan Experiment eksekusi yang dikirimkan dan ID PipelineRun sebagai berikut:


   from azureml.core import Experiment
   from azureml.pipeline.core import PipelineRun

   experiment = Experiment(workspace, "<experiment_name>")
   pipeline_run = PipelineRun(experiment, "<pipeline_run_id>")

Saat bekerja dengan PipelineRun, gunakan:

  • wait_for_completion untuk memantau status eksekusi dan secara opsional mengalirkan log eksekusi.

  • get_status untuk mengambil status eksekusi.

  • cancel untuk membatalkan PipelineRun yang sedang berlangsung.

  • get_steps untuk mencantumkan StepRuns yang dihasilkan. PipelineRun menghasilkan StepRun untuk setiap langkah di Alur.

Metode

cancel

Batalkan eksekusi yang sedang berlangsung.

child_run

Buat eksekusi turunan untuk eksekusi alur. Metode ini tidak diterapkan untuk PipelineRun.

complete

Tandai eksekusi alur sebagai selesai. Metode ini tidak diterapkan untuk PipelineRun.

Metode ini tidak didukung untuk alur; status selesai/gagal dikelola oleh backend Azure Machine Learning.

fail

Tandai eksekusi alur sebagai gagal. Metode ini tidak diterapkan untuk PipelineRun.

Metode ini tidak didukung untuk alur; status selesai/gagal dikelola oleh backend Azure Machine Learning.

find_step_run

Temukan eksekusi langkah dalam alur berdasarkan nama.

get

Ambil eksekusi alur berdasarkan ID eksekusi.

get_graph

Dapatkan grafik eksekusi alur.

get_pipeline_output

Dapatkan PortDataReference untuk output alur yang diberikan.

get_pipeline_runs

Ambil eksekusi alur yang dihasilkan dari alur yang diterbitkan.

get_status

Ambil status terbaru eksekusi alur dari layanan.

Nilai umum yang ditampilkan termasuk "Sedang Berjalan", "Selesai", dan "Gagal".

get_steps

Dapatkan eksekusi langkah untuk semua langkah alur yang telah selesai atau mulai berjalan.

get_tags

Dapatkan kumpulan tag untuk eksekusi.

publish_pipeline

Terbitkan alur dan sediakan untuk dijalankan kembali.

Anda bisa mendapatkan titik akhir alur dari objek PublishedPipeline yang ditampilkan oleh fungsi ini. Dengan titik akhir alur, Anda dapat memanggil alur dari aplikasi eksternal menggunakan panggilan REST. Untuk informasi tentang cara mengautentikasi saat memanggil titik akhir REST, lihat https://aka.ms/pl-restep-auth.

Alur asli yang terkait dengan eksekusi alur digunakan sebagai dasar untuk alur yang diterbitkan.

save

Simpan YAML alur ke file.

wait_for_completion

Tunggu hingga eksekusi alur ini selesai.

Tampilkan status setelah menunggu.

cancel

Batalkan eksekusi yang sedang berlangsung.

cancel()

child_run

Buat eksekusi turunan untuk eksekusi alur. Metode ini tidak diterapkan untuk PipelineRun.

child_run(name=None, run_id=None, outputs=None)

Parameter

name
str
nilai default: None

Nama opsional untuk turunan.

run_id
str
nilai default: None

ID eksekusi opsional untuk turunan, jika tidak, menggunakan default.

outputs
str
nilai default: None

Direktori output opsional untuk melacak turunan.

Mengembalikan

Eksekusi turunan.

Tipe hasil

Run

Pengecualian

complete

Tandai eksekusi alur sebagai selesai. Metode ini tidak diterapkan untuk PipelineRun.

Metode ini tidak didukung untuk alur; status selesai/gagal dikelola oleh backend Azure Machine Learning.

complete()

Pengecualian

fail

Tandai eksekusi alur sebagai gagal. Metode ini tidak diterapkan untuk PipelineRun.

Metode ini tidak didukung untuk alur; status selesai/gagal dikelola oleh backend Azure Machine Learning.

fail()

Pengecualian

find_step_run

Temukan eksekusi langkah dalam alur berdasarkan nama.

find_step_run(name)

Parameter

name
str
Diperlukan

Nama langkah yang akan ditemukan.

Mengembalikan

Daftar objek StepRun dengan nama yang diberikan.

Tipe hasil

get

Ambil eksekusi alur berdasarkan ID eksekusi.

static get(workspace, run_id, _service_endpoint=None)

Parameter

workspace
Workspace
Diperlukan

Ruang kerja yang terkait dengan alur.

run_id
str
Diperlukan

ID eksekusi alur.

_service_endpoint
str
nilai default: None

Titik akhir yang akan dihubungkan.

Mengembalikan

Objek PipelineRun.

Tipe hasil

get_graph

Dapatkan grafik eksekusi alur.

get_graph()

Mengembalikan

Grafik.

Tipe hasil

get_pipeline_output

Dapatkan PortDataReference untuk output alur yang diberikan.

get_pipeline_output(pipeline_output_name)

Parameter

pipeline_output_name
str
Diperlukan

Nama output alur yang akan didapat.

Mengembalikan

PortDataReference mewakili data output alur.

Tipe hasil

get_pipeline_runs

Ambil eksekusi alur yang dihasilkan dari alur yang diterbitkan.

static get_pipeline_runs(workspace, pipeline_id, _service_endpoint=None)

Parameter

workspace
Workspace
Diperlukan

Ruang kerja yang terkait dengan alur.

pipeline_id
str
Diperlukan

ID dari alur yang diterbitkan.

_service_endpoint
str
nilai default: None

Titik akhir yang akan dihubungkan.

Mengembalikan

Daftar objek PipelineRun.

Tipe hasil

get_status

Ambil status terbaru eksekusi alur dari layanan.

Nilai umum yang ditampilkan termasuk "Sedang Berjalan", "Selesai", dan "Gagal".

get_status()

Mengembalikan

Status terbaru sebagai string.

Tipe hasil

str

Keterangan

  • NotStarted - Ini adalah status sementara objek Eksekusi sisi-klien sebelum pengiriman cloud

  • Sedang Berjalan - Pekerjaan mulai berjalan di target komputasi.

  • Gagal - Eksekusi gagal. Biasanya properti Error pada eksekusi akan menyediakan detail alasannya.

  • Selesai - Eksekusi selesai dengan sukses.

  • Dibatalkan - Setelah permintaan pembatalan, eksekusi sekarang berhasil dibatalkan.


   run = experiment.submit(config)
   while run.get_status() not in ['Finished', 'Failed']: # For example purposes only, not exhaustive
       print('Run {} not in terminal state'.format(run.id))
       time.sleep(10)

get_steps

Dapatkan eksekusi langkah untuk semua langkah alur yang telah selesai atau mulai berjalan.

get_steps()

Mengembalikan

Daftar objek StepRun.

Tipe hasil

get_tags

Dapatkan kumpulan tag untuk eksekusi.

get_tags()

Mengembalikan

Kamus tag untuk eksekusi.

Tipe hasil

publish_pipeline

Terbitkan alur dan sediakan untuk dijalankan kembali.

Anda bisa mendapatkan titik akhir alur dari objek PublishedPipeline yang ditampilkan oleh fungsi ini. Dengan titik akhir alur, Anda dapat memanggil alur dari aplikasi eksternal menggunakan panggilan REST. Untuk informasi tentang cara mengautentikasi saat memanggil titik akhir REST, lihat https://aka.ms/pl-restep-auth.

Alur asli yang terkait dengan eksekusi alur digunakan sebagai dasar untuk alur yang diterbitkan.

publish_pipeline(name, description, version, continue_on_step_failure=None, **kwargs)

Parameter

name
str
Diperlukan

Nama alur yang diterbitkan.

description
str
Diperlukan

Deskripsi alur yang diterbitkan.

version
str
Diperlukan

Versi alur yang diterbitkan.

continue_on_step_failure
bool
nilai default: None

Apakah akan melanjutkan eksekusi langkah lain di PipelineRun jika langkah gagal atau tidak. Defaultnya adalah False.

kwargs
dict
Diperlukan

Argumen kata kunci kustom, dicadangkan untuk pengembangan di masa mendatang

Mengembalikan

Membuat alur yang diterbitkan.

Tipe hasil

save

Simpan YAML alur ke file.

save(path=None)

Parameter

path
str
nilai default: None

Jalur untuk menyimpan YAML. Jika jalur adalah direktori, file YAML alur disimpan di <path>/pipeline.yml. Jika jalur adalah tidak ada, direktori saat ini digunakan.

Tipe hasil

wait_for_completion

Tunggu hingga eksekusi alur ini selesai.

Tampilkan status setelah menunggu.

wait_for_completion(show_output=True, timeout_seconds=9223372036854775807, raise_on_error=True)

Parameter

show_output
bool
nilai default: True

Tunjukkan apakah akan menampilkan status eksekusi alur di sys.stdout atau tidak.

timeout_seconds
int
nilai default: 9223372036854775807

Jumlah detik untuk menunggu sebelum waktu habis.

raise_on_error
bool
nilai default: True

Tunjukkan apakah akan memunculkan kesalahan saat eksekusi dalam status gagal atau tidak.

Mengembalikan

Status terakhir.

Tipe hasil

str