الانتقال إلى المحتوى الرئيسي
فصول دليل التدريب جميع الوثائق

واجهة أوامر التدريب للمؤسسات: الأوامر والخيارات

واجهة المشروع عبر سطر الأوامر، من الإعداد إلى الاسترداد والتقييم والتصدير ورموز الخروج.

فصول دليل التدريب

تبقى الأوامر والشفرة بالإنجليزية في جميع اللغات. استبدل العناصر النائبة المكتوبة بالأحرف الكبيرة بقيم من حسابك والمهمة المدفوعة؛ ولا تضع مفاتيح حقيقية في دفاتر ملاحظات أو سجلات مشتركة.

سير العمل عبر سطر الأوامر

لكل أمر أثر جانبي محدد ونتيجة ذات دلالة.
  1. init / doctor أنشئ المشروع وافحصه
  2. plan راجع دون تدريب
  3. run درّب ضمن الميزانيات
  4. evaluate افحص المعايير المحجوبة
  5. export تحقق وجهّز الحزمة

اتبع تسلسلًا واضحًا للأوامر

يستخدم الملف التنفيذي fpai-training عقد المشروع نفسه الذي تستخدمه واجهة Python: التهيئة، وفحص التوافق، ومراجعة خطة التشغيل التجريبي، والتنفيذ، والتقييم، ثم التصدير. لا تثبت قراءة الحالة أو الخطة نجاح التدريب.

  • تُقرأ بيانات المصادقة من FUSIONPOINTAI_API_KEY. ولا يوجد خيار لتمرير مفتاح API في سطر الأوامر.
  • استخدم --help مع الملف التنفيذي أو أحد الأوامر. ويعرض --version إصدار الحزمة المثبتة.
  • تحدد الخطة التي خضعت للمراجعة الإعدادات المحسومة. ولا تدعم CLI تجاوزات غير موثقة للمعلمات الفائقة.
مرجع أوامر CLI الكامل
الحقل أو الواجهةالنوع أو النتيجةالقيمة الافتراضية أو رمز الخروجالسلوك والتحقق
init --directory PATH command مطلوب / بلا قيمة افتراضية أنشئ هيكل مشروع جديدًا وإعدادًا نموذجيًا؛ وارفض مجلدًا غير فارغ موجودًا. لا تدريب ولا استدعاءات مدفوعة.
doctor --config PATH command مطلوب / بلا قيمة افتراضية افحص المخطط وملفات النموذج المحلية والتبعيات والتخزين والأجهزة وتوافق المحوّل. لا تحديث للأوزان ولا توليد من المعلّم.
plan --config PATH --dry-run command مطلوب / بلا قيمة افتراضية احسم القيم الافتراضية وثبّت البصمات واعرض الموضوعات والمشاركة والميزانيات والمخرجات. لا تحسين ولا عمل مدفوع للمعلّم.
run --config PATH command مطلوب / بلا قيمة افتراضية اشترط خطة صالحة خضعت للمراجعة واستحقاقًا نشطًا؛ واقفل تشغيلًا واحدًا ونفّذ تدريبًا فعليًا ضمن الميزانيات.
status --run PATH command مطلوب / بلا قيمة افتراضية اقرأ لقطة التشغيل المحلية المنقّحة. لا يعيد تشغيل العمال ولا ينشئ طلبات للمعلّم.
pause --run PATH command مطلوب / بلا قيمة افتراضية اطلب إيقافًا آمنًا وانتظر نقطة تحقق ذرية مكتملة. صالح فقط لتشغيل نشط تملكه.
resume --run PATH command مطلوب / بلا قيمة افتراضية استأنف تشغيلًا متوقفًا أو منقطعًا قابلًا للاسترداد فقط بعد التحقق الصارم من نقطة التحقق والخطة.
cancel --run PATH command مطلوب / بلا قيمة افتراضية أوقف العمال الذين تملكهم وحرر الموارد المملوكة وسجل الإلغاء؛ مع الاحتفاظ بالمخرجات الصالحة والتشخيصات.
evaluate --run PATH --split test command مطلوب / بلا قيمة افتراضية قيّم النموذج المثبت على بيانات التحقق أو الاختبار. لا تحسين ولا مشاركة للبيانات المخفية.
export --run PATH --format safetensors command مطلوب / بلا قيمة افتراضية تحقق من مخرج مدعوم ومقبول وجهّز حزمتَه؛ بلا رفع خارجي أو نشر مباشر.
مثال · bash 
fpai-training --version
fpai-training --help
fpai-training init --directory ./german-project
# Replace training.json and rubric/data files with your reviewed configuration.
fpai-training doctor --config ./german-project/training.json
fpai-training plan --config ./german-project/training.json --dry-run
# Inspect resolved values, data sharing and budgets BEFORE the next command.
fpai-training run --config ./german-project/training.json
fpai-training status --run ./german-project/runs/german-001
fpai-training evaluate --run ./german-project/runs/german-001 --split test
fpai-training export --run ./german-project/runs/german-001 --format safetensors
# Supply the key through FUSIONPOINTAI_API_KEY, never a command-line argument.

أوقف مؤقتًا أو استأنف أو ألغِ بأمان

توجّه أوامر التحكم إلى مجلد تشغيل واحد تملكه. ينتظر الإيقاف المؤقت إنشاء نقطة تحقق ذرية وإقرار العامل. ويتحقق الاستئناف من تطابق النموذج والبيانات والإعداد والمقيّم والبنية الموزعة نفسها. أما الإلغاء فيوقف عمال ذلك التشغيل وحدهم ويسجل إلغاءً نهائيًا. يجب ألا يؤدي تكرار طلب التحكم إلى إنشاء عملية تدريب أخرى.

  • يمكن استرداد التشغيل المتوقف مؤقتًا، لكنه لم يكتمل. والتشغيل الملغى ليس مخرجًا مقبولًا للتسليم.
  • استخدم نافذة طرفية ثانية للتحكم أثناء تشغيل العملية في الواجهة الأمامية.
  • بعد انتهاء المهلة، اقرأ الحالة قبل إعادة المحاولة. لا تحذف ملفات القفل ولا توقف مهام GPU غير المرتبطة.
خيارات الأوامر
الحقل أو الواجهةالنوع أو النتيجةالقيمة الافتراضية أو رمز الخروجالسلوك والتحقق
--directory path مطلوب / بلا قيمة افتراضية مطلوب لـ init. مجلد مشروع جديد قابل للكتابة.
--config path مطلوب / بلا قيمة افتراضية مطلوب لـ doctor وplan وrun. مسار ملف كامل للمخطط 1.0.
--run path مطلوب / بلا قيمة افتراضية مطلوب لـ status وpause وresume وcancel وevaluate وexport. مجلد تشغيل تملكه، وليس معرّف حساب/جلسة.
--dry-run flag true خيار صريح للخطة؛ إذ إن plan للقراءة فقط دائمًا فيما يتعلق بالأوزان والعمل المدفوع. لا يوجد وضع تنفيذ false/off.
--split enum "test" لـ evaluate فقط: validation أو test. لا تُستخدم بيانات الاختبار للتحسين مطلقًا.
--format enum "safetensors" لـ export فقط: safetensors أو adapters، بحسب قدرات المحوّل.
--help flag false اعرض مساعدة الملف التنفيذي أو الأمر دون الوصول إلى المزوّد.
--version flag false اعرض بيانات الإصدار المثبت الفعلية، لا رقم إصدار مخطط الإعداد.
مثال · bash 
# Run controls from a separate terminal if training is active.
fpai-training pause --run ./german-project/runs/german-001
# Wait for status=paused and a completed atomic checkpoint before stopping a host.
fpai-training status --run ./german-project/runs/german-001
fpai-training resume --run ./german-project/runs/german-001
# Cancellation is terminal; preserve existing artifacts, do not pretend it passed.
fpai-training cancel --run ./german-project/runs/german-001
# Repeat status, not run(), after a timeout. Never kill an unrelated process.

فسّر الحالة ورموز الخروج معًا

يعني رمز الخروج صفر نجاح العملية المطلوبة؛ لكن نجاح قراءة الحالة أو الإيقاف المؤقت أو التشغيل التجريبي لا يعني قبول التدريب. تتطلب نتيجة التدريب أيضًا حالة مكتملة وسبب توقف مقبولًا واجتياز جميع معايير التقييم الإلزامية. وتظل الأهداف الفاشلة ظاهرة في التقارير بدل إعادة وصفها على أنها ناجحة.

  • تكتب الأوامر JSON قابلًا للقراءة آليًا إلى stdout وتشخيصات منقّحة إلى stderr. ولا تظهر الأسرار في أي من المجرَيَين.
  • ينتظر run وresume حالة نهائية أو إيقافًا مؤقتًا؛ ويعيد status اللقطة الحالية.
  • ينتهي SIGINT بالرمز 130 بعد محاولة تنظيف العمال المملوكين. ولا يمكن لعملية انقطعت أن تختلق نقطة تحقق مكتملة.
مثال · text 
SDK 0.2.0 EXIT AND STATE CONTRACT
0   accepted, successful read/control, or successful dry-run; inspect operation.
2   invalid configuration; no training started.
3   incompatible model/runtime/method/export combination.
4   authentication, entitlement or authorized-sharing failure.
5   resource budget exhausted; preserve latest valid checkpoint and report.
6   evaluation requirements not met; not an accepted model.
7   execution, checkpoint, cancellation-control or export failure.
130 interrupted by the caller.

Lifecycle:
planned -> preparing -> training -> evaluating -> completed
training -> pausing -> paused -> training (validated resume)
active -> cancelling -> cancelled
active -> failed

stop_reason: accepted | budget_exhausted | no_progress | regression |
             cancelled | failed
paused is a recoverable state, not an accepted training result.
completed requires stop_reason=accepted and all required criteria passing.
Repeated control requests must read/reuse the owned transition, not spawn workers.
One run lock prevents duplicate execution of the same run directory.