mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-01 13:18:10 +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>
207 lines
9.7 KiB
Plaintext
207 lines
9.7 KiB
Plaintext
---
|
|
title: تكامل MLflow
|
|
description: ابدأ بسرعة في مراقبة وكلائك باستخدام MLflow.
|
|
icon: bars-staggered
|
|
mode: "wide"
|
|
---
|
|
|
|
# نظرة عامة على MLflow
|
|
|
|
[MLflow](https://mlflow.org/) هو منصة مفتوحة المصدر لمساعدة ممارسي تعلم الآلة والفرق في التعامل مع تعقيدات عملية تعلم الآلة.
|
|
|
|
يوفر ميزة التتبع التي تعزز قابلية مراقبة نماذج اللغة الكبيرة (LLM) في تطبيقات الذكاء الاصطناعي التوليدي الخاصة بك من خلال التقاط معلومات تفصيلية حول تنفيذ خدمات تطبيقك.
|
|
يوفر التتبع طريقة لتسجيل المدخلات والمخرجات والبيانات الوصفية المرتبطة بكل خطوة وسيطة في الطلب، مما يتيح لك تحديد مصدر الأخطاء والسلوكيات غير المتوقعة بسهولة.
|
|
|
|

|
|
|
|
### الميزات
|
|
|
|
- **لوحة معلومات التتبع**: راقب أنشطة وكلاء crewAI الخاصين بك من خلال لوحات معلومات تفصيلية تتضمن المدخلات والمخرجات والبيانات الوصفية للنطاقات.
|
|
- **التتبع الآلي**: تكامل مؤتمت بالكامل مع crewAI، يمكن تفعيله عبر تشغيل `mlflow.crewai.autolog()`.
|
|
- **أدوات التتبع اليدوي بأقل مجهود**: خصّص أدوات التتبع من خلال واجهات برمجة التطبيقات عالية المستوى من MLflow مثل المزخرفات وأغلفة الدوال ومديري السياق.
|
|
- **التوافق مع OpenTelemetry**: يدعم تتبع MLflow تصدير التتبعات إلى جامع OpenTelemetry، الذي يمكن استخدامه بعد ذلك لتصدير التتبعات إلى خلفيات متنوعة مثل Jaeger وZipkin وAWS X-Ray.
|
|
- **تغليف ونشر الوكلاء**: قم بتغليف ونشر وكلاء crewAI الخاصين بك إلى خادم استدلال مع مجموعة متنوعة من أهداف النشر.
|
|
- **استضافة آمنة لنماذج LLM**: استضف نماذج LLM متعددة من مزودين مختلفين في نقطة نهاية موحدة من خلال بوابة MLflow.
|
|
- **التقييم**: قيّم وكلاء crewAI الخاصين بك باستخدام مجموعة واسعة من المقاييس عبر واجهة برمجة تطبيقات مريحة `mlflow.evaluate()`.
|
|
|
|
## تعليمات الإعداد
|
|
|
|
<Steps>
|
|
<Step title="تثبيت حزمة MLflow">
|
|
```shell
|
|
# The crewAI integration is available in mlflow>=2.19.0
|
|
pip install mlflow
|
|
```
|
|
</Step>
|
|
<Step title="بدء خادم تتبع MLflow">
|
|
```shell
|
|
# This process is optional, but it is recommended to use MLflow tracking server for better visualization and broader features.
|
|
mlflow server
|
|
```
|
|
</Step>
|
|
<Step title="تهيئة MLflow في تطبيقك">
|
|
أضف السطرين التاليين إلى كود تطبيقك:
|
|
|
|
```python
|
|
import mlflow
|
|
|
|
mlflow.crewai.autolog()
|
|
|
|
# Optional: Set a tracking URI and an experiment name if you have a tracking server
|
|
mlflow.set_tracking_uri("http://localhost:5000")
|
|
mlflow.set_experiment("CrewAI")
|
|
```
|
|
|
|
مثال على الاستخدام لتتبع وكلاء CrewAI:
|
|
|
|
```python
|
|
from crewai import Agent, Crew, Task
|
|
from crewai.knowledge.source.string_knowledge_source import StringKnowledgeSource
|
|
from crewai_tools import SerperDevTool, WebsiteSearchTool
|
|
|
|
from textwrap import dedent
|
|
|
|
content = "Users name is John. He is 30 years old and lives in San Francisco."
|
|
string_source = StringKnowledgeSource(
|
|
content=content, metadata={"preference": "personal"}
|
|
)
|
|
|
|
search_tool = WebsiteSearchTool()
|
|
|
|
|
|
class TripAgents:
|
|
def city_selection_agent(self):
|
|
return Agent(
|
|
role="City Selection Expert",
|
|
goal="Select the best city based on weather, season, and prices",
|
|
backstory="An expert in analyzing travel data to pick ideal destinations",
|
|
tools=[
|
|
search_tool,
|
|
],
|
|
verbose=True,
|
|
)
|
|
|
|
def local_expert(self):
|
|
return Agent(
|
|
role="Local Expert at this city",
|
|
goal="Provide the BEST insights about the selected city",
|
|
backstory="""A knowledgeable local guide with extensive information
|
|
about the city, it's attractions and customs""",
|
|
tools=[search_tool],
|
|
verbose=True,
|
|
)
|
|
|
|
|
|
class TripTasks:
|
|
def identify_task(self, agent, origin, cities, interests, range):
|
|
return Task(
|
|
description=dedent(
|
|
f"""
|
|
Analyze and select the best city for the trip based
|
|
on specific criteria such as weather patterns, seasonal
|
|
events, and travel costs. This task involves comparing
|
|
multiple cities, considering factors like current weather
|
|
conditions, upcoming cultural or seasonal events, and
|
|
overall travel expenses.
|
|
Your final answer must be a detailed
|
|
report on the chosen city, and everything you found out
|
|
about it, including the actual flight costs, weather
|
|
forecast and attractions.
|
|
|
|
Traveling from: {origin}
|
|
City Options: {cities}
|
|
Trip Date: {range}
|
|
Traveler Interests: {interests}
|
|
"""
|
|
),
|
|
agent=agent,
|
|
expected_output="Detailed report on the chosen city including flight costs, weather forecast, and attractions",
|
|
)
|
|
|
|
def gather_task(self, agent, origin, interests, range):
|
|
return Task(
|
|
description=dedent(
|
|
f"""
|
|
As a local expert on this city you must compile an
|
|
in-depth guide for someone traveling there and wanting
|
|
to have THE BEST trip ever!
|
|
Gather information about key attractions, local customs,
|
|
special events, and daily activity recommendations.
|
|
Find the best spots to go to, the kind of place only a
|
|
local would know.
|
|
This guide should provide a thorough overview of what
|
|
the city has to offer, including hidden gems, cultural
|
|
hotspots, must-visit landmarks, weather forecasts, and
|
|
high level costs.
|
|
The final answer must be a comprehensive city guide,
|
|
rich in cultural insights and practical tips,
|
|
tailored to enhance the travel experience.
|
|
|
|
Trip Date: {range}
|
|
Traveling from: {origin}
|
|
Traveler Interests: {interests}
|
|
"""
|
|
),
|
|
agent=agent,
|
|
expected_output="Comprehensive city guide including hidden gems, cultural hotspots, and practical travel tips",
|
|
)
|
|
|
|
|
|
class TripCrew:
|
|
def __init__(self, origin, cities, date_range, interests):
|
|
self.cities = cities
|
|
self.origin = origin
|
|
self.interests = interests
|
|
self.date_range = date_range
|
|
|
|
def run(self):
|
|
agents = TripAgents()
|
|
tasks = TripTasks()
|
|
|
|
city_selector_agent = agents.city_selection_agent()
|
|
local_expert_agent = agents.local_expert()
|
|
|
|
identify_task = tasks.identify_task(
|
|
city_selector_agent,
|
|
self.origin,
|
|
self.cities,
|
|
self.interests,
|
|
self.date_range,
|
|
)
|
|
gather_task = tasks.gather_task(
|
|
local_expert_agent, self.origin, self.interests, self.date_range
|
|
)
|
|
|
|
crew = Crew(
|
|
agents=[city_selector_agent, local_expert_agent],
|
|
tasks=[identify_task, gather_task],
|
|
verbose=True,
|
|
memory=True,
|
|
knowledge={
|
|
"sources": [string_source],
|
|
"metadata": {"preference": "personal"},
|
|
},
|
|
)
|
|
|
|
result = crew.kickoff()
|
|
return result
|
|
|
|
|
|
trip_crew = TripCrew("California", "Tokyo", "Dec 12 - Dec 20", "sports")
|
|
result = trip_crew.run()
|
|
|
|
print(result)
|
|
```
|
|
راجع [وثائق تتبع MLflow](https://mlflow.org/docs/latest/llms/tracing/index.html) لمزيد من الإعدادات وحالات الاستخدام.
|
|
</Step>
|
|
<Step title="عرض أنشطة الوكلاء">
|
|
الآن يتم التقاط تتبعات وكلاء crewAI الخاصين بك بواسطة MLflow.
|
|
لنقم بزيارة خادم تتبع MLflow لعرض التتبعات والحصول على رؤى حول وكلائك.
|
|
|
|
افتح `127.0.0.1:5000` في متصفحك لزيارة خادم تتبع MLflow.
|
|
<Frame caption="لوحة معلومات تتبع MLflow">
|
|
<img src="/images/mlflow1.png" alt="MLflow tracing example with crewai" />
|
|
</Frame>
|
|
</Step>
|
|
</Steps>
|