HyperDriveRun Kelas

HyperDriveRun berisi detail eksperimen HyperDrive yang dikirimkan.

Kelas ini dapat digunakan untuk mengelola, memeriksa status, dan mengambil detail eksekusi untuk eksekusi HyperDrive dan masing-masing eksekusi turunan yang dihasilkan.

Menginisialisasi eksekusi HyperDrive.

Warisan

Run

HyperDriveRun

Konstruktor

HyperDriveRun(experiment, run_id, hyperdrive_config=None, **kwargs)

Parameter

Nama	Deskripsi
experiment Diperlukan	Experiment Eksperimen untuk eksekusi HyperDrive.
run_id Diperlukan	str ID eksekusi HyperDrive.
hyperdrive_config	HyperDriveConfig Konfigurasi untuk eksekusi HyperDrive ini. Nilai default: None
experiment Diperlukan	Experiment Eksperimen untuk eksekusi HyperDrive.
run_id Diperlukan	str Id eksekusi HyperDrive.
hyperdrive_config Diperlukan	HyperDriveConfig Konfigurasi untuk eksekusi HyperDrive ini. Jika Tidak Ada, kami berasumsi bahwa eksekusi sudah ada dan akan mencoba menghidrasi dari cloud.

Metode

cancel	Kembalikan True jika eksekusi HyperDrive berhasil dibatalkan.
fail	Jangan gunakan. Metode gagal tidak didukung untuk subkelas HyperDriveRun.
get_best_run_by_primary_metric	Temukan dan kembalikan instans Eksekusi yang sesuai dengan performa terbaik di antara semua turunan yang berjalan. Eksekusi dengan performa terbaik diidentifikasi hanya berdasarkan parameter metrik utama yang ditentukan di HyperDriveConfig. PrimaryMetricGoal mengatur apakah metrik utama minimum atau maksimum digunakan. Untuk melakukan analisis yang lebih detail dari semua metrik ExperimentRun yang diluncurkan oleh HyperDriveRun ini, gunakan get_metrics. Hanya satu eksekusi yang dikembalikan, meskipun beberapa Eksekusi yang diluncurkan oleh proses HyperDrive ini mencapai metrik terbaik yang sama.
get_children_sorted_by_primary_metric	Kembalikan daftar turunan yang diurutkan berdasarkan metrik utama terbaiknya. Pengurutan dilakukan sesuai dengan metrik utama dan tujuannya: jika maksimal, turunan dikembalikan dalam urutan menurun dari metrik utama terbaiknya. Jika kebalikannya adalah True, urutannya dibalik. Setiap turunan dalam hasil memiliki id eksekusi, hyperparameter, nilai dan status metrik utama terbaik. Turunan tanpa metrik utama dibuang saat discard_no_metric adalah True. Jika tidak, turunan akan ditambahkan ke daftar di belakang turunan lain dengan metrik utama. Perhatikan bahwa opsi sebaliknya tidak berdampak pada turunan tersebut.
get_diagnostics	Jangan gunakan. Metode get_diagnostics tidak didukung untuk subkelas HyperDriveRun.
get_hyperparameters	Kembalikan hyperparameter untuk semua eksekusi turunan yang diluncurkan oleh HyperDriveRun ini.
get_metrics	Kembalikan metrik dari semua eksekusi yang diluncurkan oleh HyperDriveRun ini.

cancel

Kembalikan True jika eksekusi HyperDrive berhasil dibatalkan.

cancel()

Mengembalikan

Jenis	Deskripsi
bool	Apakah eksekusi berhasil dibatalkan atau tidak.

fail

Jangan gunakan. Metode gagal tidak didukung untuk subkelas HyperDriveRun.

fail()

Pengecualian

Jenis	Deskripsi
HyperDriveNotImplementedException

get_best_run_by_primary_metric

Temukan dan kembalikan instans Eksekusi yang sesuai dengan performa terbaik di antara semua turunan yang berjalan.

Eksekusi dengan performa terbaik diidentifikasi hanya berdasarkan parameter metrik utama yang ditentukan di HyperDriveConfig. PrimaryMetricGoal mengatur apakah metrik utama minimum atau maksimum digunakan. Untuk melakukan analisis yang lebih detail dari semua metrik ExperimentRun yang diluncurkan oleh HyperDriveRun ini, gunakan get_metrics. Hanya satu eksekusi yang dikembalikan, meskipun beberapa Eksekusi yang diluncurkan oleh proses HyperDrive ini mencapai metrik terbaik yang sama.

get_best_run_by_primary_metric(include_failed=True, include_canceled=True, include_resume_from_runs=True) -> Run | None

Parameter

Nama	Deskripsi
include_failed	bool Apakah akan menyertakan eksekusi yang gagal. Nilai default: True
include_canceled	bool Apakah akan menyertakan eksekusi yang dibatalkan. Nilai default: True
include_resume_from_runs	bool Apakah akan menyertakan eksekusi resume_from yang diwarisi. Nilai default: True

Mengembalikan

Jenis	Deskripsi
Run	Eksekusi terbaik, atau Tidak Ada jika tidak ada turunan yang memiliki metrik utama.

get_children_sorted_by_primary_metric

Kembalikan daftar turunan yang diurutkan berdasarkan metrik utama terbaiknya.

Pengurutan dilakukan sesuai dengan metrik utama dan tujuannya: jika maksimal, turunan dikembalikan dalam urutan menurun dari metrik utama terbaiknya. Jika kebalikannya adalah True, urutannya dibalik.

Setiap turunan dalam hasil memiliki id eksekusi, hyperparameter, nilai dan status metrik utama terbaik.

Turunan tanpa metrik utama dibuang saat discard_no_metric adalah True. Jika tidak, turunan akan ditambahkan ke daftar di belakang turunan lain dengan metrik utama. Perhatikan bahwa opsi sebaliknya tidak berdampak pada turunan tersebut.

get_children_sorted_by_primary_metric(top=0, reverse=False, discard_no_metric=False)

Parameter

Nama	Deskripsi
top	int Jumlah turunan teratas yang akan dikembalikan. Jika 0, semua turunan akan dikembalikan. Nilai default: 0
reverse	bool Jika True, urutannya akan dibalik. Ini hanya berdampak pada turunan dengan metrik utama. Nilai default: False
discard_no_metric	bool Jika False, turunan tanpa metrik utama akan ditambahkan ke daftar. Nilai default: False

Mengembalikan

Jenis	Deskripsi
list	Daftar kamus dengan id eksekusi, hyperparameter, metrik dan status utama terbaik

get_diagnostics

Jangan gunakan. Metode get_diagnostics tidak didukung untuk subkelas HyperDriveRun.

get_diagnostics()

Pengecualian

Jenis	Deskripsi
HyperDriveNotImplementedException

get_hyperparameters

Kembalikan hyperparameter untuk semua eksekusi turunan yang diluncurkan oleh HyperDriveRun ini.

get_hyperparameters()

Mengembalikan

Jenis	Deskripsi
dict	Hyperparameter untuk semua eksekusi turunan. Ini adalah kamus dengan run_id sebagai kunci.

get_metrics

Kembalikan metrik dari semua eksekusi yang diluncurkan oleh HyperDriveRun ini.

get_metrics()

Mengembalikan

Jenis	Deskripsi
dict	Metrik untuk semua turunan dari eksekusi ini.

Atribut

hyperdrive_config

Kembalikan konfigurasi eksekusi hyperdrive.

Mengembalikan

Jenis	Deskripsi
HyperDriveConfig	Konfigurasi eksekusi hyperdrive.

HYPER_DRIVE_RUN_USER_AGENT

HYPER_DRIVE_RUN_USER_AGENT = 'sdk_run_hyper_drive'

RUN_TYPE

RUN_TYPE = 'hyperdrive'