From 932075e716b53981ec4c1a24e1b63b50b13fee3a Mon Sep 17 00:00:00 2001 From: fzowl Date: Fri, 10 Jan 2025 02:53:34 +0100 Subject: [PATCH] Adding the whitespaces back --- docs/concepts/knowledge.mdx | 10 +++++----- docs/concepts/memory.mdx | 12 ++++++------ docs/how-to/llm-connections.mdx | 4 ++-- 3 files changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/concepts/knowledge.mdx b/docs/concepts/knowledge.mdx index b56a28577..9d5825c09 100644 --- a/docs/concepts/knowledge.mdx +++ b/docs/concepts/knowledge.mdx @@ -91,7 +91,7 @@ result = crew.kickoff(inputs={"question": "What city does John live in and how o ``` -Here's another example with the `CrewDoclingSource`. The CrewDoclingSource is actually quite versatile and can handle multiple file formats including TXT, PDF, DOCX, HTML, and more. +Here's another example with the `CrewDoclingSource`. The CrewDoclingSource is actually quite versatile and can handle multiple file formats including TXT, PDF, DOCX, HTML, and more. ```python Code from crewai import LLM, Agent, Crew, Process, Task @@ -253,7 +253,7 @@ crew = Crew( ### Chunking Configuration -Knowledge sources automatically chunk content for better processing. +Knowledge sources automatically chunk content for better processing. You can configure chunking behavior in your knowledge sources: ```python @@ -273,7 +273,7 @@ The chunking configuration helps in: ### Embeddings Configuration -You can also configure the embedder for the knowledge store. +You can also configure the embedder for the knowledge store. This is useful if you want to use a different embedder for the knowledge store than the one used for the agents. The `embedder` parameter supports various embedding model providers that include: - `openai`: OpenAI's embedding models @@ -348,7 +348,7 @@ result = crew.kickoff(inputs={"question": "What city does John live in and how o ## Task: Answer the following questions about the user: What city does John live in and how old is he? # Agent: About User -## Final Answer: +## Final Answer: John is 30 years old and lives in San Francisco. ``` @@ -604,7 +604,7 @@ recent_news = SpaceNewsKnowledgeSource( - - Adjust chunk sizes based on content complexity + - Adjust chunk sizes based on content complexity - Configure appropriate embedding models - Consider using local embedding providers for faster processing diff --git a/docs/concepts/memory.mdx b/docs/concepts/memory.mdx index 22667da56..751b6dd2e 100644 --- a/docs/concepts/memory.mdx +++ b/docs/concepts/memory.mdx @@ -6,8 +6,8 @@ icon: database ## Introduction to Memory Systems in CrewAI -The crewAI framework introduces a sophisticated memory system designed to significantly enhance the capabilities of AI agents. -This system comprises `short-term memory`, `long-term memory`, `entity memory`, and `contextual memory`, each serving a unique purpose in aiding agents to remember, +The crewAI framework introduces a sophisticated memory system designed to significantly enhance the capabilities of AI agents. +This system comprises `short-term memory`, `long-term memory`, `entity memory`, and `contextual memory`, each serving a unique purpose in aiding agents to remember, reason, and learn from past interactions. ## Memory System Components @@ -31,8 +31,8 @@ reason, and learn from past interactions. ## Implementing Memory in Your Crew When configuring a crew, you can enable and customize each memory component to suit the crew's objectives and the nature of tasks it will perform. -By default, the memory system is disabled, and you can ensure it is active by setting `memory=True` in the crew configuration. -The memory will use OpenAI embeddings by default, but you can change it by setting `embedder` to a different model. +By default, the memory system is disabled, and you can ensure it is active by setting `memory=True` in the crew configuration. +The memory will use OpenAI embeddings by default, but you can change it by setting `embedder` to a different model. It's also possible to initialize the memory instance with your own instance. The 'embedder' only applies to **Short-Term Memory** which uses Chroma for RAG. @@ -95,7 +95,7 @@ my_crew = Crew( ## Integrating Mem0 for Enhanced User Memory -[Mem0](https://mem0.ai/) is a self-improving memory layer for LLM applications, enabling personalized AI experiences. +[Mem0](https://mem0.ai/) is a self-improving memory layer for LLM applications, enabling personalized AI experiences. To include user-specific memory you can get your API key [here](https://app.mem0.ai/dashboard/api-keys) and refer the [docs](https://docs.mem0.ai/platform/quickstart#4-1-create-memories) for adding user preferences. @@ -383,5 +383,5 @@ crewai reset-memories [OPTIONS] ## Conclusion -Integrating CrewAI's memory system into your projects is straightforward. By leveraging the provided memory components and configurations, +Integrating CrewAI's memory system into your projects is straightforward. By leveraging the provided memory components and configurations, you can quickly empower your agents with the ability to remember, reason, and learn from their interactions, unlocking new levels of intelligence and capability. diff --git a/docs/how-to/llm-connections.mdx b/docs/how-to/llm-connections.mdx index 92f485fec..33be323b7 100644 --- a/docs/how-to/llm-connections.mdx +++ b/docs/how-to/llm-connections.mdx @@ -9,7 +9,7 @@ icon: brain-circuit CrewAI uses LiteLLM to connect to a wide variety of Language Models (LLMs). This integration provides extensive versatility, allowing you to use models from numerous providers with a simple, unified interface. - By default, CrewAI uses the `gpt-4o-mini` model. This is determined by the `OPENAI_MODEL_NAME` environment variable, which defaults to "gpt-4o-mini" if not set. + By default, CrewAI uses the `gpt-4o-mini` model. This is determined by the `OPENAI_MODEL_NAME` environment variable, which defaults to "gpt-4o-mini" if not set. You can easily configure your agents to use a different model or provider as described in this guide. @@ -169,7 +169,7 @@ For local models like those provided by Ollama: You can change the base API URL for any LLM provider by setting the `base_url` parameter: -```python Code +```python Code llm = LLM( model="custom-model-name", base_url="https://api.your-provider.com/v1",