From 42b5c4664d7acae72cd536a17a2a3d8a993c08fc Mon Sep 17 00:00:00 2001 From: Kye Date: Mon, 6 Nov 2023 12:56:17 -0500 Subject: [PATCH] docs clean up -> corporate folder Former-commit-id: 881ec11f07e786c50ad631ac5a527d0cc3c61742 --- docs/{ => corporate}/architecture.md | 0 docs/{ => corporate}/bounties.md | 0 docs/{ => corporate}/checklist.md | 0 docs/{ => corporate}/cost_analysis.md | 0 docs/{ => corporate}/demos.md | 0 docs/{ => corporate}/design.md | 0 docs/{ => corporate}/distribution.md | 0 docs/{ => corporate}/failures.md | 0 docs/{ => corporate}/faq.md | 0 docs/{ => corporate}/flywheel.md | 0 docs/{ => corporate}/hiring.md | 0 docs/{ => corporate}/metric.md | 0 docs/{ => corporate}/purpose.md | 0 docs/{ => corporate}/research.md | 0 docs/{ => corporate}/roadmap.md | 0 docs/examples/ideas.md | 63 +++++++++++++++++++++++++++ docs/swarms/models/fuyu.md | 7 --- docs/swarms/swarms/groupchat.md | 0 mkdocs.yml | 30 +++++++------ swarms/utils/code_interpreter.py | 11 ++++- 20 files changed, 89 insertions(+), 22 deletions(-) rename docs/{ => corporate}/architecture.md (100%) rename docs/{ => corporate}/bounties.md (100%) rename docs/{ => corporate}/checklist.md (100%) rename docs/{ => corporate}/cost_analysis.md (100%) rename docs/{ => corporate}/demos.md (100%) rename docs/{ => corporate}/design.md (100%) rename docs/{ => corporate}/distribution.md (100%) rename docs/{ => corporate}/failures.md (100%) rename docs/{ => corporate}/faq.md (100%) rename docs/{ => corporate}/flywheel.md (100%) rename docs/{ => corporate}/hiring.md (100%) rename docs/{ => corporate}/metric.md (100%) rename docs/{ => corporate}/purpose.md (100%) rename docs/{ => corporate}/research.md (100%) rename docs/{ => corporate}/roadmap.md (100%) create mode 100644 docs/examples/ideas.md create mode 100644 docs/swarms/swarms/groupchat.md diff --git a/docs/architecture.md b/docs/corporate/architecture.md similarity index 100% rename from docs/architecture.md rename to docs/corporate/architecture.md diff --git a/docs/bounties.md b/docs/corporate/bounties.md similarity index 100% rename from docs/bounties.md rename to docs/corporate/bounties.md diff --git a/docs/checklist.md b/docs/corporate/checklist.md similarity index 100% rename from docs/checklist.md rename to docs/corporate/checklist.md diff --git a/docs/cost_analysis.md b/docs/corporate/cost_analysis.md similarity index 100% rename from docs/cost_analysis.md rename to docs/corporate/cost_analysis.md diff --git a/docs/demos.md b/docs/corporate/demos.md similarity index 100% rename from docs/demos.md rename to docs/corporate/demos.md diff --git a/docs/design.md b/docs/corporate/design.md similarity index 100% rename from docs/design.md rename to docs/corporate/design.md diff --git a/docs/distribution.md b/docs/corporate/distribution.md similarity index 100% rename from docs/distribution.md rename to docs/corporate/distribution.md diff --git a/docs/failures.md b/docs/corporate/failures.md similarity index 100% rename from docs/failures.md rename to docs/corporate/failures.md diff --git a/docs/faq.md b/docs/corporate/faq.md similarity index 100% rename from docs/faq.md rename to docs/corporate/faq.md diff --git a/docs/flywheel.md b/docs/corporate/flywheel.md similarity index 100% rename from docs/flywheel.md rename to docs/corporate/flywheel.md diff --git a/docs/hiring.md b/docs/corporate/hiring.md similarity index 100% rename from docs/hiring.md rename to docs/corporate/hiring.md diff --git a/docs/metric.md b/docs/corporate/metric.md similarity index 100% rename from docs/metric.md rename to docs/corporate/metric.md diff --git a/docs/purpose.md b/docs/corporate/purpose.md similarity index 100% rename from docs/purpose.md rename to docs/corporate/purpose.md diff --git a/docs/research.md b/docs/corporate/research.md similarity index 100% rename from docs/research.md rename to docs/corporate/research.md diff --git a/docs/roadmap.md b/docs/corporate/roadmap.md similarity index 100% rename from docs/roadmap.md rename to docs/corporate/roadmap.md diff --git a/docs/examples/ideas.md b/docs/examples/ideas.md new file mode 100644 index 00000000..a0a9c9b7 --- /dev/null +++ b/docs/examples/ideas.md @@ -0,0 +1,63 @@ +# 2O+ Autonomous Agent Blogs + +1. **The Ultimate Guide to Deploying Production-Ready Autonomous Agents with Swarms** + - A comprehensive start-to-finish guide on implementing Swarms in a production environment. + +2. **5 Steps to Elevate Your AI with Swarms Multi-Modal Autonomous Agents** + - A walkthrough highlighting the simplicity of Swarms’ setup and deployment for various AI applications. + +3. **Integrating Swarms Into Your Enterprise Workflow: A Step-By-Step Tutorial** + - A practical guide focusing on integrating Swarms into existing enterprise systems. + +4. **Swarms’ Flow: Streamlining AI Deployment in Your Business** + - Exploring the benefits and technicalities of using the Flow feature to simplify complex AI workflows. + +5. **From Zero to Hero: Building Your First Enterprise-Grade AI Agent with Swarms** + - A beginner-friendly walkthrough for building and deploying an AI agent using Swarms. + +6. **Scaling AI with Swarms: Managing Multi-Agent Systems Efficiently** + - Strategies and best practices for scaling multi-agent systems in enterprise settings. + +7. **Creating Resilient AI Systems with Swarms' Autonomous Agents** + - Discussing the robustness of Swarms agents and how they maintain performance under stress. + +8. **Unlocking New Capabilities: Advanced Features of Swarms for AI Engineers** + - Diving into the more sophisticated features of Swarms and how they can be leveraged in complex projects. + +9. **Swarms’ Quick Wins: Implementing AI Agents in Less Than 5 Lines of Code** + - A focused guide on rapidly deploying functional AI agents with minimal coding. + +10. **Benchmarking Your AI: Performance Metrics with Swarms** + - How to use Swarms to measure and optimize the performance of AI agents. + +11. **Swarms Case Studies: Real-World Success Stories from AI Engineers** + - Sharing stories and testimonials of how various organizations successfully implemented Swarms. + +12. **Effortless Multi-Modal Model Deployment: A Swarms Walkthrough** + - Explaining how to use Swarms to deploy multi-modal models with ease. + +13. **Future-Proof Your AI: Adapting to New Tech with Swarms** + - How Swarms' flexible architecture allows for easy updates and adaptation to new AI technologies. + +14. **Enterprise AI Security: Ensuring Your Swarms Agents are Hack-Proof** + - Best practices for securing autonomous agents in enterprise applications. + +15. **Migrating to Swarms: Transitioning From Legacy Systems** + - A guide for AI engineers on migrating existing AI systems to Swarms without downtime. + +16. **Multi-Agent Collaboration: How Swarms Facilitates Teamwork Among AI** + - An insight into how Swarms allows for multiple AI agents to work together seamlessly. + +17. **The Engineer's Toolkit: Swarms' Features Every AI Developer Must Know** + - Highlighting the most useful tools and features of Swarms from an AI developer’s perspective. + +18. **Swarms for Different Industries: Customizing AI Agents for Niche Markets** + - Exploring how Swarms can be tailored to fit the needs of various industries such as healthcare, finance, and retail. + +19. **Building Intelligent Workflows with Swarms’ Flow** + - A tutorial on using the Flow feature to create intelligent, responsive AI-driven workflows. + +20. **Troubleshooting Common Issues When Deploying Swarms Autonomous Agents** + - A problem-solving guide for AI engineers on overcoming common challenges when implementing Swarms agents. + +Each blog or walkthrough can be structured to not only showcase the functionality and benefits of the Swarms framework but also to establish the brand as a thought leader in the space of enterprise AI solutions. \ No newline at end of file diff --git a/docs/swarms/models/fuyu.md b/docs/swarms/models/fuyu.md index e342e51e..021469e8 100644 --- a/docs/swarms/models/fuyu.md +++ b/docs/swarms/models/fuyu.md @@ -42,13 +42,6 @@ from swarms.models import Fuyu fuyu = Fuyu() ``` -### Example 1 - Initialization - -```python -from swarms.models import Fuyu - -fuyu = Fuyu() -``` 2. Generate Text with Fuyu: diff --git a/docs/swarms/swarms/groupchat.md b/docs/swarms/swarms/groupchat.md new file mode 100644 index 00000000..e69de29b diff --git a/mkdocs.yml b/mkdocs.yml index e3c93d94..aff83631 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -67,6 +67,7 @@ nav: - AbstractSwarm: "swarms/swarms/abstractswarm.md" - AutoScaler: "swarms/swarms/autoscaler.md" - GodMode: "swarms/swarms/godmode.md" + - Groupchat: "swarms/swarms/groupchat.md" - swarms.workers: - AbstractWorker: "swarms/workers/base.md" - Overview: "swarms/workers/index.md" @@ -114,23 +115,24 @@ nav: - Worker: - Basic: "examples/worker.md" - StackedWorker: "examples/stacked_worker.md" + - 2O+ Autonomous Agent Blogs: "examples/ideas.md" - Applications: - CustomerSupport: - Overview: "applications/customer_support.md" - Marketing: - Overview: "applications/marketing_agencies.md" - Corporate: - - FAQ: "faq.md" - - Purpose: "purpose.md" - - Roadmap: "roadmap.md" - - Weaknesses: "failures.md" - - Design: "design.md" - - Flywheel: "flywheel.md" - - Bounties: "bounties.md" - - Metric: "metric.md" - - Distribution: "distribution" - - Research: "research.md" - - Demos: "demos.md" - - Architecture: "architecture.md" - - Checklist: "checklist.md" - - Hiring: "hiring.md" \ No newline at end of file + - FAQ: "corporate/faq.md" + - Purpose: "corporate/purpose.md" + - Roadmap: "corporate/roadmap.md" + - Weaknesses: "corporate/failures.md" + - Design: "corporate/design.md" + - Flywheel: "corporate/flywheel.md" + - Bounties: "corporate/bounties.md" + - Metric: "corporate/metric.md" + - Distribution: "corporate/distribution" + - Research: "corporate/research.md" + - Demos: "corporate/demos.md" + - Architecture: "corporate/architecture.md" + - Checklist: "corporate/checklist.md" + - Hiring: "corporate/hiring.md" diff --git a/swarms/utils/code_interpreter.py b/swarms/utils/code_interpreter.py index cf557385..af6eb327 100644 --- a/swarms/utils/code_interpreter.py +++ b/swarms/utils/code_interpreter.py @@ -24,7 +24,16 @@ class SubprocessCodeInterpreter(BaseCodeInterpreter): """ SubprocessCodeinterpreter is a base class for code interpreters that run code in a subprocess. - + + Attributes: + start_cmd (str): The command to start the subprocess. Should be a string that can be split by spaces. + process (subprocess.Popen): The subprocess that is running the code. + debug_mode (bool): Whether to print debug statements. + output_queue (queue.Queue): A queue that is filled with output from the subprocess. + done (threading.Event): An event that is set when the subprocess is done running code. + + Example: + >>> from swarms.utils.code_interpreter import SubprocessCodeInterpreter """