docs(crews): document missing/undocumented parameters in crew.py (OSS-32)#5409
Open
lorenzejay wants to merge 1 commit intomainfrom
Open
docs(crews): document missing/undocumented parameters in crew.py (OSS-32)#5409lorenzejay wants to merge 1 commit intomainfrom
lorenzejay wants to merge 1 commit intomainfrom
Conversation
…SS-32) - Add 8 missing parameters to the Crew Attributes table: chat_llm, before_kickoff_callbacks, after_kickoff_callbacks, tracing, skills, security_config, checkpoint - Add new "## Checkpointing" section before "## Memory Utilization" with: - Quick-start checkpoint=True example - Full CheckpointConfig usage example - Crew.from_checkpoint() resume pattern - CheckpointConfig attributes table (location, on_events, provider, max_checkpoints) - Note on auto-restored checkpoint fields Closes OSS-32
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes OSS-32 —
concepts/crews.mdxwas 113 days behindcrew.py, missing 8 public-facing parameters and the entire Checkpointing system.Changes
1. 8 New Rows in the Crew Attributes Table
chat_llmcrewai chatCLI to interact with the crewbefore_kickoff_callbacks@before_kickoffdecorator)after_kickoff_callbacks@after_kickoffdecorator)tracingTrue=always on,False=always off,None=inheritskillsPathdirectories orSkillobjects applied to all agents in the crewsecurity_configSecurityConfigfor crew fingerprinting/identitycheckpoint2. New
## CheckpointingSection (inserted before## Memory Utilization)checkpoint=Trueone-linerCheckpointConfigwithlocation,on_events,max_checkpointsCrew.from_checkpoint("path").kickoff()CheckpointConfigattributes table — all 4 fields with types, defaults, and descriptionscheckpoint_inputs,checkpoint_train, andcheckpoint_kickoff_event_idare auto-restored and don't need to be set manuallyAcceptance Criteria (from OSS-32)
chat_llm,before_kickoff_callbacks,after_kickoff_callbacks,tracing,skills,security_config)checkpointparam documented and linked to new sectioncheckpoint=Truequick-start code exampleCrew.from_checkpoint()resume pattern documentedCheckpointConfigattributes tableNote
Low Risk
Docs-only change that adds missing public
Crewparameters and usage guidance; low risk aside from potential for minor inaccuracies in examples/option descriptions.Overview
Updates
docs/en/concepts/crews.mdxto document previously missingCrewconstructor options, adding rows forchat_llm, kickoff callback lists,tracing,skills,security_config, andcheckpoint.Adds a new Checkpointing section with quick-start and advanced
CheckpointConfigexamples, resume flow viaCrew.from_checkpoint(), and a small attribute table describing checkpoint configuration fields.Reviewed by Cursor Bugbot for commit 2b46d01. Bugbot is set up for automated code reviews on this repo. Configure here.