Bagikan melalui

StepRun Kelas

  • Referensi

Sebuah eksekusi dari langkah dalam Pipeline.

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

Menginisialisasi StepRun.

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

experiment
Experiment
Diperlukan

Objek eksperimen dari langkah yang dijalankan.

step_run_id
str
Diperlukan

ID eksekusi dari langkah yang dijalankan.

pipeline_run_id
str
Diperlukan

ID eksekusi dari alur induk yang dijalankan.

node_id
str
Diperlukan

ID node dalam grafik yang mewakili langkah ini.

_service_endpoint
str
nilai default: None

Titik akhir untuk terhubung.

_is_reused
bool
nilai default: False

Menunjukkan apakah eksekusi ini adalah eksekusi sebelumnya yang digunakan kembali.

_current_node_id
str
nilai default: None

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

_reused_run_id
str
nilai default: None

ID eksekusi yang digunakan kembali.

_reused_node_id
str
nilai default: None

ID node yang digunakan kembali.

_reused_pipeline_run_id
str
nilai default: None

ID alur yang digunakan kembali.

experiment
Experiment
Diperlukan

Objek eksperimen dari langkah yang dijalankan.

step_run_id
str
Diperlukan

ID eksekusi dari langkah yang dijalankan.

pipeline_run_id
str
Diperlukan

ID eksekusi dari alur induk yang dijalankan.

node_id
str
Diperlukan

ID node dalam grafik yang mewakili langkah ini.

_service_endpoint
str
Diperlukan

Titik akhir untuk terhubung.

_is_reused
bool
Diperlukan

Menunjukkan apakah eksekusi ini adalah eksekusi sebelumnya yang digunakan kembali.

_current_node_id
str
Diperlukan

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

_reused_run_id
Diperlukan
_reused_node_id
str
Diperlukan
_reused_pipeline_run_id
str
Diperlukan

Keterangan

StepRun dibuat sebagai eksekusi turunan dari PipelineRun yang dikirimkan. Ambil semua StepRun 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 dari eksekusi. Gunakan get_outputs untuk mengambil kamus dari output langkah, atau gunakan get_output untuk mengambil objek StepRunOutput tunggal untuk output dengan nama yang disediakan. Anda juga dapat menggunakan get_output_data untuk mengambil PortDataReference 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 turunan untuk langkah yang dijalankan. Metode ini tidak diterapkan untuk StepRun.
complete

Lengkap untuk langkah yang dijalankan. Metode ini tidak diterapkan untuk StepRun.
fail

Gagal untuk langkah yang dijalankan. Metode ini tidak diterapkan untuk StepRun.
get_details_with_logs

Kembalikan detail status eksekusi dengan konten file log.
get_job_log

Cadangkan log pekerjaan saat ini untuk langkah yang dijalankan.
get_output

Dapatkan output node dengan nama yang diberikan.
get_output_data

Dapatkan data output dari output yang diberikan.
get_outputs

Dapatkan output langkah.
get_status

Ambil status terbaru eksekusi alur dari layanan.

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

Cadangkan log stderr saat ini untuk langkah yang dijalankan.
get_stdout_log

Cadangkan log stdout saat ini untuk langkah yang dijalankan.
wait_for_completion

Tunggu sampai langkah eksekusi ini selesai.

Mengembalikan status setelah menunggu.

child_run

Eksekusi turunan untuk langkah yang dijalankan. Metode ini tidak diterapkan untuk StepRun.

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

run_id opsional untuk turunan, jika tidak menggunakan default

outputs
str
nilai default: None

Direktori output opsional yang akan dilacak untuk turunan

Mengembalikan

Eksekusi turunan

Tipe hasil

Run

Pengecualian

NotImplementedError

complete

Lengkap untuk langkah yang dijalankan. Metode ini tidak diterapkan untuk StepRun.

complete()

Pengecualian

NotImplementedError

fail

Gagal untuk langkah yang dijalankan. Metode ini tidak diterapkan untuk StepRun.

fail()

Pengecualian

NotImplementedError

get_details_with_logs

Kembalikan detail status eksekusi dengan konten file log.

get_details_with_logs()

Mengembalikan

Mengembalikan status untuk eksekusi dengan konten file log

Tipe hasil

dict

Pengecualian

NotImplementedError

get_job_log

Cadangkan log pekerjaan saat ini untuk langkah yang dijalankan.

get_job_log()

Mengembalikan

String log.

Tipe hasil

str

Pengecualian

NotImplementedError

get_output

Dapatkan output node dengan nama yang diberikan.

get_output(name)

Parameter

name
str
Diperlukan

Nama output.

Mengembalikan

StepRunOutput dengan nama yang diberikan.

Tipe hasil

StepRunOutput

Pengecualian

NotImplementedError

get_output_data

Dapatkan data output dari output yang diberikan.

get_output_data(name)

Parameter

name
str
Diperlukan

Nama output.

Mengembalikan

PortDataReference mewakili data output langkah.

Tipe hasil

PortDataReference

Pengecualian

NotImplementedError

get_outputs

Dapatkan output langkah.

get_outputs()

Mengembalikan

Kamus StepRunOutputs dengan nama output sebagai kunci.

Tipe hasil

dict

Pengecualian

NotImplementedError

get_status

Ambil status terbaru eksekusi alur dari layanan.

Nilai umum yang dikembalikan termasuk "Sedang Berjalan", "Diselesaikan", dan "Gagal".

get_status()

Mengembalikan

Status terbaru sebagai string

Tipe hasil

str

Pengecualian

NotImplementedError

Keterangan

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

  • Dalam Antrean - Pekerjaan dalam antrean.

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

Cadangkan log stderr saat ini untuk langkah yang dijalankan.

get_stderr_log()

Mengembalikan

String log.

Tipe hasil

str

Pengecualian

NotImplementedError

get_stdout_log

Cadangkan log stdout saat ini untuk langkah yang dijalankan.

get_stdout_log()

Mengembalikan

String log.

Tipe hasil

str

Pengecualian

NotImplementedError

wait_for_completion

Tunggu sampai langkah eksekusi ini selesai.

Mengembalikan status setelah menunggu.

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

Parameter

show_output
bool
nilai default: True

show_output=True memperlihatkan status eksekusi alur di sys.stdout.

timeout_seconds
int
nilai default: 9223372036854775807

Jumlah detik yang ditunggu sebelum waktu habis.

raise_on_error
bool
nilai default: True

Menunjukkan apakah akan mengajukan kesalahan saat Eksekusi dalam status gagal

Mengembalikan

Status terakhir.

Tipe hasil

str

Pengecualian

NotImplementedError

Atribut

pipeline_run_id

Mengembalikan id eksekusi alur yang sesuai dengan langkah ini.

Mengembalikan

Id PipelineRun.

Tipe hasil

str