mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-04 22:49:23 +00:00
* feat: adopt directory-based docs versioning with Edge channel Switch docs.crewai.com from navigation-only versioning (every version selector entry rendered the same docs/<lang>/* source files) to Mintlify's directory-based versioning so each version selector entry renders its own snapshot. Add an "Edge" channel under docs/edge/<lang>/* that always reflects main HEAD for unreleased work, eliminating pre-release leakage onto frozen release labels. External links to canonical /<lang>/* URLs are preserved via wildcard redirects that always land on the current default version. Layout: - docs/edge/<lang>/* rolling source (you edit here) - docs/edge/enterprise-api.*.yaml - docs/v<X.Y.Z>/<lang>/* frozen, immutable snapshots - docs/v<X.Y.Z>/enterprise-api.*.yaml - docs/images/ shared, append-only - docs/docs.json nav + redirects URLs follow the Mintlify-idiomatic shape: /edge/<lang>/<page> for Edge, /v<X.Y.Z>/<lang>/<page> for every frozen snapshot. The wildcard redirects /<lang>/:slug* -> /<default>/<lang>/:slug* keep stale links working, and every freeze rewrites them (plus all per-section/per-page redirects) so destinations always resolve to the current default without depending on a second redirect hop. Release flow integration (devtools release): - New module crewai_devtools.docs_versioning.freeze() materialises docs/v<X.Y.Z>/ from docs/edge/, rewrites openapi: refs inside the snapshot, inserts the version into every language block in docs.json, and refreshes all redirect destinations. - _update_docs_and_create_pr() in cli.py now calls that freeze during Phase 2 of devtools release. Edge changelogs are updated first (so the snapshot freeze picks them up), then the snapshot is staged alongside docs.json, branched as docs/freeze-v<X.Y.Z>, and the PR is titled [docs-freeze] docs: snapshot and changelog for v<X.Y.Z> — the title prefix the new CI guard reads. - The PR still gates tag, GitHub release, PyPI publish, and the enterprise release as before; no new PRs are added. - Pre-releases (1.X.YaN, 1.X.YbN, ...) skip the snapshot — they ride Edge — and the docs PR title omits the [docs-freeze] prefix. - docs_check (AI-generated docs scaffolding) writes to docs/edge/<lang>/* so newly-generated unreleased docs land in Edge and never accidentally touch a frozen snapshot. Migration scripts (one-shot): - scripts/docs/freeze_historical_versions.py reconstructs all 16 historical snapshots (v1.10.0 .. v1.14.7) from git tags via git archive | tar, rewriting openapi: MDX refs so each snapshot reads its own enterprise-api YAML rather than the live one. - scripts/docs/prefix_version_paths.py one-shot-migrates docs.json: rewrites every page path in 16 versioned blocks to point under docs/v<X.Y.Z>/, inserts a new Edge entry per language, tags v1.14.7 as Latest (default), prunes pages whose target file doesn't exist in the snapshot (e.g. docs/ar/ didn't exist before v1.12.0), and writes the wildcard + per-section redirects. - scripts/docs/freeze_current_edge.py is now a thin CLI wrapper around docs_versioning.freeze for manual one-off freezes (e.g. retroactively snapshotting a forgotten release). CI guards (.github/workflows/docs-snapshots.yml): - Frozen snapshots under docs/v[0-9]*/ are immutable; only PRs whose title contains [docs-freeze] (i.e. release-cut PRs generated by devtools release or the manual wrapper) may modify them. - Images under docs/images/ are append-only since snapshots share a single image directory. Deleting or renaming an image breaks every historical snapshot that still references it. Restored docs/images/crewai-otel-export.png from PR #3673; it was deleted in PR #4908 but v1.10.0 / v1.10.1 snapshots still reference it. Restoring instead of editing the snapshots preserves historical rendering fidelity and validates the new append-only rule retroactively. Tests: - lib/devtools/tests/test_docs_versioning.py covers the freeze: file copy, openapi rewrite, version insertion, default demotion, redirect upserts, per-section redirect rewriting, idempotency, and invalid inputs. Verified locally with mintlify broken-links: 0 broken links across the full site (Edge + 16 frozen versions, 4 locales). AGENTS.md (repo root) is the contributor guide for the new model; RELEASING.md is the release-cut runbook; README's Contribution section links to both. Co-authored-by: Cursor <cursoragent@cursor.com> * style: resolve linter issues --------- Co-authored-by: Cursor <cursoragent@cursor.com>
133 lines
7.1 KiB
Plaintext
133 lines
7.1 KiB
Plaintext
---
|
|
title: "تدريب الطواقم"
|
|
description: "قم بتدريب طواقمك المنشورة مباشرة من منصة CrewAI AMP لتحسين أداء الوكلاء بمرور الوقت"
|
|
icon: "dumbbell"
|
|
mode: "wide"
|
|
---
|
|
|
|
يتيح لك التدريب تحسين أداء الطاقم من خلال تشغيل جلسات تدريب تكرارية مباشرة من علامة تبويب **Training** في CrewAI AMP. تستخدم المنصة **وضع التدريب التلقائي** — حيث تتولى العملية التكرارية تلقائياً، على عكس تدريب CLI الذي يتطلب ملاحظات بشرية تفاعلية لكل تكرار.
|
|
|
|
بعد اكتمال التدريب، يقوم CrewAI بتقييم مخرجات الوكلاء ودمج الملاحظات في اقتراحات قابلة للتنفيذ لكل وكيل. يتم بعد ذلك تطبيق هذه الاقتراحات على تشغيلات الطاقم المستقبلية لتحسين جودة المخرجات.
|
|
|
|
<Tip>
|
|
للحصول على تفاصيل حول كيفية عمل تدريب CrewAI، راجع صفحة [مفاهيم التدريب](/ar/concepts/training).
|
|
</Tip>
|
|
|
|
## المتطلبات الأساسية
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="نشر نشط" icon="rocket">
|
|
تحتاج إلى حساب CrewAI AMP مع نشر نشط في حالة **Ready** (نوع Crew).
|
|
</Card>
|
|
<Card title="صلاحية التشغيل" icon="key">
|
|
يجب أن يكون لحسابك صلاحية تشغيل للنشر الذي تريد تدريبه.
|
|
</Card>
|
|
</CardGroup>
|
|
|
|
## كيفية تدريب طاقم
|
|
|
|
<Steps>
|
|
<Step title="افتح علامة تبويب Training">
|
|
انتقل إلى **Deployments**، انقر على نشرك، ثم اختر علامة تبويب **Training**.
|
|
</Step>
|
|
|
|
<Step title="أدخل اسم التدريب">
|
|
قدم **Training Name** — سيصبح هذا اسم ملف `.pkl` المستخدم لتخزين نتائج التدريب. على سبيل المثال، "Expert Mode Training" ينتج `expert_mode_training.pkl`.
|
|
</Step>
|
|
|
|
<Step title="املأ مدخلات الطاقم">
|
|
أدخل حقول إدخال الطاقم. هذه هي نفس المدخلات التي ستقدمها للتشغيل العادي — يتم تحميلها ديناميكياً بناءً على تكوين طاقمك.
|
|
</Step>
|
|
|
|
<Step title="ابدأ التدريب">
|
|
انقر على **Train Crew**. يتغير الزر إلى "Training..." مع مؤشر دوران أثناء تشغيل العملية.
|
|
|
|
خلف الكواليس:
|
|
- يتم إنشاء سجل تدريب للنشر الخاص بك
|
|
- تستدعي المنصة نقطة نهاية التدريب التلقائي للنشر
|
|
- يقوم الطاقم بتشغيل تكراراته تلقائياً — لا حاجة لملاحظات يدوية
|
|
</Step>
|
|
|
|
<Step title="راقب التقدم">
|
|
تعرض لوحة **Current Training Status**:
|
|
- **Status** — الحالة الحالية لجلسة التدريب
|
|
- **Nº Iterations** — عدد تكرارات التدريب المُهيأة
|
|
- **Filename** — ملف `.pkl` الذي يتم إنشاؤه
|
|
- **Started At** — وقت بدء التدريب
|
|
- **Training Inputs** — المدخلات التي قدمتها
|
|
</Step>
|
|
</Steps>
|
|
|
|
## فهم نتائج التدريب
|
|
|
|
بمجرد اكتمال التدريب، سترى بطاقات نتائج لكل وكيل تحتوي على المعلومات التالية:
|
|
|
|
- **Agent Role** — اسم/دور الوكيل في طاقمك
|
|
- **Final Quality** — درجة من 0 إلى 10 تقيّم جودة مخرجات الوكيل
|
|
- **Final Summary** — ملخص لأداء الوكيل أثناء التدريب
|
|
- **Suggestions** — توصيات قابلة للتنفيذ لتحسين سلوك الوكيل
|
|
|
|
### تحرير الاقتراحات
|
|
|
|
يمكنك تحسين الاقتراحات لأي وكيل:
|
|
|
|
<Steps>
|
|
<Step title="انقر على Edit">
|
|
في بطاقة نتائج أي وكيل، انقر على زر **Edit** بجوار الاقتراحات.
|
|
</Step>
|
|
|
|
<Step title="عدّل الاقتراحات">
|
|
حدّث نص الاقتراحات ليعكس التحسينات التي تريدها بشكل أفضل.
|
|
</Step>
|
|
|
|
<Step title="احفظ التغييرات">
|
|
انقر على **Save**. تتم مزامنة الاقتراحات المُعدّلة مع النشر وتُستخدم في جميع التشغيلات المستقبلية.
|
|
</Step>
|
|
</Steps>
|
|
|
|
## استخدام بيانات التدريب
|
|
|
|
لتطبيق نتائج التدريب على طاقمك:
|
|
|
|
1. لاحظ **Training Filename** (ملف `.pkl`) من جلسة التدريب المكتملة.
|
|
2. حدد اسم الملف هذا في تكوين kickoff أو التشغيل الخاص بنشرك.
|
|
3. يقوم الطاقم تلقائياً بتحميل ملف التدريب وتطبيق الاقتراحات المخزنة على كل وكيل.
|
|
|
|
هذا يعني أن الوكلاء يستفيدون من الملاحظات المُنشأة أثناء التدريب في كل تشغيل لاحق.
|
|
|
|
## التدريبات السابقة
|
|
|
|
يعرض الجزء السفلي من علامة تبويب Training **سجل جميع جلسات التدريب السابقة** للنشر. استخدم هذا لمراجعة التدريبات السابقة، ومقارنة النتائج، أو اختيار ملف تدريب مختلف للاستخدام.
|
|
|
|
## معالجة الأخطاء
|
|
|
|
إذا فشل تشغيل التدريب، تعرض لوحة الحالة حالة خطأ مع رسالة تصف ما حدث خطأ.
|
|
|
|
الأسباب الشائعة لفشل التدريب:
|
|
- **لم يتم تحديث وقت تشغيل النشر** — تأكد من أن نشرك يعمل بأحدث إصدار
|
|
- **أخطاء تنفيذ الطاقم** — مشاكل في منطق مهام الطاقم أو تكوين الوكيل
|
|
- **مشاكل الشبكة** — مشاكل الاتصال بين المنصة والنشر
|
|
|
|
## القيود
|
|
|
|
<Info>
|
|
ضع هذه القيود في الاعتبار عند التخطيط لسير عمل التدريب الخاص بك:
|
|
- **تدريب نشط واحد في كل مرة** لكل نشر — انتظر حتى ينتهي التشغيل الحالي قبل بدء آخر
|
|
- **وضع التدريب التلقائي فقط** — لا تدعم المنصة الملاحظات التفاعلية لكل تكرار مثل CLI
|
|
- **بيانات التدريب خاصة بالنشر** — ترتبط نتائج التدريب بمثيل وإصدار النشر المحدد
|
|
</Info>
|
|
|
|
## الموارد ذات الصلة
|
|
|
|
<CardGroup cols={3}>
|
|
<Card title="مفاهيم التدريب" icon="book" href="/ar/concepts/training">
|
|
تعلم كيف يعمل تدريب CrewAI.
|
|
</Card>
|
|
<Card title="تشغيل الطاقم" icon="play" href="/ar/enterprise/guides/kickoff-crew">
|
|
قم بتشغيل طاقمك المنشور من منصة AMP.
|
|
</Card>
|
|
<Card title="النشر على AMP" icon="cloud-arrow-up" href="/ar/enterprise/guides/deploy-to-amp">
|
|
انشر طاقمك واجعله جاهزاً للتدريب.
|
|
</Card>
|
|
</CardGroup>
|