Run Kelas
Menentukan kelas dasar untuk semua eksekusi eksperimen Azure Machine Learning.
Eksekusi mewakili satu percobaan eksperimen. Eksekusi digunakan untuk memantau eksekusi asinkron percobaan, metrik log, dan menyimpan output uji coba, dan untuk menganalisis hasil dan mengakses artefak yang dihasilkan oleh uji coba.
Jalankan objek dibuat saat Anda mengirimkan skrip untuk melatih model dalam berbagai skenario di Azure Machine Learning, termasuk eksekusi HyperDrive, eksekusi Alur, dan eksekusi AutoML. Objek Jalankan juga dibuat saat Anda submit atau start_logging dengan Experiment kelas .
Untuk mulai menggunakan eksperimen dan eksekusi, lihat
Menginisialisasi objek Jalankan.
Konstruktor
Run(experiment, run_id, outputs=None, **kwargs)
Parameter
| Nama | Deskripsi |
|---|---|
|
experiment
Diperlukan
|
Eksperimen yang berisi. |
|
run_id
Diperlukan
|
ID untuk eksekusi. |
|
outputs
|
Output yang akan dilacak. Nilai default: None
|
|
_run_dto
Diperlukan
|
<xref:azureml._restclient.models.run_dto.RunDto>
Untuk penggunaan internal saja. |
|
kwargs
Diperlukan
|
Kamus parameter konfigurasi tambahan. |
|
experiment
Diperlukan
|
Eksperimen yang berisi. |
|
run_id
Diperlukan
|
ID untuk eksekusi. |
|
outputs
Diperlukan
|
Output yang akan dilacak. |
|
kwargs
Diperlukan
|
Kamus parameter konfigurasi tambahan. |
Keterangan
Eksekusi mewakili satu percobaan eksperimen. Objek Jalankan digunakan untuk memantau eksekusi asinkron uji coba, metrik log, dan menyimpan output uji coba, dan untuk menganalisis hasil dan mengakses artefak yang dihasilkan oleh uji coba.
Eksekusi digunakan di dalam kode eksperimen Anda untuk mencatat metrik dan artefak ke layanan Riwayat Eksekusi.
Eksekusi digunakan di luar eksperimen Anda untuk memantau kemajuan dan untuk mengkueri dan menganalisis metrik dan hasil yang dihasilkan.
Fungsionalitas Jalankan meliputi:
Menyimpan dan mengambil metrik dan data
Mengunggah dan mengunduh file
Menggunakan tag serta hierarki anak untuk pencarian yang mudah dari eksekusi sebelumnya
Mendaftarkan file model tersimpan sebagai model yang dapat diopsisionalkan
Menyimpan, memodifikasi, dan mengambil properti eksekusi
Memuat eksekusi saat ini dari lingkungan jarak jauh dengan get_context metode
Rekam jepret file atau direktori secara efisien untuk reproduksi
Kelas ini berfungsi dengan Experiment dalam skenario ini:
Membuat eksekusi dengan mengeksekusi kode menggunakan submit
Membuat eksekusi secara interaktif di buku catatan menggunakan start_logging
Mencatat metrik dan mengunggah artefak dalam eksperimen Anda, seperti saat menggunakan log
Membaca metrik dan mengunduh artefak saat menganalisis hasil eksperimental, seperti saat menggunakan get_metrics
Untuk mengirimkan eksekusi, buat objek konfigurasi yang menjelaskan cara eksperimen dijalankan. Berikut adalah contoh berbagai objek konfigurasi yang dapat Anda gunakan:
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. Mencatat metrik ke eksekusi menyebabkan metrik disimpan dalam rekaman eksekusi dalam eksperimen. Anda dapat mencatat metrik yang sama beberapa kali dalam eksekusi, hasilnya dianggap sebagai vektor metrik tersebut.
Contoh:
run.log("accuracy", 0.95)
Daftar
Catat daftar nilai untuk dijalankan 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_rowdapat dipanggil sekali untuk mencatat tuple arbitrer, atau beberapa kali dalam perulangan untuk menghasilkan tabel 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
Catat gambar ke rekaman eksekusi. Gunakan log_image untuk mencatat file gambar atau plot matplotlib ke eksekusi. Gambar-gambar ini akan terlihat dan sebanding dalam rekaman eksekusi.
Contoh:
run.log_image("ROC", path)
Metode
| add_properties |
Tambahkan properti yang tidak dapat diubah ke eksekusi. Tag dan properti (dict[str, str]) berbeda dalam mutabilitasnya. Properti tidak dapat diubah, sehingga properti membuat catatan permanen untuk tujuan audit. Tag dapat diubah. Untuk informasi selengkapnya tentang bekerja dengan tag dan properti, lihat Menandai dan menemukan eksekusi. |
| add_type_provider |
Kait ekstensibilitas untuk jenis Jalankan kustom yang disimpan dalam Riwayat Eksekusi. |
| cancel |
Tandai eksekusi sebagai dibatalkan. Jika ada pekerjaan terkait dengan bidang cancel_uri yang ditetapkan, hentikan pekerjaan tersebut juga. |
| child_run |
Membuat eksekusi anak. |
| clean |
Hapus file yang sesuai dengan eksekusi saat ini pada target yang ditentukan dalam konfigurasi eksekusi. |
| complete |
Tunggu antrean tugas diproses. Kemudian eksekusi ditandai sebagai selesai. Ini biasanya digunakan dalam skenario notebook interaktif. |
| create_children |
Buat satu atau banyak eksekusi anak. |
| download_file |
Unduh file terkait dari penyimpanan. |
| download_files |
Unduh file dari awalan penyimpanan tertentu (nama folder) atau seluruh kontainer jika awalan tidak ditentukan. |
| fail |
Tandai eksekusi sebagai gagal. Secara opsional atur properti Kesalahan eksekusi dengan pesan atau pengecualian yang diteruskan ke |
| flush |
Tunggu antrean tugas diproses. |
| get |
Jalankan untuk ruang kerja ini dengan ID eksekusinya. |
| get_all_logs |
Unduh semua log untuk dijalankan ke direktori. |
| get_children |
Dapatkan semua turunan untuk eksekusi saat ini yang dipilih oleh filter tertentu. |
| get_context |
Mengembalikan konteks layanan saat ini. Gunakan metode ini untuk mengambil konteks layanan saat ini untuk mencatat metrik dan mengunggah file. Jika |
| get_detailed_status |
Ambil status terbaru eksekusi. Jika status eksekusi adalah "Diantrekan", status akan menampilkan detailnya. |
| get_details |
Dapatkan definisi, informasi status, file log saat ini, dan detail eksekusi lainnya. |
| get_details_with_logs |
Mengembalikan status eksekusi termasuk konten file log. |
| get_environment |
Dapatkan definisi lingkungan yang digunakan oleh eksekusi ini. |
| get_file_names |
Cantumkan file yang disimpan dalam asosiasi dengan eksekusi. |
| get_metrics |
Ambil metrik yang dicatat ke eksekusi. Jika |
| get_properties |
Ambil properti terbaru dari 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 terkait dengan ruang kerja Anda. Untuk contoh bekerja dengan rahasia, lihat Menggunakan rahasia dalam eksekusi pelatihan. |
| get_secrets |
Dapatkan nilai rahasia untuk daftar nama rahasia tertentu. Dapatkan kamus yang ditemukan dan tidak ditemukan rahasia untuk daftar nama yang disediakan. Setiap nama rahasia mereferensikan nilai yang disimpan di Azure Key Vault yang terkait dengan ruang kerja Anda. Untuk contoh bekerja dengan rahasia, lihat Menggunakan rahasia dalam eksekusi pelatihan. |
| get_snapshot_id |
Dapatkan ID rekam jepret terbaru. |
| get_status |
Ambil status terbaru eksekusi. Nilai umum yang dikembalikan termasuk "Berjalan", "Selesai", dan "Gagal". |
| get_submitted_run |
USANG. Gunakan get_context. Dapatkan eksekusi yang dikirimkan untuk eksperimen ini. |
| get_tags |
Ambil set tag terbaru yang dapat diubah saat dijalankan dari layanan. |
| list |
Dapatkan daftar eksekusi dalam eksperimen 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 diberikan. |
| log_accuracy_table |
Catat tabel akurasi ke penyimpanan artefak. Metrik tabel akurasi adalah metrik non-skalar multi-penggunaan yang dapat digunakan untuk menghasilkan beberapa jenis bagan garis yang bervariasi terus menerus selama ruang probabilitas yang diprediksi. Contoh bagan ini adalah ROC, presisi-pengenalan, dan kurva angkat. Perhitungan tabel akurasi mirip dengan perhitungan kurva ROC. Kurva ROC menyimpan tingkat positif sejati dan tingkat positif palsu pada banyak ambang kemungkinan yang berbeda. Tabel akurasi menyimpan jumlah mentah positif benar, positif palsu, negatif benar, dan negatif palsu pada banyak ambang batas probabilitas. Ada dua metode yang digunakan untuk memilih ambang batas: "probabilitas" dan "persentil." Mereka berbeda dalam bagaimana mereka mengambil sampel dari ruang probabilitas yang diprediksi. Ambang probabilitas adalah ambang batas yang diberi spasi seragam antara 0 dan 1. Jika NUM_POINTS adalah 5 ambang batas probabilitas adalah [0,0, 0,25, 0,5, 0,75, 1,0]. Ambang persentil diberi spasi sesuai dengan distribusi probabilitas yang diprediksi. Setiap ambang sesuai dengan persentil data pada ambang probabilitas. Misalnya, jika NUM_POINTS adalah 5, maka ambang pertama akan berada pada persentil ke-0, yang kedua pada persentil ke-25, yang ketiga pada tanggal 50, dan sebagainya. Tabel probabilitas dan tabel persentil adalah daftar 3D di mana dimensi pertama mewakili label kelas, dimensi kedua mewakili sampel pada satu ambang batas (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) dihitung dengan strategi satu vs. istirahat. Lihat tautan berikut untuk detail selengkapnya: https://en.wikipedia.org/wiki/Multiclass_classification N = # sampel dalam himpunan data validasi (200 dalam contoh) M = # ambang batas = # sampel yang diambil dari ruang probabilitas (5 dalam contoh) C = kelas # dalam himpunan data lengkap (3 dalam contoh) Beberapa invarian tabel akurasi:
Catatan: M dapat menjadi nilai apa pun dan mengontrol resolusi bagan Ini tidak bergantung pada himpunan data, ditentukan saat menghitung metrik, dan memperdagangkan ruang penyimpanan, waktu komputasi, dan resolusi. Label kelas harus berupa string, nilai kebingungan harus bilangan bulat, dan ambang batas harus mengambang. |
| log_confusion_matrix |
Catat matriks kebingungan ke penyimpanan artefak. Ini mencatat pembungkus di sekitar matriks kebingungan sklearn. Data metrik berisi label kelas dan daftar 2D untuk matriks itu sendiri. Lihat tautan berikut untuk detail selengkapnya tentang bagaimana metrik dihitung: 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 untuk dijalankan dengan nama yang diberikan. |
| log_predictions |
Catat prediksi ke penyimpanan artefak. Ini mencatat skor metrik yang dapat digunakan untuk membandingkan distribusi nilai target yang benar dengan distribusi nilai yang diprediksi untuk tugas regresi. Prediksi diikat dan penyimpangan standar dihitung untuk bilah kesalahan pada bagan garis. |
| log_residuals |
Residu log ke penyimpanan artefak. Ini mencatat data yang diperlukan untuk menampilkan histogram residu untuk tugas regresi. Residu diprediksi - aktual. Harus ada satu tepi lebih dari 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 proses ini. |
| restore_snapshot |
Memulihkan rekam jepret sebagai file ZIP. Mengembalikan jalur ke ZIP. |
| set_tags |
Tambahkan atau ubah sekumpulan tag saat dijalankan. Tag yang tidak diteruskan dalam kamus dibiarkan tidak 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 Menandai dan menemukan eksekusi. |
| start |
Tandai eksekusi sebagai dimulai. Ini biasanya digunakan dalam skenario lanjutan ketika eksekusi telah dibuat oleh aktor lain. |
| submit_child |
Kirim eksperimen dan kembalikan eksekusi anak aktif. |
| tag |
Tandai eksekusi dengan kunci string dan nilai string opsional. |
| take_snapshot |
Simpan rekam jepret file atau folder input. |
| upload_file |
Unggah file ke rekaman eksekusi. |
| upload_files |
Unggah file ke rekaman eksekusi. |
| upload_folder |
Unggah folder yang ditentukan ke nama awalan yang diberikan. |
| wait_for_completion |
Tunggu penyelesaian eksekusi ini. Mengembalikan objek status setelah menunggu. |
add_properties
Tambahkan properti yang tidak dapat diubah ke eksekusi.
Tag dan properti (dict[str, str]) berbeda dalam mutabilitasnya. Properti tidak dapat diubah, sehingga properti membuat catatan permanen untuk tujuan audit. Tag dapat diubah. Untuk informasi selengkapnya tentang bekerja dengan tag dan properti, lihat Menandai dan menemukan eksekusi.
add_properties(properties)
Parameter
| Nama | Deskripsi |
|---|---|
|
properties
Diperlukan
|
Properti tersembunyi yang disimpan dalam objek eksekusi. |
add_type_provider
Kait ekstensibilitas untuk jenis Jalankan kustom yang disimpan dalam Riwayat Eksekusi.
static add_type_provider(runtype, run_factory)
Parameter
| Nama | Deskripsi |
|---|---|
|
runtype
Diperlukan
|
Nilai Run.type tempat pabrik akan dipanggil. Contohnya termasuk 'hyperdrive' atau 'azureml.scriptrun', tetapi dapat diperluas dengan jenis kustom. |
|
run_factory
Diperlukan
|
<xref:function>
Fungsi dengan tanda tangan (Eksperimen, RunDto) -> Jalankan untuk dipanggil saat mencantumkan eksekusi. |
cancel
Tandai eksekusi sebagai dibatalkan.
Jika ada pekerjaan terkait dengan bidang cancel_uri yang ditetapkan, hentikan pekerjaan tersebut juga.
cancel()
child_run
Membuat eksekusi anak.
child_run(name=None, run_id=None, outputs=None)
Parameter
| Nama | Deskripsi |
|---|---|
|
name
|
Nama opsional untuk eksekusi anak, biasanya ditentukan untuk "bagian". Nilai default: None
|
|
run_id
|
ID eksekusi opsional untuk anak, jika tidak, ID tersebut dibuat secara otomatis. Biasanya parameter ini tidak diatur. Nilai default: None
|
|
outputs
|
Direktori output opsional untuk dilacak untuk anak. Nilai default: None
|
Mengembalikan
| Jenis | Deskripsi |
|---|---|
|
Anak itu lari. |
Keterangan
Ini digunakan untuk mengisolasi bagian dari eksekusi ke dalam sub bagian. 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 diatur untuk eksekusi anak, konten direktori tersebut akan diunggah ke rekaman eksekusi anak saat anak selesai.
clean
Hapus file yang sesuai dengan eksekusi saat ini pada target yang ditentukan dalam konfigurasi eksekusi.
clean()
Mengembalikan
| Jenis | Deskripsi |
|---|---|
|
Daftar file yang dihapus. |
complete
Tunggu antrean tugas diproses.
Kemudian eksekusi ditandai sebagai selesai. Ini biasanya digunakan dalam skenario notebook interaktif.
complete(_set_status=True)
Parameter
| Nama | Deskripsi |
|---|---|
|
_set_status
|
Menunjukkan apakah akan mengirim peristiwa status untuk pelacakan. Nilai default: True
|
create_children
Buat satu atau banyak eksekusi anak.
create_children(count=None, tag_key=None, tag_values=None)
Parameter
| Nama | Deskripsi |
|---|---|
|
count
|
Jumlah anak opsional yang akan dibuat. Nilai default: None
|
|
tag_key
|
Kunci opsional untuk mengisi entri Tag di semua anak yang dibuat. Nilai default: None
|
|
tag_Values
Diperlukan
|
Daftar nilai opsional yang akan dipetakan ke Tag[tag_key] untuk daftar eksekusi yang dibuat. |
|
tag_values
|
Nilai default: None
|
Mengembalikan
| Jenis | Deskripsi |
|---|---|
|
Daftar eksekusi anak. |
Keterangan
count Parameter ATAU parameter tag_key DAN tag_values harus ditentukan.
download_file
download_files
Unduh file dari awalan 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
|
Awalan filepath dalam kontainer untuk mengunduh semua artefak. |
|
output_directory
Diperlukan
|
Direktori opsional yang digunakan semua jalur artefak sebagai awalan. |
|
output_paths
Diperlukan
|
[str]
Jalur file opsional untuk menyimpan artefak yang diunduh. Harus unik dan cocok dengan panjang jalur. |
|
batch_size
Diperlukan
|
Jumlah file yang akan diunduh per batch. Defaultnya adalah 100 file. |
|
append_prefix
Diperlukan
|
Bendera opsional apakah akan menambahkan awalan yang ditentukan dari jalur file output akhir. Jika False, maka awalan dihapus dari jalur file output. |
|
timeout_seconds
Diperlukan
|
Waktu habis untuk mengunduh file. |
fail
Tandai eksekusi sebagai gagal.
Secara opsional atur properti Kesalahan eksekusi dengan pesan atau pengecualian yang diteruskan ke error_details.
fail(error_details=None, error_code=None, _set_status=True)
Parameter
| Nama | Deskripsi |
|---|---|
|
error_details
|
str atau
BaseException
Detail opsional kesalahan. Nilai default: None
|
|
error_code
|
Kode kesalahan opsional kesalahan untuk klasifikasi kesalahan. Nilai default: None
|
|
_set_status
|
Menunjukkan apakah akan mengirim peristiwa status untuk pelacakan. Nilai default: True
|
flush
Tunggu antrean tugas diproses.
flush(timeout_seconds=300)
Parameter
| Nama | Deskripsi |
|---|---|
|
timeout_seconds
|
Berapa lama menunggu (dalam detik) agar antrean tugas diproses. Nilai default: 300
|
get
get_all_logs
Unduh semua log untuk dijalankan ke direktori.
get_all_logs(destination=None)
Parameter
| Nama | Deskripsi |
|---|---|
|
destination
|
Jalur tujuan untuk menyimpan log. Jika tidak ditentukan, direktori bernama sebagai ID eksekusi dibuat di direktori proyek. Nilai default: None
|
Mengembalikan
| Jenis | Deskripsi |
|---|---|
|
Daftar nama log yang diunduh. |
get_children
Dapatkan semua turunan untuk eksekusi saat ini yang dipilih oleh filter tertentu.
get_children(recursive=False, tags=None, properties=None, type=None, status=None, _rehydrate_runs=True)
Parameter
| Nama | Deskripsi |
|---|---|
|
recursive
|
Menunjukkan apakah akan berulang melalui semua turunan. Nilai default: False
|
|
tags
|
Jika ditentukan, mengembalikan eksekusi yang cocok dengan "tag" atau {"tag" yang ditentukan: "value"}. Nilai default: None
|
|
properties
|
Jika ditentukan, mengembalikan eksekusi yang cocok dengan "properti" atau {"property" tertentu: "value"}. Nilai default: None
|
|
type
|
Jika ditentukan, mengembalikan eksekusi yang cocok dengan jenis ini. Nilai default: None
|
|
status
|
Jika ditentukan, mengembalikan eksekusi dengan status yang ditentukan "status". Nilai default: None
|
|
_rehydrate_runs
|
Menunjukkan apakah akan membuat instans eksekusi jenis asli atau Eksekusi dasar. Nilai default: True
|
Mengembalikan
| Jenis | Deskripsi |
|---|---|
|
Daftar Run objek. |
get_context
Mengembalikan konteks layanan saat ini.
Gunakan metode ini untuk mengambil konteks layanan saat ini untuk mencatat metrik dan mengunggah file. Jika allow_offline True (default), tindakan terhadap objek Jalankan akan dicetak ke standar keluar.
get_context(allow_offline=True, used_for_context_manager=False, **kwargs)
Parameter
| Nama | Deskripsi |
|---|---|
|
cls
Diperlukan
|
Menunjukkan metode kelas. |
|
allow_offline
|
Izinkan 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
|
Kamus parameter tambahan. |
|
used_for_context_manager
|
Nilai default: False
|
Mengembalikan
| Jenis | Deskripsi |
|---|---|
|
Eksekusi yang dikirimkan. |
Keterangan
Fungsi ini umumnya digunakan untuk mengambil objek Run yang diautentikasi di dalam skrip yang akan dikirimkan untuk dieksekusi melalui experiment.submit(). Objek eksekusi ini adalah konteks terautentikasi untuk berkomunikasi dengan layanan Azure Machine Learning dan kontainer konseptual tempat metrik, file (artefak), dan model terkandung.
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 eksekusi. Jika status eksekusi adalah "Diantrekan", status akan menampilkan detailnya.
get_detailed_status()
Mengembalikan
| Jenis | Deskripsi |
|---|---|
|
Status dan detail terbaru |
Keterangan
status: Status eksekusi saat ini. Nilai yang sama seperti yang dikembalikan dari get_status().
detail: Informasi terperinci 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 eksekusi lainnya.
get_details()
Mengembalikan
| Jenis | Deskripsi |
|---|---|
|
Mengembalikan 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 seperti yang dikembalikan dari get_status().
startTimeUtc: Waktu UTC ketika eksekusi ini dimulai, dalam ISO8601.
endTimeUtc: Waktu UTC ketika eksekusi ini selesai (Selesai atau Gagal), dalam ISO8601.
Kunci ini tidak ada jika eksekusi masih berlangsung.
properti: Pasangan kunci-nilai yang tidak dapat diubah yang terkait dengan eksekusi. Properti default termasuk ID rekam jepret eksekusi dan informasi tentang repositori git tempat eksekusi dibuat (jika ada). Properti tambahan dapat ditambahkan ke eksekusi menggunakan add_properties.
inputDatasets: Input himpunan data yang terkait dengan eksekusi.
outputDatasets: Himpunan data output yang terkait 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
Mengembalikan status eksekusi termasuk konten file log.
get_details_with_logs()
Mengembalikan
| Jenis | Deskripsi |
|---|---|
|
Mengembalikan status untuk eksekusi dengan konten file log. |
get_environment
Dapatkan definisi lingkungan yang digunakan oleh eksekusi ini.
get_environment()
Mengembalikan
| Jenis | Deskripsi |
|---|---|
|
Mengembalikan objek lingkungan. |
get_file_names
get_metrics
Ambil metrik yang dicatat ke eksekusi.
Jika recursive True (False secara default), ambil metrik untuk eksekusi dalam subtree eksekusi yang diberikan.
get_metrics(name=None, recursive=False, run_type=None, populate=False)
Parameter
| Nama | Deskripsi |
|---|---|
|
name
|
Nama metrik. Nilai default: None
|
|
recursive
|
Menunjukkan apakah akan berulang melalui semua turunan. Nilai default: False
|
|
run_type
|
Nilai default: None
|
|
populate
|
Menunjukkan apakah akan mengambil konten data eksternal yang ditautkan ke metrik. Nilai default: False
|
Mengembalikan
| Jenis | Deskripsi |
|---|---|
|
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 dari eksekusi dari layanan.
get_properties()
Mengembalikan
| Jenis | Deskripsi |
|---|---|
|
Properti eksekusi. |
Keterangan
Properti adalah informasi yang dihasilkan sistem yang tidak dapat diubah seperti durasi, tanggal eksekusi, pengguna, dan properti kustom yang ditambahkan dengan metode .add_properties Untuk informasi selengkapnya, lihat Menandai dan menemukan eksekusi.
Saat mengirimkan pekerjaan ke Azure Machine Learning, jika file sumber disimpan di repositori git lokal, informasi tentang repositori disimpan 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 terkait dengan ruang kerja Anda. Untuk contoh bekerja dengan rahasia, lihat Menggunakan rahasia dalam eksekusi pelatihan.
get_secret(name)
Parameter
| Nama | Deskripsi |
|---|---|
|
name
Diperlukan
|
Nama rahasia untuk mengembalikan rahasia. |
Mengembalikan
| Jenis | Deskripsi |
|---|---|
|
Nilai rahasia. |
get_secrets
Dapatkan nilai rahasia untuk daftar nama rahasia tertentu.
Dapatkan kamus yang ditemukan dan tidak ditemukan rahasia untuk daftar nama yang disediakan. Setiap nama rahasia mereferensikan nilai yang disimpan di Azure Key Vault yang terkait dengan ruang kerja Anda. Untuk contoh bekerja dengan rahasia, lihat Menggunakan rahasia dalam eksekusi pelatihan.
get_secrets(secrets)
Parameter
| Nama | Deskripsi |
|---|---|
|
secrets
Diperlukan
|
Daftar nama rahasia untuk mengembalikan nilai rahasia. |
Mengembalikan
| Jenis | Deskripsi |
|---|---|
|
Mengembalikan kamus rahasia yang ditemukan dan tidak ditemukan. |
get_snapshot_id
Dapatkan ID rekam jepret terbaru.
get_snapshot_id()
Mengembalikan
| Jenis | Deskripsi |
|---|---|
|
ID rekam jepret terbaru. |
get_status
Ambil status terbaru eksekusi.
Nilai umum yang dikembalikan termasuk "Berjalan", "Selesai", dan "Gagal".
get_status()
Mengembalikan
| Jenis | Deskripsi |
|---|---|
|
Status terbaru. |
Keterangan
NotStarted - Ini adalah objek Jalankan sisi klien status sementara sebelum pengiriman cloud.
Mulai - Eksekusi telah mulai diproses di cloud. Pemanggil memiliki ID eksekusi pada saat ini.
Provisi - Dikembalikan saat komputasi sesuai permintaan sedang dibuat untuk pengiriman pekerjaan tertentu.
Persiapan - Lingkungan eksekusi sedang disiapkan:
build gambar docker
penyiapan lingkungan conda
Diantrekan - Pekerjaan diantrekan dalam target komputasi. Misalnya, di BatchAI, pekerjaan dalam status antrean
sambil menunggu semua simpul yang diminta siap.
Berjalan - Pekerjaan mulai berjalan di target komputasi.
Finalisasi - Kode pengguna telah selesai dan eksekusi sedang dalam tahap pasca-pemrosesan.
CancelRequested - Pembatalan telah diminta untuk pekerjaan tersebut.
Selesai - Proses berhasil diselesaikan. Ini termasuk kode pengguna dan jalankan
tahap pasca-pemrosesan.
Gagal - Eksekusi gagal. Biasanya properti Kesalahan saat dijalankan akan memberikan detail alasannya.
Dibatalkan - Mengikuti permintaan pembatalan dan menunjukkan bahwa eksekusi sekarang berhasil dibatalkan.
NotResponding - Untuk eksekusi yang mengaktifkan Heartbeat, tidak ada heartbeat yang baru-baru ini 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
USANG. Gunakan get_context.
Dapatkan eksekusi yang dikirimkan untuk eksperimen ini.
get_submitted_run(**kwargs)
Mengembalikan
| Jenis | Deskripsi |
|---|---|
|
Eksekusi yang dikirimkan. |
get_tags
Ambil set tag terbaru yang dapat diubah saat dijalankan dari layanan.
get_tags()
Mengembalikan
| Jenis | Deskripsi |
|---|---|
|
Tag yang disimpan pada objek eksekusi. |
list
Dapatkan daftar eksekusi dalam eksperimen 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
|
Eksperimen yang berisi. |
|
type
|
Jika ditentukan, mengembalikan eksekusi yang cocok dengan jenis yang ditentukan. Nilai default: None
|
|
tags
|
Jika ditentukan, mengembalikan eksekusi yang cocok dengan "tag" atau {"tag" yang ditentukan: "value"}. Nilai default: None
|
|
properties
|
Jika ditentukan, mengembalikan eksekusi yang cocok dengan "properti" atau {"property" tertentu: "value"}. Nilai default: None
|
|
status
|
Jika ditentukan, mengembalikan eksekusi dengan status yang ditentukan "status". Nilai default: None
|
|
include_children
|
Jika diatur ke true, ambil semua eksekusi, tidak hanya yang tingkat atas. Nilai default: False
|
|
_rehydrate_runs
|
Jika diatur ke True (secara default), akan menggunakan penyedia terdaftar untuk menginstansiasi ulang objek untuk jenis tersebut, bukan Eksekusi dasar. Nilai default: True
|
Mengembalikan
| Jenis | Deskripsi |
|---|---|
|
Daftar eksekusi. |
Keterangan
Contoh kode berikut menunjukkan beberapa penggunaan list metode .
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
|
Komputasi yang berisi. |
|
type
|
Jika ditentukan, mengembalikan eksekusi yang cocok dengan jenis yang ditentukan. Nilai default: None
|
|
tags
|
Jika ditentukan, mengembalikan eksekusi yang cocok dengan "tag" atau {"tag" yang ditentukan: "value"}. Nilai default: None
|
|
properties
|
Jika ditentukan, mengembalikan eksekusi yang cocok dengan "properti" atau {"property" tertentu: "value"}. Nilai default: None
|
|
status
|
Jika ditentukan, mengembalikan eksekusi dengan status yang ditentukan "status". Hanya nilai yang diizinkan adalah "Berjalan" dan "Diantrekan". Nilai default: None
|
Mengembalikan
| Jenis | Deskripsi |
|---|---|
|
<xref:builtin.generator>
|
generator ~_restclient.models.RunDto |
log
Catat nilai metrik ke eksekusi dengan nama yang diberikan.
log(name, value, description='', step=None)
Parameter
| Nama | Deskripsi |
|---|---|
|
name
Diperlukan
|
Nama metrik. |
|
value
Diperlukan
|
Nilai yang akan diposting ke layanan. |
|
description
Diperlukan
|
Deskripsi metrik opsional. |
|
step
|
Sumbu opsional untuk menentukan urutan nilai dalam metrik. Nilai default: None
|
Keterangan
Mencatat metrik ke eksekusi menyebabkan metrik disimpan dalam rekaman eksekusi dalam eksperimen. Anda dapat mencatat metrik yang sama beberapa kali dalam eksekusi, hasilnya dianggap sebagai vektor metrik tersebut. Jika langkah ditentukan untuk metrik, langkah tersebut harus ditentukan untuk semua nilai.
log_accuracy_table
Catat tabel akurasi ke penyimpanan artefak.
Metrik tabel akurasi adalah metrik non-skalar multi-penggunaan yang dapat digunakan untuk menghasilkan beberapa jenis bagan garis yang bervariasi terus menerus selama ruang probabilitas yang diprediksi. Contoh bagan ini adalah ROC, presisi-pengenalan, dan kurva angkat.
Perhitungan tabel akurasi mirip dengan perhitungan kurva ROC. Kurva ROC menyimpan tingkat positif sejati dan tingkat positif palsu pada banyak ambang kemungkinan yang berbeda. Tabel akurasi menyimpan jumlah mentah positif benar, positif palsu, negatif benar, dan negatif palsu pada banyak ambang batas probabilitas.
Ada dua metode yang digunakan untuk memilih ambang batas: "probabilitas" dan "persentil." Mereka berbeda dalam bagaimana mereka mengambil sampel dari ruang probabilitas yang diprediksi.
Ambang probabilitas adalah ambang batas yang diberi spasi seragam antara 0 dan 1. Jika NUM_POINTS adalah 5 ambang batas probabilitas adalah [0,0, 0,25, 0,5, 0,75, 1,0].
Ambang persentil diberi spasi sesuai dengan distribusi probabilitas yang diprediksi. Setiap ambang sesuai dengan persentil data pada ambang probabilitas. Misalnya, jika NUM_POINTS adalah 5, maka ambang pertama akan berada pada persentil ke-0, yang kedua pada persentil ke-25, yang ketiga pada tanggal 50, dan sebagainya.
Tabel probabilitas dan tabel persentil adalah daftar 3D di mana dimensi pertama mewakili label kelas, dimensi kedua mewakili sampel pada satu ambang batas (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) dihitung dengan strategi satu vs. istirahat. Lihat tautan berikut untuk detail selengkapnya: https://en.wikipedia.org/wiki/Multiclass_classification
N = # sampel dalam himpunan data validasi (200 dalam contoh) M = # ambang batas = # sampel yang diambil dari ruang probabilitas (5 dalam contoh) C = kelas # dalam himpunan data lengkap (3 dalam contoh)
Beberapa invarian tabel akurasi:
- TP + FP + TN + FN = N untuk semua ambang batas untuk semua kelas
- TP + FN sama di semua ambang batas untuk kelas apa pun
- TN + FP sama di semua ambang untuk kelas apa pun
- Tabel probabilitas dan tabel persentil memiliki bentuk [C, M, 4]
Catatan: M dapat menjadi nilai apa pun dan mengontrol resolusi bagan Ini tidak bergantung pada himpunan data, ditentukan saat menghitung metrik, dan memperdagangkan ruang penyimpanan, waktu komputasi, dan resolusi.
Label kelas harus berupa string, nilai kebingungan harus bilangan bulat, dan ambang batas harus mengambang.
log_accuracy_table(name, value, description='')
Parameter
| Nama | Deskripsi |
|---|---|
|
name
Diperlukan
|
Nama tabel akurasi. |
|
value
Diperlukan
|
JSON berisi properti nama, versi, dan data. |
|
description
Diperlukan
|
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 penyimpanan artefak.
Ini mencatat pembungkus di sekitar matriks kebingungan sklearn. Data metrik berisi label kelas dan daftar 2D untuk matriks itu sendiri. Lihat tautan berikut untuk detail selengkapnya tentang bagaimana metrik dihitung: https://scikit-learn.org/stable/modules/generated/sklearn.metrics.confusion_matrix.html
log_confusion_matrix(name, value, description='')
Parameter
| Nama | Deskripsi |
|---|---|
|
name
Diperlukan
|
Nama matriks kebingungan. |
|
value
Diperlukan
|
JSON berisi properti nama, versi, dan data. |
|
description
Diperlukan
|
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
|
Nama metrik. |
|
path
Diperlukan
|
Jalur atau aliran gambar. |
|
plot
Diperlukan
|
<xref:matplotlib.pyplot>
Plot untuk mencatat sebagai gambar. |
|
description
Diperlukan
|
Deskripsi metrik opsional. |
Keterangan
Gunakan metode ini untuk mencatat file gambar atau plot matplotlib ke eksekusi. Gambar-gambar ini akan terlihat dan sebanding dalam rekaman eksekusi.
log_list
log_predictions
Catat prediksi ke penyimpanan artefak.
Ini mencatat skor metrik yang dapat digunakan untuk membandingkan distribusi nilai target yang benar dengan distribusi nilai yang diprediksi untuk tugas regresi.
Prediksi diikat dan penyimpangan standar dihitung untuk bilah kesalahan pada bagan garis.
log_predictions(name, value, description='')
Parameter
| Nama | Deskripsi |
|---|---|
|
name
Diperlukan
|
Nama prediksi. |
|
value
Diperlukan
|
JSON berisi properti nama, versi, dan data. |
|
description
Diperlukan
|
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
Residu log ke penyimpanan artefak.
Ini mencatat data yang diperlukan untuk menampilkan histogram residu untuk tugas regresi. Residu diprediksi - aktual.
Harus ada satu tepi lebih dari 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
|
Nama residu. |
|
value
Diperlukan
|
JSON berisi properti nama, versi, dan data. |
|
description
Diperlukan
|
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
|
Nama metrik. |
|
description
|
Deskripsi metrik opsional. Nilai default: None
|
|
kwargs
Diperlukan
|
Kamus parameter tambahan. Dalam hal 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 tuple 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
|
Nama metrik. |
|
value
Diperlukan
|
Nilai tabel metrik, kamus tempat kunci adalah kolom yang akan diposting ke layanan. |
|
description
Diperlukan
|
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
|
Nama dari model tersebut. |
|
model_path
|
Jalur cloud relatif ke model, misalnya, "output/modelname".
Ketika tidak ditentukan (Tidak Ada), Nilai default: None
|
|
tags
|
Kamus tag nilai kunci untuk ditetapkan ke model. Nilai default: None
|
|
properties
|
Kamus 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
|
Kerangka kerja model untuk mendaftar. Kerangka kerja yang saat ini didukung: TensorFlow, ScikitLearn, Onnx, Custom, Multi Nilai default: None
|
|
model_framework_version
|
Versi kerangka kerja dari model terdaftar. Nilai default: None
|
|
description
|
Deskripsi opsional model. Nilai default: None
|
|
datasets
|
Daftar tuple tempat elemen pertama menjelaskan hubungan model himpunan data dan elemen kedua adalah himpunan data. Nilai default: None
|
|
sample_input_dataset
|
Fakultatif. Sampel himpunan data input untuk model terdaftar Nilai default: None
|
|
sample_output_dataset
|
Fakultatif. Sampel himpunan data output untuk model terdaftar Nilai default: None
|
|
resource_configuration
|
Fakultatif. Konfigurasi sumber daya untuk menjalankan model terdaftar Nilai default: None
|
|
kwargs
Diperlukan
|
Parameter opsional. |
Mengembalikan
| Jenis | Deskripsi |
|---|---|
|
Model 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 proses ini.
remove_tags(tags)
Parameter
| Nama | Deskripsi |
|---|---|
|
tags
Diperlukan
|
Daftar tag yang akan dihapus. |
Mengembalikan
| Jenis | Deskripsi |
|---|---|
|
Tag yang disimpan pada objek eksekusi |
restore_snapshot
Memulihkan rekam jepret sebagai file ZIP. Mengembalikan jalur ke ZIP.
restore_snapshot(snapshot_id=None, path=None)
Parameter
| Nama | Deskripsi |
|---|---|
|
snapshot_id
|
ID rekam jepret untuk dipulihkan. Yang terbaru digunakan jika tidak ditentukan. Nilai default: None
|
|
path
|
Jalur tempat ZIP yang diunduh disimpan. Nilai default: None
|
Mengembalikan
| Jenis | Deskripsi |
|---|---|
|
Jalurnya. |
set_tags
Tambahkan atau ubah sekumpulan tag saat dijalankan. Tag yang tidak diteruskan dalam kamus dibiarkan tidak 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 Menandai dan menemukan eksekusi.
set_tags(tags)
Parameter
| Nama | Deskripsi |
|---|---|
|
tags
Diperlukan
|
Tag yang disimpan dalam objek eksekusi. |
start
Tandai eksekusi sebagai dimulai.
Ini biasanya digunakan dalam skenario lanjutan ketika eksekusi telah dibuat oleh aktor lain.
start()
submit_child
Kirim eksperimen dan kembalikan eksekusi anak aktif.
submit_child(config, tags=None, **kwargs)
Parameter
| Nama | Deskripsi |
|---|---|
|
config
Diperlukan
|
Konfigurasi yang akan dikirimkan. |
|
tags
|
Tag yang akan ditambahkan ke eksekusi yang dikirimkan, misalnya, {"tag": "value"}. Nilai default: None
|
|
kwargs
Diperlukan
|
Parameter tambahan yang digunakan dalam fungsi pengiriman untuk konfigurasi. |
Mengembalikan
| Jenis | Deskripsi |
|---|---|
|
Objek eksekusi. |
Keterangan
Kirim adalah panggilan asinkron ke platform Azure Machine Learning untuk menjalankan uji coba pada perangkat keras lokal atau jarak jauh. Bergantung pada konfigurasi, kirim akan secara otomatis menyiapkan lingkungan eksekusi Anda, menjalankan kode Anda, dan mengambil kode sumber Anda dan hasil ke dalam riwayat eksekusi eksperimen.
Untuk mengirimkan eksperimen, Pertama-tama Anda perlu membuat objek konfigurasi yang menjelaskan bagaimana eksperimen akan dijalankan. Konfigurasi tergantung pada jenis uji coba yang diperlukan.
Contoh cara mengirimkan eksperimen anak dari komputer 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
Tandai eksekusi dengan kunci string dan nilai string opsional.
tag(key, value=None)
Parameter
| Nama | Deskripsi |
|---|---|
|
key
Diperlukan
|
Kunci tag |
|
value
|
Nilai opsional untuk tag Nilai default: None
|
Keterangan
Tag dan properti pada eksekusi keduanya adalah kamus string -> string. Perbedaannya adalah mutabilitas: Tag dapat diatur, diperbarui, dan dihapus sementara Properti hanya dapat ditambahkan. Ini membuat Properti lebih sesuai untuk pemicu perilaku terkait sistem/alur kerja, sementara Tag umumnya menghadap pengguna dan bermakna bagi konsumen eksperimen.
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
Simpan rekam jepret file atau folder input.
take_snapshot(file_or_folder_path)
Parameter
| Nama | Deskripsi |
|---|---|
|
file_or_folder_path
Diperlukan
|
File atau folder yang berisi kode sumber eksekusi. |
Mengembalikan
| Jenis | Deskripsi |
|---|---|
|
Mengembalikan ID rekam jepret. |
Keterangan
Rekam jepret dimaksudkan untuk menjadi kode sumber yang digunakan untuk menjalankan eksperimen yang dijalankan. Ini disimpan dengan eksekusi sehingga uji coba eksekusi dapat direplikasi di masa mendatang.
Nota
Rekam jepret secara otomatis diambil ketika submit dipanggil. Biasanya, metode take_snapshot ini hanya diperlukan untuk eksekusi interaktif (notebook).
upload_file
Unggah file ke rekaman eksekusi.
upload_file(name, path_or_stream, datastore_name=None)
Parameter
| Nama | Deskripsi |
|---|---|
|
name
Diperlukan
|
Nama file yang akan diunggah. |
|
path_or_stream
Diperlukan
|
Jalur lokal relatif atau streaming ke file yang akan diunggah. |
|
datastore_name
Diperlukan
|
Nama DataStore Opsional |
Mengembalikan
| Jenis | Deskripsi |
|---|---|
Keterangan
run = experiment.start_logging()
run.upload_file(name='important_file', path_or_stream="path/on/disk/file.txt")
Nota
Menjalankan pengambilan file secara otomatis di direktori output yang ditentukan, yang 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
|
Nama file yang akan diunggah. Jika diatur, jalur juga harus diatur. |
|
paths
Diperlukan
|
Jalur lokal relatif ke file yang akan diunggah. Jika diatur, nama diperlukan. |
|
return_artifacts
Diperlukan
|
Menunjukkan bahwa objek artefak harus dikembalikan untuk setiap file yang diunggah. |
|
timeout_seconds
Diperlukan
|
Batas waktu untuk mengunggah file. |
|
datastore_name
Diperlukan
|
Nama DataStore Opsional |
Keterangan
upload_files memiliki efek yang sama seperti upload_file pada file terpisah, namun ada manfaat pemanfaatan performa dan 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')
Nota
Menjalankan pengambilan file secara otomatis di direktori output yang ditentukan, yang 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 awalan yang diberikan.
upload_folder(name, path, datastore_name=None)
Parameter
| Nama | Deskripsi |
|---|---|
|
name
Diperlukan
|
Nama folder file yang akan diunggah. |
|
folder
Diperlukan
|
Jalur lokal relatif ke folder yang akan diunggah. |
|
datastore_name
Diperlukan
|
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')
Nota
Menjalankan pengambilan file secara otomatis di direktori output yang ditentukan, yang 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 penyelesaian eksekusi ini. Mengembalikan objek status setelah menunggu.
wait_for_completion(show_output=False, wait_post_processing=False, raise_on_error=True)
Parameter
| Nama | Deskripsi |
|---|---|
|
show_output
|
Menunjukkan apakah akan menampilkan output eksekusi pada sys.stdout. Nilai default: False
|
|
wait_post_processing
|
Menunjukkan apakah akan menunggu pemrosesan pasca selesai setelah eksekusi selesai. Nilai default: False
|
|
raise_on_error
|
Menunjukkan apakah Kesalahan dimunculkan saat Eksekusi dalam keadaan gagal. Nilai default: True
|
Mengembalikan
| Jenis | Deskripsi |
|---|---|
|
Objek status. |
Atribut
description
Mengembalikan deskripsi eksekusi.
Deskripsi opsional dari eksekusi adalah string yang ditentukan pengguna yang berguna untuk menjelaskan eksekusi.
Mengembalikan
| Jenis | Deskripsi |
|---|---|
|
Deskripsi eksekusi. |
display_name
Mengembalikan nama tampilan eksekusi.
Nama tampilan opsional dari eksekusi adalah string yang ditentukan pengguna yang berguna untuk identifikasi eksekusi nanti.
Mengembalikan
| Jenis | Deskripsi |
|---|---|
|
Nama tampilan eksekusi. |
experiment
Dapatkan eksperimen yang berisi eksekusi.
Mengembalikan
| Jenis | Deskripsi |
|---|---|
|
Mengambil eksperimen yang sesuai dengan eksekusi. |
id
Dapatkan ID eksekusi.
ID eksekusi adalah pengidentifikasi unik di seluruh eksperimen yang berisi.
Mengembalikan
| Jenis | Deskripsi |
|---|---|
|
ID eksekusi. |
name
USANG. Gunakan display_name.
Nama opsional eksekusi adalah string yang ditentukan pengguna yang berguna untuk identifikasi eksekusi nanti.
Mengembalikan
| Jenis | Deskripsi |
|---|---|
|
ID eksekusi. |
number
Dapatkan nomor eksekusi.
Angka yang meningkat secara monoton yang mewakili urutan eksekusi dalam eksperimen.
Mengembalikan
| Jenis | Deskripsi |
|---|---|
|
Nomor eksekusi. |
parent
Ambil eksekusi induk untuk eksekusi ini dari layanan.
Eksekusi dapat memiliki induk opsional, yang menghasilkan hierarki pohon potensial eksekusi. Untuk mencatat metrik ke eksekusi induk, gunakan log metode objek induk, misalnya, run.parent.log().
Mengembalikan
| Jenis | Deskripsi |
|---|---|
|
Induk berjalan, atau Tidak Ada jika tidak diatur. |
properties
status
Mengembalikan status objek eksekusi.
tags
Mengembalikan kumpulan tag yang dapat diubah pada proses ini.
Mengembalikan
| Jenis | Deskripsi |
|---|---|
|
Tag yang disimpan pada objek eksekusi. |
type
Dapatkan jenis eksekusi.
Menunjukkan bagaimana eksekusi dibuat atau dikonfigurasi.
Mengembalikan
| Jenis | Deskripsi |
|---|---|
|
Jenis eksekusi. |