Accelerate documentation
Deney Takipçileri
Deney Takipçileri
GeneralTracker
Tüm günlük kaydı entegrasyon uygulamalarında kullanılacak temel bir Tracker sınıfı.
Her fonksiyon, Accelerator'a sağlanan bir temel sözlükten otomatik olarak geçirilecek **kwargs parametresini kabul etmelidir.
name, requires_logging_directory ve tracker özelliklerini şu şekilde uygulayın:
name (str): Takipçi sınıfının adının dize gösterimi, örneğin “TensorBoard” requires_logging_directory (bool): Kaydedicinin loglarını depolamak için bir dizine ihtiyaç duyup duymadığı. tracker (object): Bir takipçi sınıfının kullandığı dahili takip mekanizmasını döndürmelidir (örneğin wandb için run)
Uygulamalar, ilgili loglama, init ve diğer işlevlerin ana süreçte mi yoksa tüm süreçlerde mi gerçekleşeceğini değiştirmek için main_process_only (bool) özniteliğini de içerebilir (varsayılan olarak True kullanılır)
İzleme API'si içindeki tüm sonlandırma işlevlerini çalıştırmalıdır. API'nin böyle bir işlevi yoksa, o yöntemi yalnızca geçersiz kılmayın.
kayıt
< source >( values: dictstep: int | None = None**kwargs )
Güncel çalıştırmaya values değerlerini kaydeder. Bir izleme API'sinin temel log uygulamaları, `step parametresi için özel davranışla birlikte buraya eklenmelidir.
PartialState'in InitProcessGroupKwargs'dan önce başlatılmasını önlemek için Accelerator içindeki tracker'ın tembel başlatılması.
store_init_configuration
< source >( values: dict )
Çalışma için values değerlerini hiperparametre olarak kaydeder. Uygulamalar, bir izleme API'sinin deneysel yapılandırma işlevselliğini kullanmalıdır.
register_tracker_class
accelerate.tracking.register_tracker_class
< source >( tracker_class: type[accelerate.tracking.GeneralTracker] )
Parametreler
- tracker_class (
GeneralTrackeralt sınıfı) — Kaydedilecek izleyici sınıfı.GeneralTrackersınıfından türetmeli ve boş olmayan birnamesınıf özniteliği ile birrequires_logging_directorysınıf özniteliği tanımlamalıdır. Sınıf,Accelerator.init_trackers()fonksiyonunaproject_nameolarak geçirilen değerle, ilk konumsal argüman olarak örneklenir.requires_logging_directorydeğeriTrueolduğunda, günlük dizini ikinci konumsal argüman olarak geçilir (yerleşik izleyici sözleşmesiyle uyumlu olarak).init_kwargsiçindeki izleyiciye özgü anahtar-argümanlar**kwargsolarak iletilir.
Yerleşik izleyicilerle aynı şekilde, Accelerator'un log_with argümanında name ile referans alınabilmesi için özel bir GeneralTracker alt sınıfı kaydeder.
Takipçi, onu kullanan Accelerator örneği oluşturulmadan önce kaydedilmelidir.
Örnek:
from accelerate import Accelerator
from accelerate.tracking import GeneralTracker, register_tracker_class
class MyTracker(GeneralTracker):
name = "my_tracker"
requires_logging_directory = False
# ... implement the rest of the `GeneralTracker` interface
register_tracker_class(MyTracker)
accelerator = Accelerator(log_with="my_tracker")TensorBoardTracker
sınıf accelerate.tracking.TensorBoardTracker
< source >( run_name: strlogging_dir: str | os.PathLike**kwargs )
tensorboard destekleyen bir Tracker sınıfı. Betiğinizin başında başlatılmalıdır.
WandBTracker
sınıf accelerate.tracking.WandBTracker
< source >( run_name: str**kwargs )
wandb destekleyen bir Tracker sınıfı. Betiğinizin başında başlatılmalıdır.
Trackio
sınıf accelerate.tracking.TrackioTracker
< source >( run_name: str**kwargs )
Parametreler
- run_name (
str) — Deney çalıştırmasının adı. trackio örneklenirkenprojectadı olarak kullanılacaktır. - **kwargs (ek anahtar kelime argümanları, isteğe bağlı) —
trackio.inityöntemine iletilen ek anahtar kelime argümanları. Desteklenen tüm anahtar kelime argümanlarını görmek için bu init belgesine bakın.
trackio destekleyen bir Tracker sınıfı. Betiğinizin başında başlatılmalıdır.
CometMLTracker
sınıf accelerate.tracking.CometMLTracker
< source >( run_name: str**kwargs )
Parametreler
- run_name (
str) — Deney çalışmasının adı. - **kwargs (ek anahtar kelime argümanları, isteğe bağlı) —
comet_ml.startyöntemine iletilen ek anahtar kelime argümanları: https://www.comet.com/docs/v2/api-and-sdk/python-sdk/reference/start/
comet_ml destekleyen bir Tracker sınıfı. Betiğinizin başında başlatılmalıdır.
API anahtarları bir Comet yapılandırma dosyasında saklanmalıdır.
Not:
comet_ml sürümleri < 3.41.0 için, ek anahtar kelime argümanları bunun yerine comet_ml.Experiment sınıfına iletilir: https://www.comet.com/docs/v2/api-and-sdk/python-sdk/reference/Experiment/#comet_ml.Experiment.__init__
AimTracker
sınıf accelerate.tracking.AimTracker
< source >( run_name: strlogging_dir: str | os.PathLike | None = '.'**kwargs )
aim destekleyen bir Tracker sınıfı. Betiğinizin başında başlatılmalıdır.
MLflowTracker
sınıf accelerate.tracking.MLflowTracker
< source >( experiment_name: str | None = Nonelogging_dir: str | os.PathLike | None = Nonerun_id: str | None = Nonetags: dict[str, typing.Any] | str | None = Nonenested_run: bool | None = Falserun_name: str | None = Nonedescription: str | None = None )
Parametreler
- experiment_name (
str, isteğe bağlı) — Deneyin adı. MLFLOW_EXPERIMENT_NAME ortam değişkeni, bu argümana göre önceliklidir. - logging_dir (
strveyaos.PathLike, varsayılan".") — mlflow günlüklerinin saklanacağı konum. - run_id (
str, isteğe bağlı) — Belirtilirse, belirtilen UUID'ye sahip çalışmayı alır ve parametreleri ve metrikleri bu çalışmanın altında kaydeder. Çalışmanın bitiş zamanı ayarlanmamış ve durumu çalışıyor olarak ayarlanır, ancak çalışmanın diğer öznitelikleri (source_version, source_type vb.) değiştirilmez. MLFLOW_RUN_ID ortam değişkeni, bu argümana göre önceliklidir. - tags (
Dict[str, str], isteğe bağlı) — Çalışmaya etiket olarak ayarlanacak,stranahtar ve değerlerinden oluşan isteğe bağlı birdictveya birdict'ten gelenstrdökümü. Bir çalışma yeniden başlatılıyorsa, bu etiketler yeniden başlatılan çalışmaya ayarlanır. Yeni bir çalışma oluşturuluyorsa, bu etiketler yeni çalışmaya ayarlanır. MLFLOW_TAGS ortam değişkeni, bu argümandan önceliklidir. - nested_run (
bool, isteğe bağlı, varsayılanFalse) — Çalışmanın (run) üst çalışma (parent run) içinde iç içe olup olmadığını kontrol eder. True, iç içe bir çalışma oluşturur. MLFLOW_NESTED_RUN ortam değişkeni, bu argümana göre önceliklidir. - run_name (
str, isteğe bağlı) — Yeni çalıştırmanın adı (mlflow.runName etiketi olarak saklanır). Yalnızcarun_idbelirtilmediğinde kullanılır. - description (
str, isteğe bağlı) — Çalışmanın açıklama kutusunu dolduran isteğe bağlı bir dize. Bir çalışma yeniden başlatılıyorsa, açıklama yeniden başlatılan çalışmaya ayarlanır. Yeni bir çalışma oluşturuluyorsa, açıklama yeni çalışmaya ayarlanır.
mlflow destekleyen bir Tracker sınıfı. Betiğinizin başında başlatılmalıdır.
__init__
< source >( experiment_name: str | None = Nonelogging_dir: str | os.PathLike | None = Nonerun_id: str | None = Nonetags: dict[str, typing.Any] | str | None = Nonenested_run: bool | None = Falserun_name: str | None = Nonedescription: str | None = None )
ClearMLTracker
sınıf accelerate.tracking.ClearMLTracker
< source >( run_name: str | None = None**kwargs )
clearml destekleyen bir Tracker sınıfı. Betiğinizin başında başlatılmalıdır.
SwanLabTracker
sınıf accelerate.tracking.SwanLabTracker
< source >( run_name: str**kwargs )
swanlab destekleyen bir Tracker sınıfı. Betiğinizin başında başlatılmalıdır.