Merge branch 'master' into tool-flow

.gitignore

@@ -28,6 +28,7 @@ error.txt
 
 # C extensions
 *.so
+.ruff_cache
 
 
 errors.txt

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[email protected].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -100,6 +100,35 @@ You can learn more about mkdocs on the [mkdocs website](https://www.mkdocs.org/)
 - Run all the tests in the tests folder
 `find ./tests -name '*.py' -exec pytest {} \;`
 
+## Code Quality
+`quality.sh` runs 4 different code formatters for ultra reliable code cleanup using Autopep8, Black, Ruff, YAPF
+1. Open your terminal.
+
+2. Change directory to where `quality.sh` is located using `cd` command:
+   ```sh
+   cd /path/to/directory
+   ```
+
+3. Make sure the script has execute permissions:
+   ```sh
+   chmod +x code_quality.sh
+   ```
+
+4. Run the script:
+   ```sh
+   ./quality.sh
+   ```
+
+If the script requires administrative privileges, you might need to run it with `sudo`:
+```sh
+sudo ./quality.sh
+```
+
+Please replace `/path/to/directory` with the actual path where the `quality.sh` script is located on your system.
+
+If you're asking for a specific content or functionality inside `quality.sh` related to YAPF or other code quality tools, you would need to edit the `quality.sh` script to include the desired commands, such as running YAPF on a directory. The contents of `quality.sh` would dictate exactly what happens when you run it.
+
+
 ## 📄 license
 
 By contributing, you agree that your contributions will be licensed under an [MIT license](https://github.com/kyegomez/swarms/blob/develop/LICENSE.md).

Dockerfile

@@ -0,0 +1,42 @@
+
+# ==================================
+# Use an official Python runtime as a parent image
+FROM python:3.9-slim
+
+# Set environment variables
+ENV PYTHONDONTWRITEBYTECODE 1
+ENV PYTHONUNBUFFERED 1
+
+# Set the working directory in the container
+WORKDIR /usr/src/swarm_cloud
+
+
+# Install Python dependencies
+# COPY requirements.txt and pyproject.toml if you're using poetry for dependency management
+COPY requirements.txt .
+RUN pip install --upgrade pip
+RUN pip install --no-cache-dir -r requirements.txt
+
+# Install the 'swarms' package, assuming it's available on PyPI
+RUN pip install swarms
+
+# Copy the rest of the application
+COPY . .
+
+# Add entrypoint script if needed
+# COPY ./entrypoint.sh .
+# RUN chmod +x /usr/src/swarm_cloud/entrypoint.sh
+
+# Expose port if your application has a web interface
+# EXPOSE 5000
+
+# # Define environment variable for the swarm to work
+# ENV SWARM_API_KEY=your_swarm_api_key_here
+
+# # Add Docker CMD or ENTRYPOINT script to run the application
+# CMD python your_swarm_startup_script.py
+# Or use the entrypoint script if you have one
+# ENTRYPOINT ["/usr/src/swarm_cloud/entrypoint.sh"]
+
+# If you're using `CMD` to execute a Python script, make sure it's executable
+# RUN chmod +x your_swarm_startup_script.py

README.md

@@ -39,7 +39,9 @@ Book a [1-on-1 Session with Kye](https://calendly.com/swarm-corp/30min), the Cre
 We have a small gallery of examples to run here, [for more check out the docs to build your own agent and or swarms!](https://docs.apac.ai)
 
 ### `Flow` Example
-- The `Flow` is a superior iteratioin of the `LLMChain` from Langchain, our intent with `Flow` is to create the most reliable loop structure that gives the agents their "autonomy" through 3 main methods of interaction, one through user specified loops, then dynamic where the agent parses a <DONE> token, and or an interactive human input verison, or a mix of all 3. 
+- Reliable Structure that provides LLMS autonomy
+- Extremely Customizeable with stopping conditions, interactivity, dynamical temperature, loop intervals, and so much more
+- Enterprise Grade + Production Grade: `Flow` is designed and optimized for automating real-world tasks at scale!
 
 ```python
 
@@ -86,9 +88,10 @@ out = flow.run("Generate a 10,000 word blog on health and wellness.")
 ------
 
 ### `SequentialWorkflow`
-- Execute tasks step by step by passing in an LLM and the task description!
-- Pass in flows with various LLMs
-- Save and restore Workflow states!
+- A Sequential swarm of autonomous agents where each agent's outputs are fed into the next agent
+- Save and Restore Workflow states!
+- Integrate Flow's with various LLMs and Multi-Modality Models
+
 ```python
 from swarms.models import OpenAIChat
 from swarms.structs import Flow
@@ -130,7 +133,6 @@ for task in workflow.tasks:
 
 ```
 
-
 ---
 
 ## Documentation
@@ -140,6 +142,9 @@ for task in workflow.tasks:
 ## Contribute
 - We're always looking for contributors to help us improve and expand this project. If you're interested, please check out our [Contributing Guidelines](CONTRIBUTING.md) and our [contributing board](https://github.com/users/kyegomez/projects/1)
 
+## Community
+- [Join the Swarms community here on Discord!](https://discord.gg/AJazBmhKnr)
+
 
 # License
 MIT

SECURITY.md

@@ -0,0 +1,32 @@
+# Security Policy
+===============
+
+## Supported Versions
+------------------
+
+* * * * *
+
+| Version | Supported |
+| --- | --- |
+| 2.0.5 | :white_check_mark: |
+| 2.0.4 | :white_check_mark: |
+| 2.0.3 | :white_check_mark: |
+| 2.0.2 | :white_check_mark: |
+| 2.0.1 | :white_check_mark: |
+| 2.0.0 | :white_check_mark: |
+
+# Reporting a Vulnerability
+-------------------------
+
+* * * * *
+
+If you discover a security vulnerability in any of the above versions, please report it immediately to our security team by sending an email to [email protected]. We take security vulnerabilities seriously and appreciate your efforts in disclosing them responsibly.
+
+Please provide detailed information on the vulnerability, including steps to reproduce, potential impact, and any known mitigations. Our security team will acknowledge receipt of your report within 24 hours and will provide regular updates on the progress of the investigation.
+
+Once the vulnerability has been thoroughly assessed, we will take the necessary steps to address it. This may include releasing a security patch, issuing a security advisory, or implementing other appropriate mitigations.
+
+We aim to respond to all vulnerability reports in a timely manner and work towards resolving them as quickly as possible. We thank you for your contribution to the security of our software.
+
+Please note that any vulnerability reports that are not related to the specified versions or do not provide sufficient information may be declined.
+

code_quality.sh

@@ -0,0 +1,19 @@
+#!/bin/bash
+
+# Navigate to the directory containing the 'swarms' folder
+# cd /path/to/your/code/directory
+
+# Run autopep8 with max aggressiveness (-aaa) and in-place modification (-i)
+# on all Python files (*.py) under the 'swarms' directory.
+autopep8 --in-place --aggressive --aggressive --recursive --experimental --list-fixes swarms/
+
+# Run black with default settings, since black does not have an aggressiveness level.
+# Black will format all Python files it finds in the 'swarms' directory.
+black --experimental-string-processing swarms/
+
+# Run ruff on the 'swarms' directory.
+# Add any additional flags if needed according to your version of ruff.
+ruff swarms/
+
+# YAPF
+yapf --recursive --in-place --verbose --style=google --parallel swarms

demos/accountant_team/accountant_team.py

@@ -0,0 +1,35 @@
+import re
+from swarms.models.nougat import Nougat
+from swarms.structs import Flow
+from swarms.models import OpenAIChat
+from swarms.models import LayoutLMDocumentQA
+
+# # URL of the image of the financial document
+IMAGE_OF_FINANCIAL_DOC_URL = "bank_statement_2.jpg"
+
+# Example usage
+api_key = ""
+
+# Initialize the language flow
+llm = OpenAIChat(
+    openai_api_key=api_key,
+)
+
+# LayoutLM Document QA
+pdf_analyzer = LayoutLMDocumentQA()
+
+question = "What is the total amount of expenses?"
+answer = pdf_analyzer(
+    question,
+    IMAGE_OF_FINANCIAL_DOC_URL,
+)
+
+# Initialize the Flow with the language flow
+agent = Flow(llm=llm)
+SUMMARY_AGENT_PROMPT = f"""
+Generate an actionable summary of this financial document be very specific and precise, provide bulletpoints be very specific provide methods of lowering expenses: {answer}"
+"""
+
+# Add tasks to the workflow
+summary_agent = agent.run(SUMMARY_AGENT_PROMPT)
+print(summary_agent)

demos/ui_software_demo.py

@@ -0,0 +1,5 @@
+"""
+Autonomous swarm that optimizes UI autonomously
+
+GPT4Vision ->> GPT4 ->> UI
+"""