From 96d8e820a171a6586e32f26b4ae8314c43ac8ac4 Mon Sep 17 00:00:00 2001 From: Nick Bobrowski <39348559+bonk1t@users.noreply.github.com> Date: Fri, 22 Nov 2024 00:40:28 +0000 Subject: [PATCH] Remove language="..." --- docs_new/advanced-topics/asynchronous-execution.mdx | 5 ++--- .../customizing-prompts-and-few-shot-learning.mdx | 6 +++--- .../advanced-topics/open-source-models-support.mdx | 10 +++++----- docs_new/contributing/contributing.mdx | 11 ++++++----- docs_new/faq/faq.mdx | 2 +- docs_new/getting-started/installation.mdx | 6 +++--- 6 files changed, 20 insertions(+), 20 deletions(-) diff --git a/docs_new/advanced-topics/asynchronous-execution.mdx b/docs_new/advanced-topics/asynchronous-execution.mdx index 5b6522fc..a5856682 100644 --- a/docs_new/advanced-topics/asynchronous-execution.mdx +++ b/docs_new/advanced-topics/asynchronous-execution.mdx @@ -12,7 +12,7 @@ Asynchronous execution allows agents and tools to operate concurrently, improvin To enable asynchronous execution for agents, set the `async_mode` parameter to `"threading"` when initializing the agency. - + ```python agency = Agency(agents=[ceo], async_mode='threading') ``` @@ -27,7 +27,7 @@ agency = Agency(agents=[ceo], async_mode='threading') To enable asynchronous execution for tools, set the `async_mode` parameter to `"tools_threading"`. - + ```python agency = Agency(agents=[ceo], async_mode='tools_threading') ``` @@ -47,4 +47,3 @@ When using asynchronous execution, be mindful of concurrency issues. - **Concurrency Control**: Ensure thread-safe operations to prevent race conditions. Use thread locks or other synchronization mechanisms if necessary. - **Resource Management**: Monitor system resources to avoid overconsumption due to multiple threads. Keep an eye on CPU and memory usage. - \ No newline at end of file diff --git a/docs_new/advanced-topics/customizing-prompts-and-few-shot-learning.mdx b/docs_new/advanced-topics/customizing-prompts-and-few-shot-learning.mdx index b03a5b0a..8976209b 100644 --- a/docs_new/advanced-topics/customizing-prompts-and-few-shot-learning.mdx +++ b/docs_new/advanced-topics/customizing-prompts-and-few-shot-learning.mdx @@ -16,7 +16,7 @@ Custom prompts and few-shot learning help your agents understand the desired res Adjust the `instructions.md` file associated with your agent to change how it responds. - + ```markdown # Agent Instructions @@ -28,7 +28,7 @@ You are a friendly assistant that helps users with booking flights and hotels. Programmatically alter prompts based on context or user input. - + ```python base_instructions = "You are an assistant who provides technical support." @@ -47,7 +47,7 @@ Few-shot examples provide sample interactions to guide agent responses. ### Implementation - + ```python examples = [ {"role": "user", "content": "Hi!"}, diff --git a/docs_new/advanced-topics/open-source-models-support.mdx b/docs_new/advanced-topics/open-source-models-support.mdx index cc71ceab..9dbdaf28 100644 --- a/docs_new/advanced-topics/open-source-models-support.mdx +++ b/docs_new/advanced-topics/open-source-models-support.mdx @@ -31,7 +31,7 @@ Fully local and stable, supports Assistants API V1. Use pip to install necessary packages. - + ```bash pip install astra-assistants-api gradio ``` @@ -41,7 +41,7 @@ pip install astra-assistants-api gradio Configure your API clients to use the open-source models. - + ```python from openai import OpenAI from astra_assistants import patch @@ -55,7 +55,7 @@ set_openai_client(client) Instantiate your agents using the open-source models. - + ```python ceo = Agent(name="CEO", model='ollama/llama3') ``` @@ -65,7 +65,7 @@ ceo = Agent(name="CEO", model='ollama/llama3') Start your agency with the configured agents. - + ```python agency = Agency([ceo]) agency.run_demo() @@ -83,4 +83,4 @@ Be aware of the limitations when using open-source models. - **Function Calling**: Not supported by most open-source models. - **Retrieval-Augmented Generation**: Often limited; consider custom implementations. -- **Code Interpreter**: Not supported in current open-source assistants. \ No newline at end of file +- **Code Interpreter**: Not supported in current open-source assistants. diff --git a/docs_new/contributing/contributing.mdx b/docs_new/contributing/contributing.mdx index aeb33b5f..b3461f41 100644 --- a/docs_new/contributing/contributing.mdx +++ b/docs_new/contributing/contributing.mdx @@ -127,7 +127,7 @@ Thorough testing ensures that your contributions are reliable and integrate seam - **Location**: Place tests in the `agency_swarm/tests/` directory, specifically within `test_tools.py` or relevant test files based on the component. - + ```python def test_my_custom_tool(): tool = MyCustomTool(example_field="test value") @@ -151,7 +151,7 @@ Create a fork of the Agency Swarm repository on GitHub. Work on a feature branch for your changes. - + ```bash git checkout -b feature/your-feature-name ``` @@ -161,7 +161,7 @@ git checkout -b feature/your-feature-name Commit your changes with clear and descriptive messages. - + ```bash git add . git commit -m "Add [feature]: Description of the feature" @@ -172,7 +172,7 @@ git commit -m "Add [feature]: Description of the feature" Push your changes to your forked repository. - + ```bash git push origin feature/your-feature-name ``` @@ -182,7 +182,8 @@ git push origin feature/your-feature-name Describe your changes and submit a pull request for review. - + +```markdown - Provide a clear title and description for your pull request. - Reference any related issues. - Ensure all tests pass and coverage remains adequate. diff --git a/docs_new/faq/faq.mdx b/docs_new/faq/faq.mdx index 0e318231..969508ad 100644 --- a/docs_new/faq/faq.mdx +++ b/docs_new/faq/faq.mdx @@ -15,7 +15,7 @@ Find answers to common questions about Agency Swarm. **A**: Install via pip using: - + ```bash pip install agency-swarm ``` diff --git a/docs_new/getting-started/installation.mdx b/docs_new/getting-started/installation.mdx index 1beb6384..7270e25c 100644 --- a/docs_new/getting-started/installation.mdx +++ b/docs_new/getting-started/installation.mdx @@ -16,7 +16,7 @@ Set up Agency Swarm in a few simple steps. - + ```bash pip install agency-swarm ``` @@ -25,7 +25,7 @@ pip install agency-swarm - + ```bash python -c "import agency_swarm; print('Agency Swarm is installed successfully.')" ``` @@ -34,7 +34,7 @@ python -c "import agency_swarm; print('Agency Swarm is installed successfully.') - + ```python from agency_swarm import Agent, Agency