From 2e3646cc96722d9b5afd5131dc5f5efccc6f4150 Mon Sep 17 00:00:00 2001 From: Taleb <76521427+rumble773@users.noreply.github.com> Date: Wed, 3 Jul 2024 21:26:32 +0300 Subject: [PATCH] Improved documentation for training module usage (#860) - Added detailed steps for training the crew programmatically. - Clarified the distinction between using the CLI and programmatic approaches. This update makes it easier for users to understand how to train their crew both through the CLI and programmatically, whether using a UI or API endpoints. Again Thank you to the author for the great project and the excellent foundation provided! --- docs/core-concepts/Training-Crew.md | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/docs/core-concepts/Training-Crew.md b/docs/core-concepts/Training-Crew.md index 3e08b1072..1fae7ff4d 100644 --- a/docs/core-concepts/Training-Crew.md +++ b/docs/core-concepts/Training-Crew.md @@ -8,6 +8,7 @@ The training feature in CrewAI allows you to train your AI agents using the comm During training, CrewAI utilizes techniques to optimize the performance of your agents along with human feedback. This helps the agents improve their understanding, decision-making, and problem-solving abilities. +### Training Your Crew Using the CLI To use the training feature, follow these steps: 1. Open your terminal or command prompt. @@ -18,7 +19,26 @@ To use the training feature, follow these steps: crewai train -n ``` -Replace `` with the desired number of training iterations. This determines how many times the agents will go through the training process. +### Training Your Crew Programmatically +To train your crew programmatically, use the following steps: + +1. Define the number of iterations for training. +2. Specify the input parameters for the training process. +3. Execute the training command within a try-except block to handle potential errors. + +```python + n_iterations = 2 + inputs = {"topic": "CrewAI Training"} + + try: + YourCrewName_Crew().crew().train(n_iterations= n_iterations, inputs=inputs) + + except Exception as e: + raise Exception(f"An error occurred while training the crew: {e}") +``` + +!!! note "Replace `` with the desired number of training iterations. This determines how many times the agents will go through the training process." + ### Key Points to Note: - **Positive Integer Requirement:** Ensure that the number of iterations (`n_iterations`) is a positive integer. The code will raise a `ValueError` if this condition is not met.