Bagikan melalui

StepRun Kelas

Menjalankan langkah dalam Pipeline.

Kelas ini dapat digunakan untuk mengelola, memeriksa status, dan mengambil detail eksekusi setelah eksekusi alur induk dikirimkan dan alur telah mengirimkan langkah yang dijalankan.

Menginisialisasi StepRun.

Konstruktor

StepRun(experiment, step_run_id, pipeline_run_id, node_id, _service_endpoint=None, _is_reused=False, _current_node_id=None, _reused_run_id=None, _reused_node_id=None, _reused_pipeline_run_id=None, **kwargs)

Parameter

Nama Deskripsi
experiment
Diperlukan
Experiment

Objek eksperimen dari langkah yang dijalankan.
step_run_id
Diperlukan
str

ID eksekusi dari langkah yang dijalankan.
pipeline_run_id
Diperlukan
str

ID eksekusi dari eksekusi alur induk.
node_id
Diperlukan
str

ID simpul dalam grafik yang mewakili langkah ini.
_service_endpoint
str

Titik akhir yang akan disambungkan.

Nilai default: None
_is_reused
bool

Menunjukkan apakah eksekusi ini adalah eksekusi sebelumnya yang digunakan kembali.

Nilai default: False
_current_node_id
str

Untuk simpul yang digunakan kembali, ID simpul pada grafik saat ini.

Nilai default: None
_reused_run_id
str

ID eksekusi yang digunakan kembali.

Nilai default: None
_reused_node_id
str

ID simpul yang digunakan kembali.

Nilai default: None
_reused_pipeline_run_id
str

ID alur yang digunakan kembali.

Nilai default: None
experiment
Diperlukan
Experiment

Objek eksperimen dari langkah yang dijalankan.
step_run_id
Diperlukan
str

ID eksekusi dari langkah yang dijalankan.
pipeline_run_id
Diperlukan
str

ID eksekusi dari eksekusi alur induk.
node_id
Diperlukan
str

ID simpul dalam grafik yang mewakili langkah ini.
_service_endpoint
Diperlukan
str

Titik akhir yang akan disambungkan.
_is_reused
Diperlukan
bool

Menunjukkan apakah eksekusi ini adalah eksekusi sebelumnya yang digunakan kembali.
_current_node_id
Diperlukan
str

Untuk simpul yang digunakan kembali, ID simpul pada grafik saat ini.
_reused_run_id
Diperlukan
_reused_node_id
Diperlukan
str
_reused_pipeline_run_id
Diperlukan
str

Keterangan

StepRun dibuat sebagai eksekusi turunan dari yang dikirimkan PipelineRun. Ambil semua StepRuns dalam 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>")
   step_runs = pipeline_run.get_steps()

Gunakan get_details_with_logs untuk mengambil detail eksekusi dan log yang dibuat oleh eksekusi.

StepRun juga dapat digunakan untuk mengunduh output eksekusi. Gunakan get_outputs untuk mengambil dict output langkah, atau gunakan get_output untuk mengambil objek tunggal StepRunOutput untuk output dengan nama yang disediakan. Anda juga dapat menggunakan get_output_data untuk mengambil PortDataReference untuk output langkah yang ditentukan secara langsung.

Contoh mengunduh output langkah adalah sebagai berikut:


   from azureml.pipeline.core import PipelineRun, StepRun, PortDataReference

   pipeline_run = PipelineRun(experiment, "<pipeline_run_id>")
   step_run = pipeline_run.find_step_run("<step_name>")[0]
   port_data_reference = step_run.get_output_data("<output_name>")
   port_data_reference.download(local_path="path")

Metode

child_run

Eksekusi anak untuk eksekusi langkah. Metode ini tidak diimplementasikan untuk StepRun.
complete

Selesai untuk langkah yang dijalankan. Metode ini tidak diimplementasikan untuk StepRun.
fail

Gagal untuk eksekusi langkah. Metode ini tidak diimplementasikan untuk StepRun.
get_details_with_logs

Mengembalikan detail status eksekusi dengan konten file log.
get_job_log

Buang log pekerjaan saat ini untuk langkah yang dijalankan.
get_output

Dapatkan output simpul dengan nama yang diberikan.
get_output_data

Dapatkan data output dari output tertentu.
get_outputs

Dapatkan output langkah.
get_status

Ambil status terbaru eksekusi alur dari layanan.

Nilai umum yang dikembalikan termasuk "Berjalan", "Selesai", dan "Gagal".
get_stderr_log

Buang log stderr saat ini untuk langkah yang dijalankan.
get_stdout_log

Buang log stdout saat ini untuk langkah yang dijalankan.
wait_for_completion

Tunggu penyelesaian eksekusi langkah ini.

Mengembalikan status setelah menunggu.

child_run

Eksekusi anak untuk eksekusi langkah. Metode ini tidak diimplementasikan untuk StepRun.

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

Parameter

Nama Deskripsi
name
str

Nama opsional untuk anak

Nilai default: None
run_id
str

Run_id opsional untuk anak, jika tidak, gunakan default

Nilai default: None
outputs
str

Direktori output opsional untuk dilacak untuk anak

Nilai default: None

Mengembalikan

Jenis Deskripsi
Run

Eksekusi anak

Pengecualian

Jenis Deskripsi
NotImplementedError

complete

Selesai untuk langkah yang dijalankan. Metode ini tidak diimplementasikan untuk StepRun.

complete()

Pengecualian

Jenis Deskripsi
NotImplementedError

fail

Gagal untuk eksekusi langkah. Metode ini tidak diimplementasikan untuk StepRun.

fail()

Pengecualian

Jenis Deskripsi
NotImplementedError

get_details_with_logs

Mengembalikan detail status eksekusi dengan konten file log.

get_details_with_logs()

Mengembalikan

Jenis Deskripsi
dict

Mengembalikan status untuk eksekusi dengan konten file log

get_job_log

Buang log pekerjaan saat ini untuk langkah yang dijalankan.

get_job_log()

Mengembalikan

Jenis Deskripsi
str

String log.

get_output

Dapatkan output simpul dengan nama yang diberikan.

get_output(name)

Parameter

Nama Deskripsi
name
Diperlukan
str

Nama output.

Mengembalikan

Jenis Deskripsi
StepRunOutput

StepRunOutput dengan nama yang diberikan.

get_output_data

Dapatkan data output dari output tertentu.

get_output_data(name)

Parameter

Nama Deskripsi
name
Diperlukan
str

Nama output.

Mengembalikan

Jenis Deskripsi
PortDataReference

PortDataReference yang mewakili data output langkah.

get_outputs

Dapatkan output langkah.

get_outputs()

Mengembalikan

Jenis Deskripsi
dict

Kamus StepRunOutputs dengan nama output sebagai kunci.

get_status

Ambil status terbaru eksekusi alur dari layanan.

Nilai umum yang dikembalikan termasuk "Berjalan", "Selesai", dan "Gagal".

get_status()

Mengembalikan

Jenis Deskripsi
str

Status terbaru sebagai string

Keterangan

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

  • Diantrekan - Pekerjaan diantrekan.

  • Berjalan - Pekerjaan mulai berjalan di target komputasi.

  • Gagal - Eksekusi gagal. Biasanya properti Kesalahan saat dijalankan akan memberikan detail alasannya.

  • Selesai - Eksekusi berhasil diselesaikan.

  • 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_stderr_log

Buang log stderr saat ini untuk langkah yang dijalankan.

get_stderr_log()

Mengembalikan

Jenis Deskripsi
str

String log.

get_stdout_log

Buang log stdout saat ini untuk langkah yang dijalankan.

get_stdout_log()

Mengembalikan

Jenis Deskripsi
str

String log.

wait_for_completion

Tunggu penyelesaian eksekusi langkah ini.

Mengembalikan status setelah menunggu.

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

Parameter

Nama Deskripsi
show_output
bool

show_output=True menunjukkan status eksekusi alur pada sys.stdout.

Nilai default: True
timeout_seconds
int

Jumlah detik untuk menunggu sebelum waktu habis.

Nilai default: 9223372036854775807
raise_on_error
bool

Menunjukkan apakah akan memunculkan kesalahan saat Eksekusi dalam status gagal

Nilai default: True

Mengembalikan

Jenis Deskripsi
str

Status akhir.

Atribut

pipeline_run_id

Mengembalikan id eksekusi alur yang sesuai dengan eksekusi langkah ini.

Mengembalikan

Jenis Deskripsi
str

Id PipelineRun.