Run Kelas

  • Referensi

Menentukan kelas dasar untuk semua eksperimen Azure Machine Learning yang dijalankan.

Eksekusi mewakili satu percobaan sebuah eksperimen. Eksekusi digunakan untuk memantau eksekusi asinkron percobaan, metrik log dan menyimpan output percobaan, dan untuk menganalisis hasil serta mengakses artefak yang dihasilkan oleh percobaan.

Objek eksekusi dibuat saat Anda mengirimkan skrip untuk melatih model dalam berbagai skenario dalam Azure Machine Learning, termasuk eksekusi HyperDrive, eksekusi Alur, dan eksekusi AutoML. Objek Eksekusi juga dibuat saat Anda submit atau start_logging dengan kelas Experiment.

Untuk memulai eksperimen dan eksekusi, lihat

Menginisialisasi objek Jalankan.

Warisan
azureml._run_impl.run_base._RunBase
Run

Konstruktor

Run(experiment, run_id, outputs=None, **kwargs)

Parameter

Nama Deskripsi
experiment
Diperlukan
Experiment

Percobaan yang terkandung.
run_id
Diperlukan
str

ID untuk eksekusi.
outputs
str

Output yang harus dilacak.

nilai default: None
_run_dto
Diperlukan
<xref:azureml._restclient.models.run_dto.RunDto>

Penggunaan internal saja.
kwargs
Diperlukan
dict

Kamus parameter konfigurasi tambahan.
experiment
Diperlukan
Experiment

Percobaan yang terkandung.
run_id
Diperlukan
str

ID untuk eksekusi.
outputs
Diperlukan
str

Output yang harus dilacak.
kwargs
Diperlukan
dict

Kamus parameter konfigurasi tambahan.

Keterangan

Eksekusi mewakili satu percobaan sebuah eksperimen. Objek Eksekusi digunakan untuk memantau eksekusi asinkron percobaan, metrik log dan menyimpan output percobaan, dan untuk menganalisis hasil dan mengakses artefak yang dihasilkan oleh percobaan.

Run digunakan di dalam kode percobaan Anda untuk mencatat metrik dan artefak ke layanan Riwayat Eksekusi.

Run digunakan di luar percobaan Anda untuk memantau kemajuan dan untuk mengkueri dan menganalisis metrik dan hasil yang dihasilkan.

Fungsionalitas Eksekusi meliputi:

  • Menyimpan dan mengambil metrik dan data

  • Mengunggah dan mengunduh file

  • Menggunakan tag serta hierarki turunan untuk memudahkan pencarian eksekusi di masa lalu

  • Mendaftarkan file model yang tersimpan sebagai model yang dapat dioperasionalkan

  • Menyimpan, memodifikasi, dan mengambil properti eksekusi

  • Memuat eksekusi saat ini dari lingkungan jarak jauh dengan metode get_context

  • Snapshot file atau direktori secara efisien untuk reproduktivitas

Kelas ini bekerja dengan Experiment dalam skenario ini:

  • Membuat eksekusi dengan mengeksekusi kode menggunakan submit

  • Membuat eksekusi secara interaktif di buku catatan menggunakan start_logging

  • Pengelogan metrik dan mengunggah artefak dalam percobaan Anda, seperti saat menggunakan log

  • Membaca metrik dan mengunduh artefak saat menganalisis hasil percobaan, seperti saat menggunakan get_metrics

Untuk mengirimkan eksekusi, buat objek konfigurasi yang menjelaskan cara percobaan dijalankan. Berikut adalah contoh dari berbagai objek konfigurasi yang dapat Anda gunakan:

  • ScriptRunConfig

  • azureml.train.automl.automlconfig.AutoMLConfig

  • azureml.train.hyperdrive.HyperDriveConfig

  • azureml.pipeline.core.Pipeline

  • azureml.pipeline.core.PublishedPipeline

  • azureml.pipeline.core.PipelineEndpoint

Metrik berikut dapat ditambahkan ke eksekusi saat melatih eksperimen.

  • Skalar

    • Catat nilai numerik atau string ke eksekusi dengan nama yang diberikan menggunakan log. Pengelogan metrik ke eksekusi menyebabkan metrik tersebut disimpan ke dalam rekaman eksekusi dalam percobaan. Anda dapat mencatat metrik yang sama beberapa kali dalam sebuah eksekusi, hasilnya dianggap sebagai vektor metrik tersebut.

    • Contoh: run.log("accuracy", 0.95)

  • Daftar

    • Catat daftar nilai metrik ke eksekusi dengan nama yang diberikan menggunakan log_list.

    • Contoh: run.log_list("accuracies", [0.6, 0.7, 0.87])

  • Baris

    • Menggunakan log_row membuat metrik dengan beberapa kolom, seperti yang dijelaskan dalam kwargs. Setiap parameter bernama menghasilkan kolom dengan nilai yang ditentukan. log_row dapat dipanggil sekali untuk mencatat tupel arbitrer, atau beberapa kali dalam perulangan untuk menghasilkan tabel yang lengkap.

    • Contoh: run.log_row("Y over X", x=1, y=0.4)

  • Tabel

    • Catat objek kamus ke eksekusi dengan nama yang diberikan menggunakan log_table.

    • Contoh: run.log_table("Y over X", {"x":[1, 2, 3], "y":[0.6, 0.7, 0.89]})

  • Gambar

    • Log citra ke rekaman eksekusi. Gunakan log_image untuk mencatat file citra atau plot matplotlib ke eksekusi. Gambar ini akan terlihat dan dapat dibandingkan di rekaman eksekusi.

    • Contoh: run.log_image("ROC", path)

Metode

add_properties

Tambahkan properti yang bersifat abadi ke eksekusi.

Tag dan properti (kedua dict[str, str]) berbeda dalam kemampuan perubahannya. Properti tidak dapat diubah, sehingga properti membuat catatan permanen untuk tujuan audit. Tag dapat diubah. Untuk informasi selengkapnya tentang menggunakan tag dan properti, lihat Memberi tag dan menemukan eksekusi.
add_type_provider

Kait ekstensibilitas untuk jenis Eksekusi kustom yang disimpan dalam Riwayat Eksekusi.
cancel

Tandai eksekusi sebagai dibatalkan.

Jika ada pekerjaan yang terkait dengan kumpulan bidang cancel_uri, akhiri pekerjaan itu juga.
child_run

Buat eksekusi turunan.
clean

Hapus file yang berhubungan dengan eksekusi saat ini pada target yang ditentukan dalam konfigurasi eksekusi.
complete

Tunggu antrean tugas selesai diproses.

Eksekusi kemudian ditandai sebagai selesai. Ini biasanya digunakan dalam skenario notebook interaktif.
create_children

Buat satu atau banyak eksekusi turunan.
download_file

Unduh file terkait dari penyimpanan.
download_files

Unduh file dari prefiks penyimpanan tertentu (nama folder) atau seluruh kontainer jika awalan tidak ditentukan.
fail

Tandai eksekusi sebagai gagal.

Secara opsional set properti Kesalahan dari eksekusi dengan pesan, atau pengecualian diteruskan ke error_details.
flush

Tunggu antrean tugas selesai diproses.
get

Dapatkan eksekusi untuk ruang kerja ini beserta ID eksekusinya.
get_all_logs

Unduh semua log untuk eksekusi ke direktori.
get_children

Dapatkan semua turunan untuk eksekusi yang saat ini dipilih oleh filter yang ditentukan.
get_context

Kembalikan konteks layanan saat ini.

Gunakan metode ini untuk mengambil konteks layanan saat ini untuk pengelogan metrik dan mengunggah file. Jika allow_offline True (default), tindakan terhadap objek Eksekusi akan dicetak untuk menstandarkan.
get_detailed_status

Ambil status terbaru dari eksekusi. Jika status eksekusi adalah "Diantrekan", status eksekusi akan menampilkan detailnya.
get_details

Dapatkan definisi, informasi status, file log saat ini, dan detail lain dari eksekusi.
get_details_with_logs

Kembalikan status eksekusi termasuk konten file log.
get_environment

Dapatkan definisi lingkungan yang digunakan oleh eksekusi ini.
get_file_names

Daftarkan file yang disimpan dalam kaitannya dengan eksekusi.
get_metrics

Ambil metrik yang dicatat ke eksekusi.

Jika recursive True (False secara default), maka ambil metrik untuk eksekusi di substruktur pohon eksekusi yang diberikan.
get_properties

Ambil properti terbaru eksekusi dari layanan.
get_secret

Dapatkan nilai rahasia dari konteks eksekusi.

Dapatkan nilai rahasia untuk nama yang disediakan. Nama rahasia mereferensikan nilai yang disimpan di Azure Key Vault yang berkaitan dengan ruang kerja Anda. Untuk contoh menggunakan rahasia, lihat Menggunakan rahasia dalam pelatihan eksekusi.
get_secrets

Dapatkan nilai rahasia untuk daftar nama rahasia yang tertentu.

Dapatkan kamus rahasia yang ditemukan dan tidak ditemukan untuk daftar nama yang disediakan. Setiap nama rahasia mereferensikan nilai yang disimpan di Azure Key Vault yang berkaitan dengan ruang kerja Anda. Untuk contoh menggunakan rahasia, lihat Menggunakan rahasia dalam pelatihan eksekusi.
get_snapshot_id

Dapatkan ID snapshot terbaru.
get_status

Ambil status terbaru dari eksekusi.

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

TIDAK DIGUNAKAN LAGI. Gunakan get_context.

Dapatkan eksekusi yang dikirimkan untuk percobaan ini.
get_tags

Ambil kumpulan tag abadi terbaru pada eksekusi dari layanan.
list

Dapatkan daftar eksekusi dalam percobaan yang ditentukan oleh filter opsional.
list_by_compute

Dapatkan daftar eksekusi dalam komputasi yang ditentukan oleh filter opsional.
log

Catat nilai metrik ke eksekusi dengan nama yang ditentukan.
log_accuracy_table

Catat tabel akurasi ke toko artefak.

Metrik tabel akurasi adalah metrik multiguna non-skalar yang dapat digunakan untuk menghasilkan beberapa jenis diagram garis yang bervariasi secara berkelanjutan melebihi ruang probabilitas terprediksi. Contoh dari bagan ini adalah ROC, pengenalan-presisi, dan kurva pengangkatan.

Kalkulasi tabel akurasi mirip dengan kalkulasi kurva ROC. Kurva ROC menyimpan tingkat positif true dan tingkat positif false pada banyak ambang peluang yang berbeda. Tabel akurasi menyimpan jumlah mentah positif true, positif false, negatif true, dan negatif false pada banyak ambang peluang.

Ada dua metode yang digunakan untuk memilih ambang: "peluang" dan "persentil." Keduanya berbeda dalam cara mereka mengambil sampel dari ruang probabilitas terprediksi.

Ambang peluang adalah ambang berjarak seragam antara 0 dan 1. Jika NUM_POINTS adalah 5 ambang peluang akan menjadi [0.0, 0.25, 0.5, 0.75, 1.0].

Ambang persentil diberi jarak sesuai dengan distribusi probabilitas terprediksi. Setiap ambang sesuai dengan persentil data pada ambang peluang. Sebagai contoh, jika NUM_POINTS adalah 5, maka ambang pertama akan berada pada persentil ke-0, yang kedua pada persentil ke-25, yang ketiga pada ke-50, dan seterusnya.

Tabel peluang dan tabel persentil adalah daftar 3D tempat dimensi pertamanya mewakili label kelas, dimensi kedua mewakili sampel pada satu ambang (skala dengan NUM_POINTS), dan dimensi ketiga selalu memiliki 4 nilai: TP, FP, TN, FN, dan selalu dalam urutan tersebut.

Nilai kebingungan (TP, FP, TN, FN) dikomputasi dengan strategi one vs. rest. Lihat link berikut untuk detail selengkapnya: https://en.wikipedia.org/wiki/Multiclass_classification

N = # sampel dalam himpunan data validasi (200 dalam contoh) M = # ambang = # sampel yang diambil dari ruang peluang (5 dalam contoh) C = # kelas dalam himpunan data penuh (3 dalam contoh)

Beberapa invarian tabel akurasi:

  • TP + FP + TN + FN = N untuk semua ambang bagi semua kelas
  • TP + FN adalah sama pada semua ambang untuk kelas apa pun
  • TP + FN adalah sama pada semua ambang untuk kelas apa pun
  • Tabel peluang dan tabel persentil memiliki bentuk [C, M, 4]

Catatan: M dapat berupa nilai apa pun dan mengontrol resolusi bagan Ini bersifat independen dari himpunan data, ditentukan saat kalkulasi metrik, dan memperdagangkan ruang penyimpanan, waktu komputasi, dan resolusi.

Label kelas harus berupa untai (karakter), nilai kebingungan harus bilangan bulat, dan ambang harus float.
log_confusion_matrix

Catat matriks kebingungan ke toko artefak.

Ini mencatat wrapper di sekitar matriks kebingungan sklearn. Data metrik mengandung label kelas dan daftar 2D untuk matriks itu sendiri. Lihat link berikut untuk detail selengkapnya tentang cara metrik dikomputasikan: https://scikit-learn.org/stable/modules/generated/sklearn.metrics.confusion_matrix.html
log_image

Catat metrik gambar ke rekaman eksekusi.
log_list

Catat daftar nilai metrik ke eksekusi dengan nama yang diberikan.
log_predictions

Mencatat prediksi ke toko artefak.

Ini mencatat skor metrik yang dapat digunakan untuk membandingkan distribusi nilai target true dengan distribusi nilai terprediksi untuk tugas regresi.

Prediksi dikkumpulkan dan simpangan baku dikalkulasi untuk bilah kesalahan pada diagram garis.
log_residuals

Catat residu ke toko artefak.

Ini mencatat data yang diperlukan untuk menampilkan histogram dari residu untuk tugas regresi. Residu terprediksi - aktual.

Seharusnya terdapat satu lagi tepi daripada jumlah hitungan. Silakan lihat dokumentasi histogram numpy untuk contoh penggunaan hitungan dan tepi untuk mewakili histogram. https://docs.scipy.org/doc/numpy/reference/generated/numpy.histogram.html
log_row

Catat metrik baris ke eksekusi dengan nama yang diberikan.
log_table

Catat metrik tabel ke eksekusi dengan nama yang diberikan.
register_model

Daftarkan model untuk operasionalisasi.
remove_tags

Hapus daftar tag yang dapat diubah pada eksekusi ini.
restore_snapshot

Pulihkan snapshot sebagai file ZIP. Mengembalikan jalur ke ZIP.
set_tags

Menambahkan atau memodifikasi satu set tag ke eksekusi. Tag yang tidak diteruskan dalam kamus tidak akan tersentuh.

Anda juga dapat menambahkan tag string sederhana. Ketika tag ini muncul di kamus tag sebagai kunci, tag tersebut memiliki nilai Tidak Ada. Untuk informasi selengkapnya, lihat Memberi tag dan menemukan eksekusi.
start

Tandai eksekusi sebagai dimulai.

Ini biasanya digunakan dalam skenario lanjutan, ketika eksekusi telah dibuat oleh pelaku lain.
submit_child

Kirimkan percobaan dan kembalikan eksekusi turunan yang aktif.
tag

Tag eksekusi dengan kunci string, dan nilai string opsional.
take_snapshot

Menyimpan snapshot dari file input atau folder.
upload_file

Unggah file ke catatan eksekusi.
upload_files

Unggah file ke rekaman eksekusi.
upload_folder

Unggah folder yang ditentukan ke nama prefiks yang diberikan.
wait_for_completion

Tunggu sampai eksekusi ini selesai. Menampilkan objek status setelah menunggu.

add_properties

Tambahkan properti yang bersifat abadi ke eksekusi.

Tag dan properti (kedua dict[str, str]) berbeda dalam kemampuan perubahannya. Properti tidak dapat diubah, sehingga properti membuat catatan permanen untuk tujuan audit. Tag dapat diubah. Untuk informasi selengkapnya tentang menggunakan tag dan properti, lihat Memberi tag dan menemukan eksekusi.

add_properties(properties)

Parameter

Nama Deskripsi
properties
Diperlukan
dict

Properti tersembunyi yang disimpan di objek eksekusi.

add_type_provider

Kait ekstensibilitas untuk jenis Eksekusi kustom yang disimpan dalam Riwayat Eksekusi.

static add_type_provider(runtype, run_factory)

Parameter

Nama Deskripsi
runtype
Diperlukan
str

Nilai Run.type yang pabriknya akan digunakan. Contohnya termasuk 'hyperdrive' atau 'azureml.scriptrun', tetapi dapat diperluas dengan jenis kustom.
run_factory
Diperlukan
<xref:function>

Fungsi dengan tanda tangan (Percobaan, RunDto) -> Eksekusi untuk digunakan saat mendaftar eksekusi.

cancel

Tandai eksekusi sebagai dibatalkan.

Jika ada pekerjaan yang terkait dengan kumpulan bidang cancel_uri, akhiri pekerjaan itu juga.

cancel()

child_run

Buat eksekusi turunan.

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

Parameter

Nama Deskripsi
name
str

Nama opsional untuk turunan eksekusi, biasanya ditentukan untuk "bagian".

nilai default: None
run_id
str

ID eksekusi opsional untuk turunan, jika tidak maka akan dibuat secara otomatis. Biasanya parameter ini tidak disetel.

nilai default: None
outputs
str

Direktori output opsional untuk melacak turunan.

nilai default: None

Mengembalikan

Jenis Deskripsi
Run

Eksekusi turunan.

Keterangan

Ini digunakan untuk mengisolasi bagian dari eksekusi ke dalam subbagian. Ini dapat dilakukan untuk "bagian" yang dapat diidentifikasi dari eksekusi yang menarik untuk dipisahkan, atau untuk menangkap metrik independen di seluruh interasi subproses.

Jika direktori output disetel untuk eksekusi turunan, konten direktori tersebut akan diunggah ke rekaman eksekusi turunan saat turunan selesai.

clean

Hapus file yang berhubungan dengan eksekusi saat ini pada target yang ditentukan dalam konfigurasi eksekusi.

clean()

Mengembalikan

Jenis Deskripsi
list

Daftar file yang dihapus.

complete

Tunggu antrean tugas selesai diproses.

Eksekusi kemudian ditandai sebagai selesai. Ini biasanya digunakan dalam skenario notebook interaktif.

complete(_set_status=True)

Parameter

Nama Deskripsi
_set_status
bool

Menunjukkan apakah akan mengirim peristiwa status untuk pelacakan.

nilai default: True

create_children

Buat satu atau banyak eksekusi turunan.

create_children(count=None, tag_key=None, tag_values=None)

Parameter

Nama Deskripsi
count
int

Jumlah opsional turunan yang dibuat.

nilai default: None
tag_key
str

Kunci opsional untuk mengisi entri Tag di semua turunan yang dibuat.

nilai default: None
tag_Values
Diperlukan

Daftar opsional nilai yang akan memetakan ke Tag[tag_key] untuk daftar eksekusi yang dibuat.
tag_values
nilai default: None

Mengembalikan

Jenis Deskripsi
list[Run]

Daftar eksekusi turunan.

Keterangan

Baik parameter count ATAU parameter tag_key DAN tag_values harus ditentukan.

download_file

Unduh file terkait dari penyimpanan.

download_file(name, output_file_path=None, _validate_checksum=False)

Parameter

Nama Deskripsi
name
Diperlukan
str

Nama artefak untuk diunduh.
output_file_path
Diperlukan
str

Jalur lokal tempat artefak disimpan.

download_files

Unduh file dari prefiks penyimpanan tertentu (nama folder) atau seluruh kontainer jika awalan tidak ditentukan.

download_files(prefix=None, output_directory=None, output_paths=None, batch_size=100, append_prefix=True, timeout_seconds=None)

Parameter

Nama Deskripsi
prefix
Diperlukan
str

Prefiks filepath dalam kontainer tempat mengunduh semua artefak.
output_directory
Diperlukan
str

Direktori opsional yang digunakan semua jalur artefak sebagai prefiks.
output_paths
Diperlukan
[str]

Filepath opsional tempat menyimpan artefak yang diunduh. Harus unik dan cocok dengan panjang jalur.
batch_size
Diperlukan
int

Jumlah file untuk diunduh per batch. Jumlah default adalah 100 file.
append_prefix
Diperlukan
bool

Bendera opsional apakah akan menambahkan prefiks yang ditentukan dari jalur file output akhir. Jika False, maka prefiks dihapus dari jalur file output.
timeout_seconds
Diperlukan
int

Waktu habis untuk mengunduh file.

fail

Tandai eksekusi sebagai gagal.

Secara opsional set properti Kesalahan dari eksekusi dengan pesan, atau pengecualian diteruskan ke error_details.

fail(error_details=None, error_code=None, _set_status=True)

Parameter

Nama Deskripsi
error_details
str atau BaseException

Detail kesalahan opsional.

nilai default: None
error_code
str

Kode kesalahan opsional dari kesalahan untuk klasifikasi kesalahan.

nilai default: None
_set_status
bool

Menunjukkan apakah akan mengirim peristiwa status untuk pelacakan.

nilai default: True

flush

Tunggu antrean tugas selesai diproses.

flush(timeout_seconds=300)

Parameter

Nama Deskripsi
timeout_seconds
int

Berapa lama waktu tunggu (dalam hitungan detik) untuk memproses antrean tugas.

nilai default: 300

get

Dapatkan eksekusi untuk ruang kerja ini beserta ID eksekusinya.

static get(workspace, run_id)

Parameter

Nama Deskripsi
workspace
Diperlukan
Workspace

Ruang kerja yang terkandung.
run_id
Diperlukan
string

ID eksekusi.

Mengembalikan

Jenis Deskripsi
Run

Eksekusi yang dikirim.

get_all_logs

Unduh semua log untuk eksekusi ke direktori.

get_all_logs(destination=None)

Parameter

Nama Deskripsi
destination
str

Jalur tujuan untuk menyimpan log. Jika tidak ditentukan, direktori bernama ID eksekusi dibuat di direktori proyek.

nilai default: None

Mengembalikan

Jenis Deskripsi
list

Daftar nama log yang diunduh.

get_children

Dapatkan semua turunan untuk eksekusi yang saat ini dipilih oleh filter yang ditentukan.

get_children(recursive=False, tags=None, properties=None, type=None, status=None, _rehydrate_runs=True)

Parameter

Nama Deskripsi
recursive
bool

Menunjukkan apakah akan berulang melalui semua keturunan.

nilai default: False
tags
str atau dict

Jika ditentukan, mengembalikan eksekusi yang cocok dengan "tag" atau {"tag": "value"} yang ditentukan.

nilai default: None
properties
str atau dict

Jika ditentukan, mengembalikan eksekusi yang cocok dengan "property" atau {"property": "value"} yang ditentukan.

nilai default: None
type
str

Jika ditentukan, mengembalikan eksekusi yang sesuai dengan jenis ini.

nilai default: None
status
str

Jika ditentukan, mengembalikan eksekusi dengan status "status" yang ditentukan.

nilai default: None
_rehydrate_runs
bool

Menunjukkan apakah mengeksekusi secara instans dari jenis asli, atau Eksekusi dasar.

nilai default: True

Mengembalikan

Jenis Deskripsi
list

Daftar objek Run.

get_context

Kembalikan konteks layanan saat ini.

Gunakan metode ini untuk mengambil konteks layanan saat ini untuk pengelogan metrik dan mengunggah file. Jika allow_offline True (default), tindakan terhadap objek Eksekusi akan dicetak untuk menstandarkan.

get_context(allow_offline=True, used_for_context_manager=False, **kwargs)

Parameter

Nama Deskripsi
cls
Diperlukan

Menunjukkan metode kelas.
allow_offline
bool

Mengizinkan konteks layanan kembali ke mode offline sehingga skrip pelatihan dapat diuji secara lokal tanpa mengirimkan pekerjaan dengan SDK. True secara default.

nilai default: True
kwargs
Diperlukan
dict

Kamus parameter tambahan.
used_for_context_manager
nilai default: False

Mengembalikan

Jenis Deskripsi
Run

Eksekusi yang dikirim.

Keterangan

Fungsi ini secara umum digunakan untuk mengambil objek Eksekusi yang diautentikasi di dalam skrip yang akan dikirimkan untuk dieksekusi melalui experiment.submit(). Objek eksekusi ini adalah konteks yang diautentikasi untuk berkomunikasi dengan layanan Azure Machine Learning dan kontainer konseptual yang di dalamnya berisi metrik, file (artefak), dan model.


   run = Run.get_context() # allow_offline=True by default, so can be run locally as well
   ...
   run.log("Accuracy", 0.98)
   run.log_row("Performance", epoch=e, error=err)

get_detailed_status

Ambil status terbaru dari eksekusi. Jika status eksekusi adalah "Diantrekan", status eksekusi akan menampilkan detailnya.

get_detailed_status()

Mengembalikan

Jenis Deskripsi
dict[str, str]

Status dan detail terbaru

Keterangan

  • status: Status eksekusi saat ini. Nilai yang sama dengan yang dikembalikan dari get_status().

  • detail: Informasi detail untuk status saat ini.


   run = experiment.submit(config)
   details = run.get_detailed_status()
   # details = {
   #     'status': 'Queued',
   #     'details': 'Run requested 1 node(s). Run is in pending status.',
   # }

get_details

Dapatkan definisi, informasi status, file log saat ini, dan detail lain dari eksekusi.

get_details()

Mengembalikan

Jenis Deskripsi
dict[str, str]

Menampilkan detail untuk eksekusi

Keterangan

Kamus yang dikembalikan berisi pasangan kunci-nilai berikut:

  • runId: ID eksekusi ini.

  • target

  • status: Status eksekusi saat ini. Nilai yang sama dengan yang dikembalikan dari get_status().

  • startTimeUtc: Waktu UTC saat eksekusi ini dimulai, di ISO8601.

  • endTimeUtc: Waktu UTC saat eksekusi ini selesai (baik Selesai atau Gagal), di ISO8601.

    Kunci ini tidak ada jika eksekusi masih berlangsung.

  • properties: Pasangan kunci-nilai abadi yang berkaitan dengan eksekusi. Properti default termasuk ID snapshot eksekusi dan informasi tentang repositori git tempat eksekusi dibuat (jika ada). Properti tambahan dapat ditambahkan ke eksekusi menggunakan add_properties.

  • inputDatasets: Himpunan data input yang berhubungan dengan eksekusi.

  • outputDatasets: Himpunan data output yang berhubungan dengan eksekusi.

  • logFiles

  • submittedBy


   run = experiment.start_logging()

   details = run.get_details()
   # details = {
   #     'runId': '5c24aa28-6e4a-4572-96a0-fb522d26fe2d',
   #     'target': 'sdk',
   #     'status': 'Running',
   #     'startTimeUtc': '2019-01-01T13:08:01.713777Z',
   #     'endTimeUtc': '2019-01-01T17:15:65.986253Z',
   #     'properties': {
   #         'azureml.git.repository_uri': 'https://example.com/my/git/repo',
   #         'azureml.git.branch': 'master',
   #         'azureml.git.commit': '7dc972657c2168927a02c3bc2b161e0f370365d7',
   #         'azureml.git.dirty': 'True',
   #         'mlflow.source.git.repoURL': 'https://example.com/my/git/repo',
   #         'mlflow.source.git.branch': 'master',
   #         'mlflow.source.git.commit': '7dc972657c2168927a02c3bc2b161e0f370365d7',
   #         'ContentSnapshotId': 'b4689489-ce2f-4db5-b6d7-6ad11e77079c'
   #     },
   #     'inputDatasets': [{
   #         'dataset': {'id': 'cdebf245-701d-4a68-8055-41f9cf44f298'},
   #         'consumptionDetails': {
   #             'type': 'RunInput',
   #             'inputName': 'training-data',
   #             'mechanism': 'Mount',
   #             'pathOnCompute': '/mnt/datasets/train'
   #         }
   #     }],
   #     'outputDatasets': [{
   #         'dataset': {'id': 'd04e8a19-1caa-4b1f-b318-4cbff9af9615'},
   #         'outputType': 'RunOutput',
   #         'outputDetails': {
   #             'outputName': 'training-result'
   #         }
   #     }],
   #     'runDefinition': {},
   #     'logFiles': {},
   #     'submittedBy': 'Alan Turing'
   # }

get_details_with_logs

Kembalikan status eksekusi termasuk konten file log.

get_details_with_logs()

Mengembalikan

Jenis Deskripsi
dict

Mengembalikan status untuk eksekusi dengan konten file log.

get_environment

Dapatkan definisi lingkungan yang digunakan oleh eksekusi ini.

get_environment()

Mengembalikan

Jenis Deskripsi
Environment

Kembalikan objek lingkungan.

get_file_names

Daftarkan file yang disimpan dalam kaitannya dengan eksekusi.

get_file_names()

Mengembalikan

Jenis Deskripsi
list[str]

Daftar jalur untuk artefak yang ada

get_metrics

Ambil metrik yang dicatat ke eksekusi.

Jika recursive True (False secara default), maka ambil metrik untuk eksekusi di substruktur pohon eksekusi yang diberikan.

get_metrics(name=None, recursive=False, run_type=None, populate=False)

Parameter

Nama Deskripsi
name
str

Nama metrik.

nilai default: None
recursive
bool

Menunjukkan apakah akan berulang melalui semua keturunan.

nilai default: False
run_type
str
nilai default: None
populate
bool

Menunjukkan apakah akan mengambil konten data eksternal yang ditautkan ke metrik.

nilai default: False

Mengembalikan

Jenis Deskripsi
dict

Kamus yang berisi metrik pengguna.

Keterangan


   run = experiment.start_logging() # run id: 123
   run.log("A", 1)
   with run.child_run() as child: # run id: 456
       child.log("A", 2)

   metrics = run.get_metrics()
   # metrics = { 'A': 1 }

   metrics = run.get_metrics(recursive=True)
   # metrics = { '123': { 'A': 1 }, '456': { 'A': 2 } } note key is runId

get_properties

Ambil properti terbaru eksekusi dari layanan.

get_properties()

Mengembalikan

Jenis Deskripsi
dict

Properti eksekusi.

Keterangan

Properti adalah informasi abadi yang dihasilkan sistem, seperti durasi, tanggal eksekusi, pengguna, dan properti kustom yang ditambahkan dengan metode add_properties. Untuk informasi selengkapnya, lihat Memberi tag dan menemukan eksekusi.

Saat mengirimkan pekerjaan ke Azure Machine Learning, jika file sumber disimpan di repositori git lokal, informasi tentang repositori akan dilacak sebagai properti. Properti git ini ditambahkan saat membuat eksekusi atau memanggil Experiment.submit. Untuk informasi selengkapnya tentang properti git lihat Integrasi git untuk Azure Machine Learning.

get_secret

Dapatkan nilai rahasia dari konteks eksekusi.

Dapatkan nilai rahasia untuk nama yang disediakan. Nama rahasia mereferensikan nilai yang disimpan di Azure Key Vault yang berkaitan dengan ruang kerja Anda. Untuk contoh menggunakan rahasia, lihat Menggunakan rahasia dalam pelatihan eksekusi.

get_secret(name)

Parameter

Nama Deskripsi
name
Diperlukan
str

Nama rahasia untuk mengembalikan rahasia.

Mengembalikan

Jenis Deskripsi
str

Nilai rahasia.

get_secrets

Dapatkan nilai rahasia untuk daftar nama rahasia yang tertentu.

Dapatkan kamus rahasia yang ditemukan dan tidak ditemukan untuk daftar nama yang disediakan. Setiap nama rahasia mereferensikan nilai yang disimpan di Azure Key Vault yang berkaitan dengan ruang kerja Anda. Untuk contoh menggunakan rahasia, lihat Menggunakan rahasia dalam pelatihan eksekusi.

get_secrets(secrets)

Parameter

Nama Deskripsi
secrets
Diperlukan
list[str]

Daftar nama rahasia untuk mengembalikan nilai rahasia.

Mengembalikan

Jenis Deskripsi
dict[str: str]

Mengembalikan kamus rahasia yang ditemukan dan tidak ditemukan.

get_snapshot_id

Dapatkan ID snapshot terbaru.

get_snapshot_id()

Mengembalikan

Jenis Deskripsi
str

ID snapshot terbaru.

get_status

Ambil status terbaru dari eksekusi.

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

get_status()

Mengembalikan

Jenis Deskripsi
str

Status terbaru.

Keterangan

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

  • Memulai - Eksekusi sudah mulai diproses di cloud. Penelepon memiliki ID eksekusi pada titik ini.

  • Memprovisikan - Dikembalikan saat komputasi sesuai permintaan sedang dibuat untuk pengiriman pekerjaan tertentu.

  • Mempersiapkan - Lingkungan eksekusi sedang dipersiapkan:

    • build citra docker

    • penyiapan lingkungan conda

  • Mengantre - Pekerjaan diantrekan di target komputasi. Misalnya, di BatchAI pekerjaan dalam kondisi mengantre

    sambil menunggu semua node yang diminta siap.

  • Berjalan - Pekerjaan mulai berjalan di target komputasi.

  • Finalisasi - Kode pengguna telah selesai, dan eksekusi sedang dalam tahap pascapemrosesan.

  • CancelRequested - Pembatalan pekerjaan telah diminta.

  • Selesai - Eksekusi berhasil diselesaikan. Ini termasuk kode pengguna dan eksekusi

    tahapan pascapemrosesan.

  • Gagal - Eksekusi gagal. Biasanya properti Kesalahan eksekusi akan menampilkan detail alasannya.

  • Dibatalkan - Mengikuti permintaan pembatalan dan menunjukkan bahwa eksekusi berhasil dibatalkan.

  • NotResponding - Untuk eksekusi yang mengaktifkan Heartbeats, tidak ada heartbeat yang baru dikirim.


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

get_submitted_run

TIDAK DIGUNAKAN LAGI. Gunakan get_context.

Dapatkan eksekusi yang dikirimkan untuk percobaan ini.

get_submitted_run(**kwargs)

Mengembalikan

Jenis Deskripsi
Run

Eksekusi yang dikirim.

get_tags

Ambil kumpulan tag abadi terbaru pada eksekusi dari layanan.

get_tags()

Mengembalikan

Jenis Deskripsi
dict

Tag yang disimpan pada objek eksekusi.

list

Dapatkan daftar eksekusi dalam percobaan yang ditentukan oleh filter opsional.

static list(experiment, type=None, tags=None, properties=None, status=None, include_children=False, _rehydrate_runs=True)

Parameter

Nama Deskripsi
experiment
Diperlukan
Experiment

Percobaan yang terkandung.
type
str

Jika ditentukan, mengembalikan eksekusi yang cocok dengan jenis yang ditentukan.

nilai default: None
tags
str atau dict

Jika ditentukan, mengembalikan eksekusi yang cocok dengan "tag" atau {"tag": "value"} yang ditentukan.

nilai default: None
properties
str atau dict

Jika ditentukan, mengembalikan eksekusi yang cocok dengan "property" atau {"property": "value"} yang ditentukan.

nilai default: None
status
str

Jika ditentukan, mengembalikan eksekusi dengan status "status" yang ditentukan.

nilai default: None
include_children
bool

Jika diatur ke true, ambil semua eksekusi, tidak hanya tingkat atas saja.

nilai default: False
_rehydrate_runs
bool

Jika diatur ke True (secara default), akan menggunakan penyedia terdaftar untuk membuat kembali objek untuk jenis itu, bukan Eksekusi dasar.

nilai default: True

Mengembalikan

Jenis Deskripsi
list[Run]

Daftar eksekusi.

Keterangan

Contoh kode berikut menunjukkan beberapa penggunaan metode list.


   favorite_completed_runs = Run.list(experiment, status='Completed', tags='favorite')

   all_distinct_runs = Run.list(experiment)
   and_their_children = Run.list(experiment, include_children=True)

   only_script_runs = Run.list(experiment, type=ScriptRun.RUN_TYPE)

list_by_compute

Dapatkan daftar eksekusi dalam komputasi yang ditentukan oleh filter opsional.

static list_by_compute(compute, type=None, tags=None, properties=None, status=None)

Parameter

Nama Deskripsi
compute
Diperlukan
ComputeTarget

Komputasi yang terkandung.
type
str

Jika ditentukan, mengembalikan eksekusi yang cocok dengan jenis yang ditentukan.

nilai default: None
tags
str atau dict

Jika ditentukan, mengembalikan eksekusi yang cocok dengan "tag" atau {"tag": "value"} yang ditentukan.

nilai default: None
properties
str atau dict

Jika ditentukan, mengembalikan eksekusi yang cocok dengan "property" atau {"property": "value"} yang ditentukan.

nilai default: None
status
str

Jika ditentukan, mengembalikan eksekusi dengan status "status" yang ditentukan. Hanya nilai yang diizinkan yang "Berjalan" dan "Antrean".

nilai default: None

Mengembalikan

Jenis Deskripsi
<xref:builtin.generator>

generator ~_restclient.models.RunDto

log

Catat nilai metrik ke eksekusi dengan nama yang ditentukan.

log(name, value, description='', step=None)

Parameter

Nama Deskripsi
name
Diperlukan
str

Nama metrik.
value
Diperlukan

Nilai yang akan dikirimkan ke layanan.
description
Diperlukan
str

Deskripsi metrik opsional.
step
int

Sumbu opsional untuk menentukan urutan nilai dalam metrik.

nilai default: None

Keterangan

Pencatatan log metrik ke eksekusi menyebabkan metrik tersebut disimpan dalam catatan eksekusi dalam eksperimen. Anda dapat mencatat metrik yang sama beberapa kali dalam eksekusi, hasilnya dianggap sebagai vektor metrik itu. Jika langkah ditentukan untuk metrik, langkah tersebut harus ditentukan untuk semua nilai.

log_accuracy_table

Catat tabel akurasi ke toko artefak.

Metrik tabel akurasi adalah metrik multiguna non-skalar yang dapat digunakan untuk menghasilkan beberapa jenis diagram garis yang bervariasi secara berkelanjutan melebihi ruang probabilitas terprediksi. Contoh dari bagan ini adalah ROC, pengenalan-presisi, dan kurva pengangkatan.

Kalkulasi tabel akurasi mirip dengan kalkulasi kurva ROC. Kurva ROC menyimpan tingkat positif true dan tingkat positif false pada banyak ambang peluang yang berbeda. Tabel akurasi menyimpan jumlah mentah positif true, positif false, negatif true, dan negatif false pada banyak ambang peluang.

Ada dua metode yang digunakan untuk memilih ambang: "peluang" dan "persentil." Keduanya berbeda dalam cara mereka mengambil sampel dari ruang probabilitas terprediksi.

Ambang peluang adalah ambang berjarak seragam antara 0 dan 1. Jika NUM_POINTS adalah 5 ambang peluang akan menjadi [0.0, 0.25, 0.5, 0.75, 1.0].

Ambang persentil diberi jarak sesuai dengan distribusi probabilitas terprediksi. Setiap ambang sesuai dengan persentil data pada ambang peluang. Sebagai contoh, jika NUM_POINTS adalah 5, maka ambang pertama akan berada pada persentil ke-0, yang kedua pada persentil ke-25, yang ketiga pada ke-50, dan seterusnya.

Tabel peluang dan tabel persentil adalah daftar 3D tempat dimensi pertamanya mewakili label kelas, dimensi kedua mewakili sampel pada satu ambang (skala dengan NUM_POINTS), dan dimensi ketiga selalu memiliki 4 nilai: TP, FP, TN, FN, dan selalu dalam urutan tersebut.

Nilai kebingungan (TP, FP, TN, FN) dikomputasi dengan strategi one vs. rest. Lihat link berikut untuk detail selengkapnya: https://en.wikipedia.org/wiki/Multiclass_classification

N = # sampel dalam himpunan data validasi (200 dalam contoh) M = # ambang = # sampel yang diambil dari ruang peluang (5 dalam contoh) C = # kelas dalam himpunan data penuh (3 dalam contoh)

Beberapa invarian tabel akurasi:

  • TP + FP + TN + FN = N untuk semua ambang bagi semua kelas
  • TP + FN adalah sama pada semua ambang untuk kelas apa pun
  • TP + FN adalah sama pada semua ambang untuk kelas apa pun
  • Tabel peluang dan tabel persentil memiliki bentuk [C, M, 4]

Catatan: M dapat berupa nilai apa pun dan mengontrol resolusi bagan Ini bersifat independen dari himpunan data, ditentukan saat kalkulasi metrik, dan memperdagangkan ruang penyimpanan, waktu komputasi, dan resolusi.

Label kelas harus berupa untai (karakter), nilai kebingungan harus bilangan bulat, dan ambang harus float.

log_accuracy_table(name, value, description='')

Parameter

Nama Deskripsi
name
Diperlukan
str

Nama tabel akurasi.
value
Diperlukan
str atau dict

JSON berisi nama, versi, dan properti data.
description
Diperlukan
str

Deskripsi metrik opsional.

Keterangan

Contoh nilai JSON yang valid:


   {
       "schema_type": "accuracy_table",
       "schema_version": "1.0.1",
       "data": {
           "probability_tables": [
               [
                   [82, 118, 0, 0],
                   [75, 31, 87, 7],
                   [66, 9, 109, 16],
                   [46, 2, 116, 36],
                   [0, 0, 118, 82]
               ],
               [
                   [60, 140, 0, 0],
                   [56, 20, 120, 4],
                   [47, 4, 136, 13],
                   [28, 0, 140, 32],
                   [0, 0, 140, 60]
               ],
               [
                   [58, 142, 0, 0],
                   [53, 29, 113, 5],
                   [40, 10, 132, 18],
                   [24, 1, 141, 34],
                   [0, 0, 142, 58]
               ]
           ],
           "percentile_tables": [
               [
                   [82, 118, 0, 0],
                   [82, 67, 51, 0],
                   [75, 26, 92, 7],
                   [48, 3, 115, 34],
                   [3, 0, 118, 79]
               ],
               [
                   [60, 140, 0, 0],
                   [60, 89, 51, 0],
                   [60, 41, 99, 0],
                   [46, 5, 135, 14],
                   [3, 0, 140, 57]
               ],
               [
                   [58, 142, 0, 0],
                   [56, 93, 49, 2],
                   [54, 47, 95, 4],
                   [41, 10, 132, 17],
                   [3, 0, 142, 55]
               ]
           ],
           "probability_thresholds": [0.0, 0.25, 0.5, 0.75, 1.0],
           "percentile_thresholds": [0.0, 0.01, 0.24, 0.98, 1.0],
           "class_labels": ["0", "1", "2"]
       }
   }

log_confusion_matrix

Catat matriks kebingungan ke toko artefak.

Ini mencatat wrapper di sekitar matriks kebingungan sklearn. Data metrik mengandung label kelas dan daftar 2D untuk matriks itu sendiri. Lihat link berikut untuk detail selengkapnya tentang cara metrik dikomputasikan: https://scikit-learn.org/stable/modules/generated/sklearn.metrics.confusion_matrix.html

log_confusion_matrix(name, value, description='')

Parameter

Nama Deskripsi
name
Diperlukan
str

Nama matriks kebingungan.
value
Diperlukan
str atau dict

JSON berisi nama, versi, dan properti data.
description
Diperlukan
str

Deskripsi metrik opsional.

Keterangan

Contoh nilai JSON yang valid:


   {
       "schema_type": "confusion_matrix",
       "schema_version": "1.0.0",
       "data": {
           "class_labels": ["0", "1", "2", "3"],
           "matrix": [
               [3, 0, 1, 0],
               [0, 1, 0, 1],
               [0, 0, 1, 0],
               [0, 0, 0, 1]
           ]
       }
   }

log_image

Catat metrik gambar ke rekaman eksekusi.

log_image(name, path=None, plot=None, description='')

Parameter

Nama Deskripsi
name
Diperlukan
str

Nama metrik.
path
Diperlukan
str

Jalur atau aliran citra.
plot
Diperlukan
<xref:matplotlib.pyplot>

Plot untuk mencatat sebagai citra.
description
Diperlukan
str

Deskripsi metrik opsional.

Keterangan

Gunakan metode ini untuk mencatat file gambar atau plot matplotlib ke eksekusi. Gambar ini akan terlihat dan dapat dibandingkan di rekaman eksekusi.

log_list

Catat daftar nilai metrik ke eksekusi dengan nama yang diberikan.

log_list(name, value, description='')

Parameter

Nama Deskripsi
name
Diperlukan
str

Nama metrik.
value
Diperlukan
list

Nilai metrik.
description
Diperlukan
str

Deskripsi metrik opsional.

log_predictions

Mencatat prediksi ke toko artefak.

Ini mencatat skor metrik yang dapat digunakan untuk membandingkan distribusi nilai target true dengan distribusi nilai terprediksi untuk tugas regresi.

Prediksi dikkumpulkan dan simpangan baku dikalkulasi untuk bilah kesalahan pada diagram garis.

log_predictions(name, value, description='')

Parameter

Nama Deskripsi
name
Diperlukan
str

Nama prediksi.
value
Diperlukan
str atau dict

JSON berisi nama, versi, dan properti data.
description
Diperlukan
str

Deskripsi metrik opsional.

Keterangan

Contoh nilai JSON yang valid:


   {
       "schema_type": "predictions",
       "schema_version": "1.0.0",
       "data": {
           "bin_averages": [0.25, 0.75],
           "bin_errors": [0.013, 0.042],
           "bin_counts": [56, 34],
           "bin_edges": [0.0, 0.5, 1.0]
       }
   }

log_residuals

Catat residu ke toko artefak.

Ini mencatat data yang diperlukan untuk menampilkan histogram dari residu untuk tugas regresi. Residu terprediksi - aktual.

Seharusnya terdapat satu lagi tepi daripada jumlah hitungan. Silakan lihat dokumentasi histogram numpy untuk contoh penggunaan hitungan dan tepi untuk mewakili histogram. https://docs.scipy.org/doc/numpy/reference/generated/numpy.histogram.html

log_residuals(name, value, description='')

Parameter

Nama Deskripsi
name
Diperlukan
str

Nama residu.
value
Diperlukan
str atau dict

JSON berisi nama, versi, dan properti data.
description
Diperlukan
str

Deskripsi metrik opsional.

Keterangan

Contoh nilai JSON yang valid:


   {
       "schema_type": "residuals",
       "schema_version": "1.0.0",
       "data": {
           "bin_edges": [50, 100, 200, 300, 350],
           "bin_counts": [0.88, 20, 30, 50.99]
       }
   }

log_row

Catat metrik baris ke eksekusi dengan nama yang diberikan.

log_row(name, description=None, **kwargs)

Parameter

Nama Deskripsi
name
Diperlukan
str

Nama metrik.
description
str

Deskripsi metrik opsional.

nilai default: None
kwargs
Diperlukan
dict

Kamus parameter tambahan. Dalam kasus ini, kolom metrik.

Keterangan

Menggunakan log_row membuat metrik tabel dengan kolom seperti yang dijelaskan dalam kwargs. Setiap parameter bernama menghasilkan kolom dengan nilai yang ditentukan. log_row dapat dipanggil sekali untuk mencatat tupel arbitrer, atau beberapa kali dalam perulangan untuk menghasilkan tabel lengkap.


   citrus = ['orange', 'lemon', 'lime']
   sizes = [ 10, 7, 3]
   for index in range(len(citrus)):
       run.log_row("citrus", fruit = citrus[index], size=sizes[index])

log_table

Catat metrik tabel ke eksekusi dengan nama yang diberikan.

log_table(name, value, description='')

Parameter

Nama Deskripsi
name
Diperlukan
str

Nama metrik.
value
Diperlukan
dict

Nilai tabel metrik, sebuah kamus di mana kunci adalah kolom yang akan dikirim ke layanan.
description
Diperlukan
str

Deskripsi metrik opsional.

register_model

Daftarkan model untuk operasionalisasi.

register_model(model_name, model_path=None, tags=None, properties=None, model_framework=None, model_framework_version=None, description=None, datasets=None, sample_input_dataset=None, sample_output_dataset=None, resource_configuration=None, **kwargs)

Parameter

Nama Deskripsi
model_name
Diperlukan
str

Nama model.
model_path
str

Jalur cloud relatif ke model, sebagai contoh, "output/namamodel". Saat tidak ditentukan (Tidak Ada), model_name digunakan sebagai jalur.

nilai default: None
tags
dict[str, str]

Kamus dari tag nilai kunci untuk ditetapkan ke model.

nilai default: None
properties
dict[str, str]

Kamus dari properti nilai kunci untuk ditetapkan ke model. Properti ini tidak dapat diubah setelah pembuatan model, namun pasangan nilai kunci baru dapat ditambahkan.

nilai default: None
model_framework
str

Kerangka model untuk mendaftar. Kerangka kerja yang didukung saat ini: TensorFlow, ScikitLearn, Onnx, Custom, Multi

nilai default: None
model_framework_version
str

Versi kerangka kerja dari model yang terdaftar.

nilai default: None
description
str

Deskripsi opsional model.

nilai default: None
datasets
list[(str, AbstractDataset)]

Daftar tupel di mana elemen pertama menggambarkan hubungan himpunan data-model dan elemen kedua adalah himpunan data.

nilai default: None
sample_input_dataset
AbstractDataset

Opsional. Sampel himpunan data input untuk model yang terdaftar

nilai default: None
sample_output_dataset
AbstractDataset

Opsional. Sampel himpunan data output untuk model yang terdaftar

nilai default: None
resource_configuration
ResourceConfiguration

Opsional. Konfigurasi sumber daya untuk menjalankan model yang terdaftar

nilai default: None
kwargs
Diperlukan
dict

Parameter opsional.

Mengembalikan

Jenis Deskripsi
Model

Model yang terdaftar.

Keterangan


   model = best_run.register_model(model_name = 'best_model', model_path = 'outputs/model.pkl')

remove_tags

Hapus daftar tag yang dapat diubah pada eksekusi ini.

remove_tags(tags)

Parameter

Nama Deskripsi
tags
Diperlukan
list

Daftar tag untuk dihapus.

Mengembalikan

Jenis Deskripsi

Tag yang disimpan pada objek eksekusi

restore_snapshot

Pulihkan snapshot sebagai file ZIP. Mengembalikan jalur ke ZIP.

restore_snapshot(snapshot_id=None, path=None)

Parameter

Nama Deskripsi
snapshot_id
str

ID snapshot untuk dipulihkan. Yang terbaru digunakan, jika tidak ditentukan.

nilai default: None
path
str

Jalur tempat ZIP yang diunduh disimpan.

nilai default: None

Mengembalikan

Jenis Deskripsi
str

Jalur.

set_tags

Menambahkan atau memodifikasi satu set tag ke eksekusi. Tag yang tidak diteruskan dalam kamus tidak akan tersentuh.

Anda juga dapat menambahkan tag string sederhana. Ketika tag ini muncul di kamus tag sebagai kunci, tag tersebut memiliki nilai Tidak Ada. Untuk informasi selengkapnya, lihat Memberi tag dan menemukan eksekusi.

set_tags(tags)

Parameter

Nama Deskripsi
tags
Diperlukan
dict[str] atau str

Tag yang disimpan dalam objek eksekusi.

start

Tandai eksekusi sebagai dimulai.

Ini biasanya digunakan dalam skenario lanjutan, ketika eksekusi telah dibuat oleh pelaku lain.

start()

submit_child

Kirimkan percobaan dan kembalikan eksekusi turunan yang aktif.

submit_child(config, tags=None, **kwargs)

Parameter

Nama Deskripsi
config
Diperlukan
object

Konfigurasi yang akan dikirimkan.
tags
dict

Tag yang akan ditambahkan ke eksekusi yang dikirimkan, msl., {"tag": "nilai"}.

nilai default: None
kwargs
Diperlukan
dict

Parameter tambahan yang digunakan dalam fungsi kirim untuk konfigurasi.

Mengembalikan

Jenis Deskripsi
Run

Objek eksekusi.

Keterangan

Kirim adalah panggilan asinkron ke platform Azure Machine Learning untuk mengeksekusi uji coba pada perangkat keras lokal, atau jarak jauh. Bergantung pada konfigurasi, kirim akan secara otomatis menyiapkan lingkungan eksekusi Anda, mengeksekusi kode Anda, dan menangkap kode sumber Anda dan hasil ke dalam riwayat eksekusi percobaan.

Untuk mengirimkan percobaan, Anda harus terlebih dahulu membuat objek konfigurasi yang menjelaskan bagaimana percobaan akan dijalankan. Konfigurasi tergantung pada jenis percobaan yang diperlukan.

Contoh cara mengirimkan percobaan turunan dari mesin lokal Anda menggunakan ScriptRunConfig adalah sebagai berikut:


   from azureml.core import ScriptRunConfig

   # run a trial from the train.py code in your current directory
   config = ScriptRunConfig(source_directory='.', script='train.py',
       run_config=RunConfiguration())
   run = parent_run.submit_child(config)

   # get the url to view the progress of the experiment and then wait
   # until the trial is complete
   print(run.get_portal_url())
   run.wait_for_completion()

Untuk detail tentang cara mengonfigurasi eksekusi, lihat submit.

tag

Tag eksekusi dengan kunci string, dan nilai string opsional.

tag(key, value=None)

Parameter

Nama Deskripsi
key
Diperlukan
str

Tombol tag
value
str

Nilai opsional untuk tag

nilai default: None

Keterangan

Tag dan properti dalam eksekusi, keduanya merupakan kamus string string ->. Perbedaan di antara mereka adalah kemampuan perubahannya: Tag dapat diatur, diperbarui, dan dihapus sementara Properti hanya dapat ditambahkan. Hal ini membuat Properti lebih sesuai untuk pemicu perilaku terkait sistem/alur kerja, sementara Tag umumnya menghadap-pengguna dan bermakna bagi konsumen percobaan.


   run = experiment.start_logging()
   run.tag('DeploymentCandidate')
   run.tag('modifiedBy', 'Master CI')
   run.tag('modifiedBy', 'release pipeline') # Careful, tags are mutable

   run.add_properties({'BuildId': os.environ.get('VSTS_BUILD_ID')}) # Properties are not

   tags = run.get_tags()
   # tags = { 'DeploymentCandidate': None, 'modifiedBy': 'release pipeline' }

take_snapshot

Menyimpan snapshot dari file input atau folder.

take_snapshot(file_or_folder_path)

Parameter

Nama Deskripsi
file_or_folder_path
Diperlukan
str

File atau folder yang mengandung kode sumber eksekusi.

Mengembalikan

Jenis Deskripsi
str

Mengembalikan ID snapshot.

Keterangan

Snapshot dimaksudkan untuk menjadi kode sumber yang digunakan untuk mengeksekusi percobaan. Ini disimpan dengan eksekusi, sehingga percobaan eksekusi dapat direplikasi di masa depan.

Catatan

Snapshot secara otomatis diambil saat submit dipanggil. Biasanya, ini metode take_snapshot hanya diperlukan untuk eksekusi interaktif (buku catatan).

upload_file

Unggah file ke catatan eksekusi.

upload_file(name, path_or_stream, datastore_name=None)

Parameter

Nama Deskripsi
name
Diperlukan
str

Nama file yang akan diunggah.
path_or_stream
Diperlukan
str

Jalur lokal relatif atau streaming ke file yang akan diunggah.
datastore_name
Diperlukan
str

Nama DataStore opsional

Mengembalikan

Jenis Deskripsi
ResourceProperties

Keterangan


   run = experiment.start_logging()
   run.upload_file(name='important_file', path_or_stream="path/on/disk/file.txt")

Catatan

Eksekusi secara otomatis menangkap file di direktori output yang ditentukan, secara default ke "./outputs" untuk sebagian besar jenis eksekusi. Gunakan upload_file hanya ketika file tambahan perlu diunggah, atau direktori output tidak ditentukan.

upload_files

Unggah file ke rekaman eksekusi.

upload_files(names, paths, return_artifacts=False, timeout_seconds=None, datastore_name=None)

Parameter

Nama Deskripsi
names
Diperlukan
list

Nama file yang akan diunggah. Jika ditetapkan, jalur juga harus diatur.
paths
Diperlukan
list

Jalur lokal relatif ke file yang akan diunggah. Jika ditetapkan, nama diperlukan.
return_artifacts
Diperlukan
bool

Menunjukkan bahwa objek artefak harus dikembalikan untuk setiap file yang diunggah.
timeout_seconds
Diperlukan
int

Batas waktu untuk mengunggah file.
datastore_name
Diperlukan
str

Nama DataStore opsional

Keterangan

upload_files memiliki efek yang sama seperti upload_file pada file terpisah, namun ada manfaat performa dan pemanfaatan sumber daya saat menggunakan upload_files.


   import os

   run = experiment.start_logging()
   file_name_1 = 'important_file_1'
   file_name_2 = 'important_file_2'
   run.upload_files(names=[file_name_1, file_name_2],
                       paths=['path/on/disk/file_1.txt', 'other/path/on/disk/file_2.txt'])

   run.download_file(file_name_1, 'file_1.txt')

   os.mkdir("path")  # The path must exist
   run.download_file(file_name_2, 'path/file_2.txt')

Catatan

Eksekusi secara otomatis mengambil file di direktori output yang ditentukan, yang secara default ke "./outputs" untuk sebagian besar jenis eksekusi. Gunakan upload_files hanya ketika file tambahan perlu diunggah, atau direktori output tidak ditentukan.

upload_folder

Unggah folder yang ditentukan ke nama prefiks yang diberikan.

upload_folder(name, path, datastore_name=None)

Parameter

Nama Deskripsi
name
Diperlukan
str

Nama folder file yang akan diunggah.
folder
Diperlukan
str

Jalur lokal relatif ke folder yang akan diunggah.
datastore_name
Diperlukan
str

Nama DataStore opsional

Keterangan


   run = experiment.start_logging()
   run.upload_folder(name='important_files', path='path/on/disk')

   run.download_file('important_files/existing_file.txt', 'local_file.txt')

Catatan

Eksekusi secara otomatis mengambil file di direktori output yang ditentukan, yang secara default ke "./outputs" untuk sebagian besar jenis eksekusi. Gunakan upload_folder hanya ketika file tambahan perlu diunggah, atau direktori output tidak ditentukan.

wait_for_completion

Tunggu sampai eksekusi ini selesai. Menampilkan objek status setelah menunggu.

wait_for_completion(show_output=False, wait_post_processing=False, raise_on_error=True)

Parameter

Nama Deskripsi
show_output
bool

Menunjukkan apakah akan menampilkan output eksekusi pada sys.stdout.

nilai default: False
wait_post_processing
bool

Menunjukkan apakah akan menunggu pasca pemrosesan selesai setelah eksekusi selesai.

nilai default: False
raise_on_error
bool

Menunjukkan apakah Kesalahan dinaikkan saat Eksekusi berada dalam keadaan gagal.

nilai default: True

Mengembalikan

Jenis Deskripsi
dict

Objek status.

Atribut

description

Tampilkan deskripsi eksekusi.

Deskripsi opsional eksekusi adalah string yang ditentukan pengguna yang berguna untuk menjelaskan eksekusi.

Mengembalikan

Jenis Deskripsi
str

Deskripsi eksekusi.

display_name

Tampilkan nama tampilan eksekusi.

Nama tampilan opsional eksekusi adalah string yang ditentukan pengguna yang berguna untuk identifikasi eksekusi nanti.

Mengembalikan

Jenis Deskripsi
str

Nama tampilan eksekusi.

experiment

Dapatkan percobaan yang mengandung eksekusi.

Mengembalikan

Jenis Deskripsi
Experiment

Mengambil eksperimen yang sesuai dengan eksekusi.

id

Dapatkan ID eksekusi.

ID eksekusi adalah pengidentifikasi unik di seluruh percobaan yang terkandung.

Mengembalikan

Jenis Deskripsi
str

ID eksekusi.

name

TIDAK DIGUNAKAN LAGI. Gunakan display_name.

Nama opsional eksekusi adalah string yang ditentukan pengguna yang berguna untuk identifikasi eksekusi nanti.

Mengembalikan

Jenis Deskripsi
str

ID eksekusi.

number

Dapatkan angka eksekusi.

Angka yang meningkat secara monoton yang mewakili urutan eksekusi dalam sebuah percobaan.

Mengembalikan

Jenis Deskripsi
int

Angka eksekusi.

parent

Ambil induk eksekusi untuk eksekusi ini dari layanan.

Eksekusi dapat memiliki induk opsional, yang menghasilkan hierarki pohon potensial dari eksekusi. Untuk mencatat metrik ke induk eksekusi, gunakan metode log objek induk, misalnya, run.parent.log().

Mengembalikan

Jenis Deskripsi
Run

Induk eksekusi, atau Tidak Ada jika salah satu tidak disetel.

properties

Kembalikan properti bersifat abadi dari eksekusi ini.

Mengembalikan

Jenis Deskripsi
dict[str],
str

Properti yang dicache secara lokal dari eksekusi.

Keterangan

Properti termasuk informasi yang dihasilkan sistem bersifat abadi, seperti durasi, tanggal eksekusi, pengguna, dll.

status

Kembalikan status objek eksekusi.

tags

Kembalikan kumpulan tag yang dapat diubah pada eksekusi ini.

Mengembalikan

Jenis Deskripsi
dict

Tag yang disimpan pada objek eksekusi.

type

Dapatkan jenis eksekusi.

Menunjukkan bagaimana eksekusi dibuat atau dikonfigurasikan.

Mengembalikan

Jenis Deskripsi
str

Jenis eksekusi.