Accelerate documentation
متتبعات التجارب
متتبعات التجارب
GeneralTracker
فئة Tracker أساسية تُستخدم لجميع تطبيقات تكامل التسجيل.
يجب أن تستقبل كل دالة **kwargs التي سيتم تمريرها تلقائيًا من قاموس أساسي يُقدَّم إلى Accelerator.
يجب تنفيذ خصائص name وrequires_logging_directory وtracker بحيث:
name (str): تمثيل نصي لاسم فئة المتتبع، مثل “TensorBoard” requires_logging_directory (bool): ما إذا كان المسجّل يتطلب مجلدًا لتخزين سجلاته. tracker (object): يجب أن يعيد آلية التتبع الداخلية المستخدمة بواسطة فئة المتتبع (مثل run في wandb)
يمكن أن تتضمن التطبيقات أيضًا سمة main_process_only (bool) لتبديل ما إذا كان يجب أن تحدث عمليات التسجيل ذات الصلة، والتهيئة، و
الوظائف الأخرى على العملية الرئيسية أو عبر جميع العمليات (سيتم استخدام True افتراضيًا)
يجب أن يشغّل أي دوال نهائية ضمن واجهة برمجة التطبيقات للتتبع. إذا لم يكن لدى الواجهة برمجة التطبيقات دالة نهائية، فلا تكتب فوق تلك الطريقة.
سجّل
< source >( values: dictstep: int | None = None**kwargs )
يسجّل values في التشغيل الحالي. يجب أن تكون تنسيقات log الأساسية لواجهة برمجة التطبيقات الخاصة بالتتبع هنا، إلى جانب السلوك الخاص لـ `step parameter.
تهيئة المتتبع بشكل كسول داخل Accelerator لتجنب تهيئة PartialState قبل InitProcessGroupKwargs.
store_init_configuration
< source >( values: dict )
يسجّل values كمتغيرات فائقة للتشغيل. يجب أن تستخدم التطبيقات وظيفة تكوين التجربة في واجهة برمجة التطبيقات للتتبع.
register_tracker_class
accelerate.tracking.register_tracker_class
< source >( 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
< source >( run_name: strlogging_dir: str | os.PathLike**kwargs )
فئة Tracker تدعم tensorboard. يجب تهيئتها في بداية سكربت الخاص بك.
WandBTracker
فئة accelerate.tracking.WandBTracker
< source >( run_name: str**kwargs )
فئة Tracker تدعم wandb. يجب تهيئتها في بداية سكربت الخاص بك.
Trackio
فئة accelerate.tracking.TrackioTracker
< source >( run_name: str**kwargs )
المعاملات
- run_name (
str) — اسم تشغيل التجربة. سيُستخدم كاسمprojectعند إنشاء trackio. - **kwargs (معلمات إضافية بالكلمات المفتاحية، اختيارية) —
معلمات إضافية بالكلمات المفتاحية تُمرَّر إلى طريقة
trackio.init. راجع هذا init لاستعراض جميع المعلمات المدعومة بالكلمات المفتاحية.
فئة Tracker تدعم trackio. يجب تهيئتها في بداية سكربت الخاص بك.
CometMLTracker
class accelerate.tracking.CometMLTracker
< source >( run_name: str**kwargs )
المعاملات
- run_name (
str) — اسم تشغيل التجربة. - **kwargs (معلمات إضافية بالكلمات المفتاحية، اختيارية) —
معلمات إضافية بالكلمات المفتاحية تُمرَّر إلى طريقة
comet_ml.start: https://www.comet.com/docs/v2/api-and-sdk/python-sdk/reference/start/
فئة 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__
AimTracker
class accelerate.tracking.AimTracker
< source >( run_name: strlogging_dir: str | os.PathLike | None = '.'**kwargs )
فئة Tracker تدعم aim. يجب تهيئتها في بداية سكربت الخاص بك.
MLflowTracker
class 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 )
المعاملات
- 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__
< 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
class accelerate.tracking.ClearMLTracker
< source >( run_name: str | None = None**kwargs )
فئة Tracker تدعم clearml. يجب تهيئتها في بداية سكربت الخاص بك.
SwanLabTracker
class accelerate.tracking.SwanLabTracker
< source >( run_name: str**kwargs )
فئة Tracker تدعم swanlab. يجب تهيئتها في بداية سكربتك.