From 09f92122d506c6e8c572f538450e06867f48367f Mon Sep 17 00:00:00 2001 From: Rip&Tear <84775494+theCyberTech@users.noreply.github.com> Date: Sat, 3 Aug 2024 02:01:16 +0800 Subject: [PATCH] Docs minor fixes (#1035) * Minor fixes and updates * minor fixes across docs --------- Co-authored-by: theCyberTech --- .../Start-a-New-CrewAI-Project-Template-Method.md | 2 +- docs/how-to/Create-Custom-Tools.md | 3 ++- docs/how-to/Force-Tool-Ouput-as-Result.md | 2 +- docs/tools/CodeInterpreterTool.md | 4 ++-- docs/tools/ComposioTool.md | 4 ++-- docs/tools/SerperDevTool.md | 3 +-- 6 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/getting-started/Start-a-New-CrewAI-Project-Template-Method.md b/docs/getting-started/Start-a-New-CrewAI-Project-Template-Method.md index 71b0129c3..bc3b03a7e 100644 --- a/docs/getting-started/Start-a-New-CrewAI-Project-Template-Method.md +++ b/docs/getting-started/Start-a-New-CrewAI-Project-Template-Method.md @@ -20,7 +20,7 @@ Before getting started with CrewAI, make sure that you have installed it via pip $ pip install crewai crewai-tools ``` -### Virtual Environemnts +### Virtual Environments It is highly recommended that you use virtual environments to ensure that your CrewAI project is isolated from other projects and dependencies. Virtual environments provide a clean, separate workspace for each project, preventing conflicts between different versions of packages and libraries. This isolation is crucial for maintaining consistency and reproducibility in your development process. You have multiple options for setting up virtual environments depending on your operating system and Python version: 1. Use venv (Python's built-in virtual environment tool): diff --git a/docs/how-to/Create-Custom-Tools.md b/docs/how-to/Create-Custom-Tools.md index c5e260687..7dc1e8f07 100644 --- a/docs/how-to/Create-Custom-Tools.md +++ b/docs/how-to/Create-Custom-Tools.md @@ -7,6 +7,7 @@ description: Comprehensive guide on crafting, using, and managing custom tools w This guide provides detailed instructions on creating custom tools for the crewAI framework and how to efficiently manage and utilize these tools, incorporating the latest functionalities such as tool delegation, error handling, and dynamic tool calling. It also highlights the importance of collaboration tools, enabling agents to perform a wide range of actions. ### Prerequisites + Before creating your own tools, ensure you have the crewAI extra tools package installed: ```bash @@ -31,7 +32,7 @@ class MyCustomTool(BaseTool): ### Using the `tool` Decorator -Alternatively, use the `tool` decorator for a direct approach to create tools. This requires specifying attributes and the tool's logic within a function. +Alternatively, you can use the tool decorator `@tool`. This approach allows you to define the tool's attributes and functionality directly within a function, offering a concise and efficient way to create specialized tools tailored to your needs. ```python from crewai_tools import tool diff --git a/docs/how-to/Force-Tool-Ouput-as-Result.md b/docs/how-to/Force-Tool-Ouput-as-Result.md index 15c60f80b..ee812df23 100644 --- a/docs/how-to/Force-Tool-Ouput-as-Result.md +++ b/docs/how-to/Force-Tool-Ouput-as-Result.md @@ -16,7 +16,7 @@ Here's an example of how to force the tool output as the result of an agent's ta # Define a custom tool that returns the result as the answer coding_agent =Agent( role="Data Scientist", - goal="Product amazing resports on AI", + goal="Product amazing reports on AI", backstory="You work with data and AI", tools=[MyCustomTool(result_as_answer=True)], ) diff --git a/docs/tools/CodeInterpreterTool.md b/docs/tools/CodeInterpreterTool.md index cb1bf3ad8..94fe6bd96 100644 --- a/docs/tools/CodeInterpreterTool.md +++ b/docs/tools/CodeInterpreterTool.md @@ -1,9 +1,9 @@ # CodeInterpreterTool ## Description -This tool is used to give the Agent the ability to run code (Python3) from the code generated by the Agent itself. The code is executed in a sandboxed environment, so it is safe to run any code. +This tool enables the Agent to execute Python 3 code that it has generated autonomously. The code is run in a secure, isolated environment, ensuring safety regardless of the content. -It is incredible useful since it allows the Agent to generate code, run it in the same environment, get the result and use it to make decisions. +This functionality is particularly valuable as it allows the Agent to create code, execute it within the same ecosystem, obtain the results, and utilize that information to inform subsequent decisions and actions. ## Requirements diff --git a/docs/tools/ComposioTool.md b/docs/tools/ComposioTool.md index eeb233be5..929796de8 100644 --- a/docs/tools/ComposioTool.md +++ b/docs/tools/ComposioTool.md @@ -2,7 +2,7 @@ ## Description -This tools is a wrapper around the composio toolset and gives your agent access to a wide variety of tools from the composio SDK. +This tools is a wrapper around the composio set of tools and gives your agent access to a wide variety of tools from the composio SDK. ## Installation @@ -19,7 +19,7 @@ after the installation is complete, either run `composio login` or export your c The following example demonstrates how to initialize the tool and execute a github action: -1. Initialize toolset +1. Initialize Composio tools ```python from composio import App diff --git a/docs/tools/SerperDevTool.md b/docs/tools/SerperDevTool.md index 539906f20..9fbdb8f3b 100644 --- a/docs/tools/SerperDevTool.md +++ b/docs/tools/SerperDevTool.md @@ -40,10 +40,9 @@ The `SerperDevTool` comes with several parameters that will be passed to the API - **locale**: Optional. Specify the locale for the search results. - **n_results**: Number of search results to return. Default is `10`. -The values for `country`, `location`, `lovale` and `search_url` can be found on the [Serper Playground](https://serper.dev/playground). +The values for `country`, `location`, `locale` and `search_url` can be found on the [Serper Playground](https://serper.dev/playground). ## Example with Parameters - Here is an example demonstrating how to use the tool with additional parameters: ```python