Skip to content

Commit

Permalink
Performed spell check across the entire documentation (#872)
Browse files Browse the repository at this point in the history
Thank you once again!
  • Loading branch information
rumble773 authored Jul 6, 2024
1 parent a41bd18 commit d2eb54e
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/core-concepts/Memory.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ description: Leveraging memory systems in the crewAI framework to enhance agent
| Component | Description |
| :------------------- | :----------------------------------------------------------- |
| **Short-Term Memory**| Temporarily stores recent interactions and outcomes, enabling agents to recall and utilize information relevant to their current context during the current executions. |
| **Long-Term Memory** | Preserves valuable insights and learnings from past executions, allowing agents to build and refine their knowledge over time. So Agents can remeber what they did right and wrong across multiple executions |
| **Long-Term Memory** | Preserves valuable insights and learnings from past executions, allowing agents to build and refine their knowledge over time. So Agents can remember what they did right and wrong across multiple executions |
| **Entity Memory** | Captures and organizes information about entities (people, places, concepts) encountered during tasks, facilitating deeper understanding and relationship mapping. |
| **Contextual Memory**| Maintains the context of interactions by combining `ShortTermMemory`, `LongTermMemory`, and `EntityMemory`, aiding in the coherence and relevance of agent responses over a sequence of tasks or a conversation. |

Expand Down
2 changes: 1 addition & 1 deletion docs/how-to/Create-Custom-Tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ To optimize tool performance with caching, define custom caching strategies usin
@tool("Tool with Caching")
def cached_tool(argument: str) -> str:
"""Tool functionality description."""
return "Cachable result"
return "Cacheable result"

def my_cache_strategy(arguments: dict, result: str) -> bool:
# Define custom caching logic
Expand Down
3 changes: 1 addition & 2 deletions docs/how-to/Creating-a-Crew-and-kick-it-off.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,5 +79,4 @@ manager = Agent(

1. `allow_code_execution`: Enable or disable code execution capabilities for the agent (default is False).
2. `max_execution_time`: Set a maximum execution time (in seconds) for the agent to complete a task.
3. `function_calling_llm`: Specify a separate language model for function calling.
4
3. `function_calling_llm`: Specify a separate language model for function calling.
2 changes: 1 addition & 1 deletion docs/tools/TXTSearchTool.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ tool = TXTSearchTool(txt='path/to/text/file.txt')
```

## Arguments
- `txt` (str): **Optinal**. The path to the text file you want to search. This argument is only required if the tool was not initialized with a specific text file; otherwise, the search will be conducted within the initially provided text file.
- `txt` (str): **Optional**. The path to the text file you want to search. This argument is only required if the tool was not initialized with a specific text file; otherwise, the search will be conducted within the initially provided text file.

## Custom model and embeddings

Expand Down

0 comments on commit d2eb54e

Please sign in to comment.