mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-07 16:09:30 +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
6.2 KiB
Plaintext
133 lines
6.2 KiB
Plaintext
---
|
|
title: "Treinamento de Crews"
|
|
description: "Treine seus crews implantados diretamente da plataforma CrewAI AMP para melhorar o desempenho dos agentes ao longo do tempo"
|
|
icon: "dumbbell"
|
|
mode: "wide"
|
|
---
|
|
|
|
O treinamento permite que você melhore o desempenho do crew executando sessões de treinamento iterativas diretamente da aba **Training** no CrewAI AMP. A plataforma usa o **modo de auto-treinamento** — ela gerencia o processo iterativo automaticamente, diferente do treinamento via CLI que requer feedback humano interativo por iteração.
|
|
|
|
Após a conclusão do treinamento, o CrewAI avalia as saídas dos agentes e consolida o feedback em sugestões acionáveis para cada agente. Essas sugestões são então aplicadas às execuções futuras do crew para melhorar a qualidade das saídas.
|
|
|
|
<Tip>
|
|
Para detalhes sobre como o treinamento do CrewAI funciona internamente, consulte a página [Conceitos de Treinamento](/pt-BR/concepts/training).
|
|
</Tip>
|
|
|
|
## Pré-requisitos
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="Implantação ativa" icon="rocket">
|
|
Você precisa de uma conta CrewAI AMP com uma implantação ativa em status **Ready** (tipo Crew).
|
|
</Card>
|
|
<Card title="Permissão de execução" icon="key">
|
|
Sua conta deve ter permissão de execução para a implantação que deseja treinar.
|
|
</Card>
|
|
</CardGroup>
|
|
|
|
## Como treinar um crew
|
|
|
|
<Steps>
|
|
<Step title="Abra a aba Training">
|
|
Navegue até **Deployments**, clique na sua implantação e selecione a aba **Training**.
|
|
</Step>
|
|
|
|
<Step title="Insira um nome de treinamento">
|
|
Forneça um **Training Name** — este será o nome do arquivo `.pkl` usado para armazenar os resultados do treinamento. Por exemplo, "Expert Mode Training" produz `expert_mode_training.pkl`.
|
|
</Step>
|
|
|
|
<Step title="Preencha as entradas do crew">
|
|
Insira os campos de entrada do crew. Estas são as mesmas entradas que você forneceria para um kickoff normal — elas são carregadas dinamicamente com base na configuração do seu crew.
|
|
</Step>
|
|
|
|
<Step title="Inicie o treinamento">
|
|
Clique em **Train Crew**. O botão muda para "Training..." com um spinner enquanto o processo é executado.
|
|
|
|
Por trás dos panos:
|
|
- Um registro de treinamento é criado para sua implantação
|
|
- A plataforma chama o endpoint de auto-treinamento da implantação
|
|
- O crew executa suas iterações automaticamente — nenhum feedback manual é necessário
|
|
</Step>
|
|
|
|
<Step title="Monitore o progresso">
|
|
O painel **Current Training Status** exibe:
|
|
- **Status** — Estado atual da execução do treinamento
|
|
- **Nº Iterations** — Número de iterações de treinamento configuradas
|
|
- **Filename** — O arquivo `.pkl` sendo gerado
|
|
- **Started At** — Quando o treinamento começou
|
|
- **Training Inputs** — As entradas que você forneceu
|
|
</Step>
|
|
</Steps>
|
|
|
|
## Entendendo os resultados do treinamento
|
|
|
|
Uma vez que o treinamento for concluído, você verá cards de resultado por agente com as seguintes informações:
|
|
|
|
- **Agent Role** — O nome/função do agente no seu crew
|
|
- **Final Quality** — Uma pontuação de 0 a 10 avaliando a qualidade da saída do agente
|
|
- **Final Summary** — Um resumo do desempenho do agente durante o treinamento
|
|
- **Suggestions** — Recomendações acionáveis para melhorar o comportamento do agente
|
|
|
|
### Editando sugestões
|
|
|
|
Você pode refinar as sugestões para qualquer agente:
|
|
|
|
<Steps>
|
|
<Step title="Clique em Edit">
|
|
No card de resultado de qualquer agente, clique no botão **Edit** ao lado das sugestões.
|
|
</Step>
|
|
|
|
<Step title="Modifique as sugestões">
|
|
Atualize o texto das sugestões para refletir melhor as melhorias que você deseja.
|
|
</Step>
|
|
|
|
<Step title="Salve as alterações">
|
|
Clique em **Save**. As sugestões editadas são sincronizadas de volta à implantação e usadas em todas as execuções futuras.
|
|
</Step>
|
|
</Steps>
|
|
|
|
## Usando dados de treinamento
|
|
|
|
Para aplicar os resultados do treinamento ao seu crew:
|
|
|
|
1. Anote o **Training Filename** (o arquivo `.pkl`) da sua sessão de treinamento concluída.
|
|
2. Especifique este nome de arquivo na configuração de kickoff ou execução da sua implantação.
|
|
3. O crew carrega automaticamente o arquivo de treinamento e aplica as sugestões armazenadas a cada agente.
|
|
|
|
Isso significa que os agentes se beneficiam do feedback gerado durante o treinamento em cada execução subsequente.
|
|
|
|
## Treinamentos anteriores
|
|
|
|
A parte inferior da aba Training exibe um **histórico de todas as sessões de treinamento anteriores** da implantação. Use isso para revisar execuções de treinamento anteriores, comparar resultados ou selecionar um arquivo de treinamento diferente para usar.
|
|
|
|
## Tratamento de erros
|
|
|
|
Se uma execução de treinamento falhar, o painel de status mostra um estado de erro junto com uma mensagem descrevendo o que deu errado.
|
|
|
|
Causas comuns de falhas de treinamento:
|
|
- **Runtime da implantação não atualizado** — Certifique-se de que sua implantação está executando a versão mais recente
|
|
- **Erros de execução do crew** — Problemas na lógica de tarefas do crew ou configuração do agente
|
|
- **Problemas de rede** — Problemas de conectividade entre a plataforma e a implantação
|
|
|
|
## Limitações
|
|
|
|
<Info>
|
|
Tenha estas restrições em mente ao planejar seu fluxo de trabalho de treinamento:
|
|
- **Um treinamento ativo por vez** por implantação — aguarde a execução atual terminar antes de iniciar outra
|
|
- **Apenas modo de auto-treinamento** — a plataforma não suporta feedback interativo por iteração como o CLI
|
|
- **Dados de treinamento são específicos da implantação** — os resultados do treinamento estão vinculados à instância e versão específicas da implantação
|
|
</Info>
|
|
|
|
## Recursos relacionados
|
|
|
|
<CardGroup cols={3}>
|
|
<Card title="Conceitos de Treinamento" icon="book" href="/pt-BR/concepts/training">
|
|
Aprenda como o treinamento do CrewAI funciona internamente.
|
|
</Card>
|
|
<Card title="Kickoff Crew" icon="play" href="/pt-BR/enterprise/guides/kickoff-crew">
|
|
Execute seu crew implantado a partir da plataforma AMP.
|
|
</Card>
|
|
<Card title="Implantar no AMP" icon="cloud-arrow-up" href="/pt-BR/enterprise/guides/deploy-to-amp">
|
|
Faça a implantação do seu crew e deixe-o pronto para treinamento.
|
|
</Card>
|
|
</CardGroup>
|