Accelerate documentation

متتبعات التجارب

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

متتبعات التجارب

GeneralTracker

class accelerate.tracking.GeneralTracker

< >

( _blank = False )

فئة Tracker أساسية تُستخدم لجميع تطبيقات تكامل التسجيل.

يجب أن تستقبل كل دالة **kwargs التي سيتم تمريرها تلقائيًا من قاموس أساسي يُقدَّم إلى Accelerator.

يجب تنفيذ خصائص name وrequires_logging_directory وtracker بحيث:

name (str): تمثيل نصي لاسم فئة المتتبع، مثل “TensorBoard” requires_logging_directory (bool): ما إذا كان المسجّل يتطلب مجلدًا لتخزين سجلاته. tracker (object): يجب أن يعيد آلية التتبع الداخلية المستخدمة بواسطة فئة المتتبع (مثل run في wandb)

يمكن أن تتضمن التطبيقات أيضًا سمة main_process_only (bool) لتبديل ما إذا كان يجب أن تحدث عمليات التسجيل ذات الصلة، والتهيئة، و الوظائف الأخرى على العملية الرئيسية أو عبر جميع العمليات (سيتم استخدام True افتراضيًا)

finish

< >

( )

يجب أن يشغّل أي دوال نهائية ضمن واجهة برمجة التطبيقات للتتبع. إذا لم يكن لدى الواجهة برمجة التطبيقات دالة نهائية، فلا تكتب فوق تلك الطريقة.

سجّل

< >

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

المعاملات

  • values (قاموس من str إلى str أو float أو int) — القيم التي سيتم تسجيلها كأزواج مفتاح-قيمة. يجب أن تكون القيم من النوع str أو float أو int.
  • step (int، اختياري) — خطوة التشغيل. إذا تم تضمينها، فسيتم ربط السجل بهذه الخطوة.

يسجّل values في التشغيل الحالي. يجب أن تكون تنسيقات log الأساسية لواجهة برمجة التطبيقات الخاصة بالتتبع هنا، إلى جانب السلوك الخاص لـ `step parameter.

بدء

< >

( )

تهيئة المتتبع بشكل كسول داخل Accelerator لتجنب تهيئة PartialState قبل InitProcessGroupKwargs.

store_init_configuration

< >

( values: dict )

المعاملات

  • values (قاموس من str إلى bool، str، float أو int) — القيم التي سيتم تخزينها كعوامل ضبط أولية على شكل أزواج مفتاح-قيمة. يجب أن تكون أنواع القيم bool، str، float، int، أو None.

يسجّل values كمتغيرات فائقة للتشغيل. يجب أن تستخدم التطبيقات وظيفة تكوين التجربة في واجهة برمجة التطبيقات للتتبع.

register_tracker_class

accelerate.tracking.register_tracker_class

< >

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

المعاملات

  • tracker_class (فئة فرعية من GeneralTracker) — فئة المسجّل التي سيتم تسجيلها. يجب أن تكون فئة فرعية من GeneralTracker وتعريف خاصية فئة name غير فارغة وخاصية فئة requires_logging_directory. يتم إنشاء كائن من الفئة باستخدام project_name المُمرَّر إلى Accelerator.init_trackers() كحجة موضعية أولى. عندما تكون requires_logging_directory هي True، يتم تمرير مجلد التسجيل كحجة موضعية ثانية (مطابقًا لاتفاقية المسجّل المدمج). تُمرَّر حجة الكلمات المفتاحية الخاصة بالمسجّل من init_kwargs كـ **kwargs.

يسجّل فئة فرعية مخصصة من GeneralTracker بحيث يمكن الإشارة إليها من خلال name في معامل log_with الخاص بـ Accelerator، بنفس الطريقة المستخدمة مع المسارات المدمجة.

يجب تسجيل المسار قبل إنشاء Accelerator الذي يستخدمه.

مثال:

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

فئة accelerate.tracking.TensorBoardTracker

< >

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

المعاملات

  • run_name (str) — اسم تشغيل التجربة
  • logging_dir (str, os.PathLike) — الموقع الذي تُحفظ فيه سجلات TensorBoard.
  • **kwargs (معلمات إضافية بالكلمات المفتاحية، اختيارية) — معلمات إضافية بالكلمات المفتاحية تُمرَّر إلى طريقة tensorboard.SummaryWriter.__init__.

فئة Tracker تدعم tensorboard. يجب تهيئتها في بداية سكربت الخاص بك.

__init__

< >

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

WandBTracker

فئة accelerate.tracking.WandBTracker

< >

( run_name: str**kwargs )

المعاملات

  • run_name (str) — اسم تشغيل التجربة.
  • **kwargs (معلمات إضافية بالكلمات المفتاحية، اختيارية) — معلمات إضافية بالكلمات المفتاحية تُمرَّر إلى طريقة wandb.init.

فئة Tracker تدعم wandb. يجب تهيئتها في بداية سكربت الخاص بك.

__init__

< >

( run_name: str**kwargs )

Trackio

فئة accelerate.tracking.TrackioTracker

< >

( run_name: str**kwargs )

المعاملات

  • run_name (str) — اسم تشغيل التجربة. سيُستخدم كاسم project عند إنشاء trackio.
  • **kwargs (معلمات إضافية بالكلمات المفتاحية، اختيارية) — معلمات إضافية بالكلمات المفتاحية تُمرَّر إلى طريقة trackio.init. راجع هذا init لاستعراض جميع المعلمات المدعومة بالكلمات المفتاحية.

فئة Tracker تدعم trackio. يجب تهيئتها في بداية سكربت الخاص بك.

__init__

< >

( run_name: str**kwargs )

CometMLTracker

class accelerate.tracking.CometMLTracker

< >

( run_name: str**kwargs )

المعاملات

فئة Tracker تدعم comet_ml. يجب تهيئتها في بداية سكربت الخاص بك.

يجب تخزين مفاتيح API في ملف إعدادات Comet.

ملاحظة: في إصدارات comet_ml الأقل من 3.41.0، يتم تمرير معاملات الكلمات المفتاحية الإضافية إلى comet_ml.Experiment بدلاً من ذلك: https://www.comet.com/docs/v2/api-and-sdk/python-sdk/reference/Experiment/#comet_ml.Experiment.__init__

__init__

< >

( run_name: str**kwargs )

AimTracker

class accelerate.tracking.AimTracker

< >

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

المعاملات

  • run_name (str) — اسم تشغيل التجربة.
  • **kwargs (معلمات إضافية بالكلمات المفتاحية، اختيارية) — معلمات إضافية بالكلمات المفتاحية تُمرَّر إلى طريقة Run.__init__.

فئة Tracker تدعم aim. يجب تهيئتها في بداية سكربت الخاص بك.

__init__

< >

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

MLflowTracker

class 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 )

المعاملات

  • experiment_name (str, اختياري) — اسم التجربة. متغير البيئة MLFLOW_EXPERIMENT_NAME له الأولوية على هذا الحُجج.
  • logging_dir (str أو os.PathLike، القيمة الافتراضية ".") — الموقع الذي تُحفظ فيه سجلات mlflow.
  • run_id (str, اختياري) — إذا تم تحديده، احصل على التشغيل ذي المعرّف الفريد العام (UUID) المحدد وسجّل المعايير والمقاييس تحت ذلك التشغيل. لن يتم تعيين وقت انتهاء التشغيل وسيتم تعيين حالته إلى قيد التشغيل، لكن خصائص التشغيل الأخرى (source_version، source_type، إلخ) لن تتغير. متغير البيئة MLFLOW_RUN_ID له الأولوية على هذا الحجة.
  • tags (Dict[str, str]، اختياري) — dict اختياري من مفاتيح وقيم من نوع str، أو str ناتج عن تصدير dict، ليتم تعيينها كوسوم على التشغيل. إذا كان يتم استئناف تشغيل، فسيتم تعيين هذه الوسوم على التشغيل المستأنف. إذا كان يتم إنشاء تشغيل جديد، فسيتم تعيين هذه الوسوم على التشغيل الجديد. متغير البيئة MLFLOW_TAGS له الأولوية على هذا الحُجج.
  • nested_run (bool، اختياري، القيمة الافتراضية False) — يتحكم في ما إذا كان التشغيل (run) متداخلاً داخل التشغيل الأب (parent run). القيمة True تنشئ تشغيلاً متداخلاً. متغير البيئة MLFLOW_NESTED_RUN له الأولوية على هذا الحجة.
  • run_name (str، اختياري) — اسم التشغيل الجديد (يُخزَّن كوسم mlflow.runName). يُستخدم فقط عندما لا يُحدَّد run_id.
  • description (str, اختياري) — نص اختياري يُعبّئ صندوق الوصف الخاص بالتشغيل. إذا كان التشغيل قيد الاستئناف، يُضبط الوصف على التشغيل المستأنف. أما إذا كان يُنشأ تشغيل جديد، فيُضبط الوصف على التشغيل الجديد.

فئة Tracker تدعم mlflow. يجب تهيئتها في بداية سكربت الخاص بك.

__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

class accelerate.tracking.ClearMLTracker

< >

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

المعاملات

  • run_name (str, اختياري) — اسم التجربة. تتمتع متغيرات البيئة CLEARML_PROJECT وCLEARML_TASK بأولوية أعلى من هذا الحجج.
  • **kwargs (معلمات إضافية بالكلمات المفتاحية، اختيارية) — معلمات kwargs التي تُمرَّر إلى طريقة Task.__init__.

فئة Tracker تدعم clearml. يجب تهيئتها في بداية سكربت الخاص بك.

__init__

< >

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

SwanLabTracker

class accelerate.tracking.SwanLabTracker

< >

( run_name: str**kwargs )

المعاملات

  • run_name (str) — اسم تشغيل التجربة.
  • **kwargs (معلمات إضافية بالكلمات المفتاحية، اختيارية) — معلمات إضافية بالكلمات المفتاحية تُمرَّر إلى طريقة swanlab.init.

فئة Tracker تدعم swanlab. يجب تهيئتها في بداية سكربتك.

__init__

< >

( run_name: str**kwargs )

Update on GitHub