Skip to content

Commit

Permalink
Docs minor fixes (#1035)
Browse files Browse the repository at this point in the history
* Minor fixes and updates

* minor fixes across docs

---------

Co-authored-by: theCyberTech <mattrapidb@gmail.com>
  • Loading branch information
theCyberTech and theCyberTech authored Aug 2, 2024
1 parent 8118b7b commit 09f9212
Show file tree
Hide file tree
Showing 6 changed files with 9 additions and 9 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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):
Expand Down
3 changes: 2 additions & 1 deletion docs/how-to/Create-Custom-Tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/how-to/Force-Tool-Ouput-as-Result.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)],
)
Expand Down
4 changes: 2 additions & 2 deletions docs/tools/CodeInterpreterTool.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
4 changes: 2 additions & 2 deletions docs/tools/ComposioTool.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand Down
3 changes: 1 addition & 2 deletions docs/tools/SerperDevTool.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 09f9212

Please sign in to comment.