docs clean up -> corporate folder

kyegomez · Nov 6, 2023 · 881ec11 · 881ec11
1 parent c520cda
commit 881ec11
Show file tree

Hide file tree

Showing 20 changed files with 89 additions and 22 deletions.
diff --git a/docs/architecture.md → docs/corporate/architecture.md b/docs/architecture.md → docs/corporate/architecture.md
diff --git a/docs/bounties.md → docs/corporate/bounties.md b/docs/bounties.md → docs/corporate/bounties.md
diff --git a/docs/checklist.md → docs/corporate/checklist.md b/docs/checklist.md → docs/corporate/checklist.md
diff --git a/docs/cost_analysis.md → docs/corporate/cost_analysis.md b/docs/cost_analysis.md → docs/corporate/cost_analysis.md
diff --git a/docs/demos.md → docs/corporate/demos.md b/docs/demos.md → docs/corporate/demos.md
diff --git a/docs/design.md → docs/corporate/design.md b/docs/design.md → docs/corporate/design.md
diff --git a/docs/distribution.md → docs/corporate/distribution.md b/docs/distribution.md → docs/corporate/distribution.md
diff --git a/docs/failures.md → docs/corporate/failures.md b/docs/failures.md → docs/corporate/failures.md
diff --git a/docs/faq.md → docs/corporate/faq.md b/docs/faq.md → docs/corporate/faq.md
diff --git a/docs/flywheel.md → docs/corporate/flywheel.md b/docs/flywheel.md → docs/corporate/flywheel.md
diff --git a/docs/hiring.md → docs/corporate/hiring.md b/docs/hiring.md → docs/corporate/hiring.md
diff --git a/docs/metric.md → docs/corporate/metric.md b/docs/metric.md → docs/corporate/metric.md
diff --git a/docs/purpose.md → docs/corporate/purpose.md b/docs/purpose.md → docs/corporate/purpose.md
diff --git a/docs/research.md → docs/corporate/research.md b/docs/research.md → docs/corporate/research.md
diff --git a/docs/roadmap.md → docs/corporate/roadmap.md b/docs/roadmap.md → docs/corporate/roadmap.md
diff --git a/docs/examples/ideas.md 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.
diff --git 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
diff --git 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"
+    - 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
@@ -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
 
     """