Accelerate documentation

Deney Takipçileri

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Deney Takipçileri

GeneralTracker

sınıf accelerate.tracking.GeneralTracker

< >

( _blank = False )

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)

bitir

< >

( )

İ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

< >

( values: dictstep: int | None = None**kwargs )

Parametreler

  • values (Dictionary str to str, float, or int) — Anahtar-değer çiftleri olarak kaydedilecek değerler. Değerlerin tipi str, float veya int olmalıdır.
  • step (int, isteğe bağlı) — Çalışma adımı. Dahil edilirse, kayıt bu adımla ilişkilendirilir.

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.

başlat

< >

( )

PartialState'in InitProcessGroupKwargs'dan önce başlatılmasını önlemek için Accelerator içindeki tracker'ın tembel başlatılması.

store_init_configuration

< >

( values: dict )

Parametreler

  • values (Dictionary str to bool, str, float or int) — Anahtar-değer çiftleri olarak başlangıç hiperparametreleri olarak saklanacak değerler. Değerlerin tipi bool, str, float, int veya None olmalıdır.

Ç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

< >

( tracker_class: type[accelerate.tracking.GeneralTracker] )

Parametreler

  • tracker_class (GeneralTracker alt sınıfı) — Kaydedilecek izleyici sınıfı. GeneralTracker sınıfından türetmeli ve boş olmayan bir name sınıf özniteliği ile bir requires_logging_directory sınıf özniteliği tanımlamalıdır. Sınıf, Accelerator.init_trackers() fonksiyonuna project_name olarak geçirilen değerle, ilk konumsal argüman olarak örneklenir. requires_logging_directory değeri True olduğunda, günlük dizini ikinci konumsal argüman olarak geçilir (yerleşik izleyici sözleşmesiyle uyumlu olarak). init_kwargs içindeki izleyiciye özgü anahtar-argümanlar **kwargs olarak 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

< >

( run_name: strlogging_dir: str | os.PathLike**kwargs )

Parametreler

  • run_name (str) — Deney çalışmasının adı
  • logging_dir (str, os.PathLike) — TensorBoard günlüklerinin saklanacağı konum.
  • **kwargs (ek anahtar kelime argümanları, isteğe bağlı) — tensorboard.SummaryWriter.__init__ yöntemine iletilen ek anahtar kelime argümanları.

tensorboard destekleyen bir Tracker sınıfı. Betiğinizin başında başlatılmalıdır.

__init__

< >

( run_name: strlogging_dir: str | os.PathLike**kwargs )

WandBTracker

sınıf accelerate.tracking.WandBTracker

< >

( run_name: str**kwargs )

Parametreler

  • run_name (str) — Deney çalışmasının adı.
  • **kwargs (ek anahtar kelime argümanları, isteğe bağlı) — wandb.init yöntemine iletilen ek anahtar kelime argümanları.

wandb destekleyen bir Tracker sınıfı. Betiğinizin başında başlatılmalıdır.

__init__

< >

( run_name: str**kwargs )

Trackio

sınıf accelerate.tracking.TrackioTracker

< >

( run_name: str**kwargs )

Parametreler

  • run_name (str) — Deney çalıştırmasının adı. trackio örneklenirken project adı olarak kullanılacaktır.
  • **kwargs (ek anahtar kelime argümanları, isteğe bağlı) — trackio.init yö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.

__init__

< >

( run_name: str**kwargs )

CometMLTracker

sınıf accelerate.tracking.CometMLTracker

< >

( run_name: str**kwargs )

Parametreler

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__

__init__

< >

( run_name: str**kwargs )

AimTracker

sınıf accelerate.tracking.AimTracker

< >

( run_name: strlogging_dir: str | os.PathLike | None = '.'**kwargs )

Parametreler

  • run_name (str) — Deney çalışmasının adı.
  • **kwargs (ek anahtar kelime argümanları, isteğe bağlı) — Run.__init__ yöntemine iletilen ek anahtar kelime argümanları.

aim destekleyen bir Tracker sınıfı. Betiğinizin başında başlatılmalıdır.

__init__

< >

( run_name: strlogging_dir: str | os.PathLike | None = '.'**kwargs )

MLflowTracker

sınıf accelerate.tracking.MLflowTracker

< >

( 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 (str veya os.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, str anahtar ve değerlerinden oluşan isteğe bağlı bir dict veya bir dict'ten gelen str dö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ılan False) — Ç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ızca run_id belirtilmediğ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__

< >

( 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

< >

( run_name: str | None = None**kwargs )

Parametreler

  • run_name (str, isteğe bağlı) — Deneyin adı. CLEARML_PROJECT ve CLEARML_TASK ortam değişkenleri, bu argümana göre önceliklidir.
  • **kwargs (ek anahtar kelime argümanları, isteğe bağlı) — Task.__init__ yöntemine iletilen kwargs.

clearml destekleyen bir Tracker sınıfı. Betiğinizin başında başlatılmalıdır.

__init__

< >

( run_name: str | None = None**kwargs )

SwanLabTracker

sınıf accelerate.tracking.SwanLabTracker

< >

( run_name: str**kwargs )

Parametreler

  • run_name (str) — Deney çalışmasının adı.
  • **kwargs (ek anahtar kelime argümanları, isteğe bağlı) — swanlab.init yöntemine iletilen ek anahtar kelime argümanları.

swanlab destekleyen bir Tracker sınıfı. Betiğinizin başında başlatılmalıdır.

__init__

< >

( run_name: str**kwargs )

Update on GitHub