Bagikan melalui

PipelineRun Kelas

  • Referensi

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
Run
PipelineRun

Konstruktor

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

Parameter

Nama Deskripsi
experiment
Diperlukan
Experiment

Objek eksperimen yang terkait dengan eksekusi alur.
run_id
Diperlukan
str

ID eksekusi dari eksekusi alur.
_service_endpoint
str

Titik akhir yang akan dihubungkan.

nilai default: None
experiment
Diperlukan
Experiment

Objek eksperimen yang terkait dengan eksekusi alur.
run_id
Diperlukan
str

ID eksekusi dari eksekusi alur.
_service_endpoint
Diperlukan
str

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

Nama Deskripsi
name
str

Nama opsional untuk turunan.

nilai default: None
run_id
str

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

nilai default: None
outputs
str

Direktori output opsional untuk melacak turunan.

nilai default: None

Mengembalikan

Jenis Deskripsi
Run

Eksekusi turunan.

Pengecualian

Jenis Deskripsi
NotImplementedError

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

Jenis Deskripsi
NotImplementedError

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

Jenis Deskripsi
NotImplementedError

find_step_run

Temukan eksekusi langkah dalam alur berdasarkan nama.

find_step_run(name)

Parameter

Nama Deskripsi
name
Diperlukan
str

Nama langkah yang akan ditemukan.

Mengembalikan

Jenis Deskripsi
list

Daftar objek StepRun dengan nama yang diberikan.

get

Ambil eksekusi alur berdasarkan ID eksekusi.

static get(workspace, run_id, _service_endpoint=None)

Parameter

Nama Deskripsi
workspace
Diperlukan
Workspace

Ruang kerja yang terkait dengan alur.
run_id
Diperlukan
str

ID eksekusi alur.
_service_endpoint
str

Titik akhir yang akan dihubungkan.

nilai default: None

Mengembalikan

Jenis Deskripsi
PipelineRun

Objek PipelineRun.

get_graph

Dapatkan grafik eksekusi alur.

get_graph()

Mengembalikan

Jenis Deskripsi
Graph

Grafik.

get_pipeline_output

Dapatkan PortDataReference untuk output alur yang diberikan.

get_pipeline_output(pipeline_output_name)

Parameter

Nama Deskripsi
pipeline_output_name
Diperlukan
str

Nama output alur yang akan didapat.

Mengembalikan

Jenis Deskripsi
PortDataReference

PortDataReference mewakili data output alur.

get_pipeline_runs

Ambil eksekusi alur yang dihasilkan dari alur yang diterbitkan.

static get_pipeline_runs(workspace, pipeline_id, _service_endpoint=None)

Parameter

Nama Deskripsi
workspace
Diperlukan
Workspace

Ruang kerja yang terkait dengan alur.
pipeline_id
Diperlukan
str

ID dari alur yang diterbitkan.
_service_endpoint
str

Titik akhir yang akan dihubungkan.

nilai default: None

Mengembalikan

Jenis Deskripsi
list

Daftar objek PipelineRun.

get_status

Ambil status terbaru eksekusi alur dari layanan.

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

get_status()

Mengembalikan

Jenis Deskripsi
str

Status terbaru sebagai string.

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

Jenis Deskripsi
list

Daftar objek StepRun.

get_tags

Dapatkan kumpulan tag untuk eksekusi.

get_tags()

Mengembalikan

Jenis Deskripsi
dict

Kamus 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.

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

Parameter

Nama Deskripsi
name
Diperlukan
str

Nama alur yang diterbitkan.
description
Diperlukan
str

Deskripsi alur yang diterbitkan.
version
Diperlukan
str

Versi alur yang diterbitkan.
continue_on_step_failure
bool

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

nilai default: None
kwargs
Diperlukan
dict

Argumen kata kunci kustom, dicadangkan untuk pengembangan di masa mendatang

Mengembalikan

Jenis Deskripsi
PublishedPipeline

Membuat alur yang diterbitkan.

save

Simpan YAML alur ke file.

save(path=None)

Parameter

Nama Deskripsi
path
str

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.

nilai default: None

Mengembalikan

Jenis Deskripsi
None

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

Nama Deskripsi
show_output
bool

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

nilai default: True
timeout_seconds
int

Jumlah detik untuk menunggu sebelum waktu habis.

nilai default: 9223372036854775807
raise_on_error
bool

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

nilai default: True

Mengembalikan

Jenis Deskripsi
str

Status terakhir.