From 78b46efc94c6cf9ddd3f501e688cd39e3a235b07 Mon Sep 17 00:00:00 2001 From: evelynmitchell Date: Fri, 24 Nov 2023 17:30:57 -0700 Subject: [PATCH] cicd, yamllint --- .flake8 | 2 +- .github/FUNDING.yml | 21 +-- .github/dependabot.yml | 2 +- .github/labeler.yml | 8 +- .github/workflows/code_quality_control.yml | 30 ---- .github/workflows/cos_integration.yml | 42 ----- .github/workflows/docker-image.yml | 15 +- .github/workflows/docs_test.yml | 28 ---- .../generator-generic-ossf-slsa3-publish.yml | 66 -------- .github/workflows/lint.yml | 24 ++- .github/workflows/lints.yml | 25 --- .github/workflows/makefile.yml | 27 --- .github/workflows/pr_request_checks.yml | 3 +- .github/workflows/pylint.yml | 23 --- .github/workflows/pyre.yml | 46 ----- .github/workflows/python-app.yml | 39 ----- .github/workflows/python-publish.yml | 8 +- .github/workflows/quality.yml | 23 --- .github/workflows/ruff.yml | 8 - .github/workflows/run_test.yml | 23 --- .github/workflows/test.yml | 63 ++++++- .readthedocs.yml | 3 +- .yamllint | 4 + mkdocs.yml | 157 +++++++++--------- 24 files changed, 196 insertions(+), 494 deletions(-) delete mode 100644 .github/workflows/code_quality_control.yml delete mode 100644 .github/workflows/cos_integration.yml delete mode 100644 .github/workflows/docs_test.yml delete mode 100644 .github/workflows/generator-generic-ossf-slsa3-publish.yml delete mode 100644 .github/workflows/lints.yml delete mode 100644 .github/workflows/makefile.yml delete mode 100644 .github/workflows/pylint.yml delete mode 100644 .github/workflows/pyre.yml delete mode 100644 .github/workflows/python-app.yml delete mode 100644 .github/workflows/quality.yml delete mode 100644 .github/workflows/ruff.yml delete mode 100644 .github/workflows/run_test.yml create mode 100644 .yamllint diff --git a/.flake8 b/.flake8 index d148ed3e..eedac54c 100644 --- a/.flake8 +++ b/.flake8 @@ -1,2 +1,2 @@ [flake8] -extend-ignore = E501, W292, W291 \ No newline at end of file +extend-ignore = E501, W292, W291, W293 diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml index c626b001..e3733b98 100644 --- a/.github/FUNDING.yml +++ b/.github/FUNDING.yml @@ -1,13 +1,14 @@ +--- # These are supported funding model platforms github: [kyegomez] -patreon: # Replace with a single Patreon username -open_collective: # Replace with a single Open Collective username -ko_fi: # Replace with a single Ko-fi username -tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel -community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry -liberapay: # Replace with a single Liberapay username -issuehunt: # Replace with a single IssueHunt username -otechie: # Replace with a single Otechie username -lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry -custom: #Nothing +# patreon: # Replace with a single Patreon username +# open_collective: # Replace with a single Open Collective username +# ko_fi: # Replace with a single Ko-fi username +# tidelift: # Replace with a single Tidelift platform-name/package-name +# community_bridge: # Replace with a single Community Bridge project-name +# liberapay: # Replace with a single Liberapay username +# issuehunt: # Replace with a single IssueHunt username +# otechie: # Replace with a single Otechie username +# lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name +# custom: #Nothing diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 34b75fb9..b523994a 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -1,3 +1,4 @@ +--- # https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates version: 2 @@ -11,4 +12,3 @@ updates: directory: "/" schedule: interval: "weekly" - diff --git a/.github/labeler.yml b/.github/labeler.yml index 72ccc40a..1fb9d7ec 100644 --- a/.github/labeler.yml +++ b/.github/labeler.yml @@ -1,12 +1,14 @@ +--- # this is a config file for the github action labeler # Add 'label1' to any changes within 'example' folder or any subfolders example_change: -- example/** + - example/** # Add 'label2' to any file changes within 'example2' folder example2_change: example2/* -# Add label3 to any change to .txt files within the entire repository. Quotation marks are required for the leading asterisk +# Add label3 to any change to .txt files within the entire repository. +# Quotation marks are required for the leading asterisk text_files: -- '**/*.txt' \ No newline at end of file + - '**/*.txt' diff --git a/.github/workflows/code_quality_control.yml b/.github/workflows/code_quality_control.yml deleted file mode 100644 index a0a49572..00000000 --- a/.github/workflows/code_quality_control.yml +++ /dev/null @@ -1,30 +0,0 @@ -name: Linting and Formatting - -on: - push: - branches: - - master - -jobs: - lint_and_format: - runs-on: ubuntu-latest - - steps: - - name: Checkout code - uses: actions/checkout@v4 - - - name: Set up Python - uses: actions/setup-python@v4 - with: - python-version: 3.x - - - name: Install dependencies - run: pip install -r requirements.txt - - - name: Find Python files - run: find swarms -name "*.py" -type f -exec autopep8 --in-place --aggressive --aggressive {} + - - - name: Push changes - uses: ad-m/github-push-action@master - with: - github_token: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file diff --git a/.github/workflows/cos_integration.yml b/.github/workflows/cos_integration.yml deleted file mode 100644 index 3bfb587c..00000000 --- a/.github/workflows/cos_integration.yml +++ /dev/null @@ -1,42 +0,0 @@ -name: Continuous Integration - -on: - push: - branches: - - master - -jobs: - test: - runs-on: ubuntu-latest - steps: - - name: Checkout code - uses: actions/checkout@v4 - - - name: Set up Python - uses: actions/setup-python@v4 - with: - python-version: 3.x - - - name: Install dependencies - run: pip install -r requirements.txt - - - name: Run unit tests - run: pytest tests/unit - - - name: Run integration tests - run: pytest tests/integration - - - name: Run code coverage - run: pytest --cov=swarms tests/ - - - name: Run linters - run: pylint swarms - - - name: Build documentation - run: make docs - - - name: Validate documentation - run: sphinx-build -b linkcheck docs build/docs - - - name: Run performance tests - run: find ./tests -name '*.py' -exec pytest {} \; \ No newline at end of file diff --git a/.github/workflows/docker-image.yml b/.github/workflows/docker-image.yml index 793d8e0e..6ed5bcba 100644 --- a/.github/workflows/docker-image.yml +++ b/.github/workflows/docker-image.yml @@ -1,18 +1,19 @@ +--- name: Docker Image CI -on: +on: # yamllint disable-line rule:truthy push: - branches: [ "master" ] + branches: ["master"] pull_request: - branches: [ "master" ] + branches: ["master"] jobs: build: runs-on: ubuntu-latest - + name: Build Docker image steps: - - uses: actions/checkout@v4 - - name: Build the Docker image - run: docker build . --file Dockerfile --tag my-image-name:$(date +%s) + - uses: actions/checkout@v4 + - name: Build the Docker image + run: docker build . --file Dockerfile --tag my-image-name:$(date +%s) diff --git a/.github/workflows/docs_test.yml b/.github/workflows/docs_test.yml deleted file mode 100644 index 35d2ca91..00000000 --- a/.github/workflows/docs_test.yml +++ /dev/null @@ -1,28 +0,0 @@ -name: Documentation Tests - -on: - push: - branches: - - master - -jobs: - test: - runs-on: ubuntu-latest - - steps: - - name: Checkout code - uses: actions/checkout@v4 - - - name: Set up Python - uses: actions/setup-python@v4 - with: - python-version: 3.x - - - name: Install dependencies - run: pip install -r requirements.txt - - - name: Build documentation - run: make docs - - - name: Validate documentation - run: sphinx-build -b linkcheck docs build/docs \ No newline at end of file diff --git a/.github/workflows/generator-generic-ossf-slsa3-publish.yml b/.github/workflows/generator-generic-ossf-slsa3-publish.yml deleted file mode 100644 index a36e782c..00000000 --- a/.github/workflows/generator-generic-ossf-slsa3-publish.yml +++ /dev/null @@ -1,66 +0,0 @@ -# This workflow uses actions that are not certified by GitHub. -# They are provided by a third-party and are governed by -# separate terms of service, privacy policy, and support -# documentation. - -# This workflow lets you generate SLSA provenance file for your project. -# The generation satisfies level 3 for the provenance requirements - see https://slsa.dev/spec/v0.1/requirements -# The project is an initiative of the OpenSSF (openssf.org) and is developed at -# https://github.com/slsa-framework/slsa-github-generator. -# The provenance file can be verified using https://github.com/slsa-framework/slsa-verifier. -# For more information about SLSA and how it improves the supply-chain, visit slsa.dev. - -name: SLSA generic generator -on: - workflow_dispatch: - release: - types: [created] - -jobs: - build: - runs-on: ubuntu-latest - outputs: - digests: ${{ steps.hash.outputs.digests }} - - steps: - - uses: actions/checkout@v3 - - # ======================================================== - # - # Step 1: Build your artifacts. - # - # ======================================================== - - name: Build artifacts - run: | - # These are some amazing artifacts. - echo "artifact1" > artifact1 - echo "artifact2" > artifact2 - - # ======================================================== - # - # Step 2: Add a step to generate the provenance subjects - # as shown below. Update the sha256 sum arguments - # to include all binaries that you generate - # provenance for. - # - # ======================================================== - - name: Generate subject for provenance - id: hash - run: | - set -euo pipefail - - # List the artifacts the provenance will refer to. - files=$(ls artifact*) - # Generate the subjects (base64 encoded). - echo "hashes=$(sha256sum $files | base64 -w0)" >> "${GITHUB_OUTPUT}" - - provenance: - needs: [build] - permissions: - actions: read # To read the workflow path. - id-token: write # To sign the provenance. - contents: write # To add assets to a release. - uses: slsa-framework/slsa-github-generator/.github/workflows/generator_generic_slsa3.yml@v1.4.0 - with: - base64-subjects: "${{ needs.build.outputs.digests }}" - upload-assets: true # Optional: Upload to a new release diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index 97aa4732..8a6f374c 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -1,19 +1,29 @@ +--- # This is a basic workflow to help you get started with Actions name: Lint -on: [push, pull_request] +on: [push, pull_request] # yamllint disable-line rule:truthy jobs: + yaml-lint: + runs-on: ubuntu-latest + steps: + - name: Check out source repository + uses: actions/checkout@v4 + - name: yaml Lint + uses: ibiqlik/action-yamllint@v3 flake8-lint: runs-on: ubuntu-latest - name: Lint + name: flake8 Lint steps: - name: Check out source repository uses: actions/checkout@v4 - name: Set up Python environment - uses: actions/setup-python@v4 - with: - python-version: "3.11" - - name: flake8 Lint - uses: py-actions/flake8@v2 \ No newline at end of file + uses: py-actions/flake8@v2 + ruff-lint: + runs-on: ubuntu-latest + name: ruff Lint + steps: + - uses: actions/checkout@v4 + - uses: chartboost/ruff-action@v1 diff --git a/.github/workflows/lints.yml b/.github/workflows/lints.yml deleted file mode 100644 index 216903d5..00000000 --- a/.github/workflows/lints.yml +++ /dev/null @@ -1,25 +0,0 @@ -name: Linting - -on: - push: - branches: - - master - -jobs: - lint: - runs-on: ubuntu-latest - - steps: - - name: Checkout code - uses: actions/checkout@v4 - - - name: Set up Python - uses: actions/setup-python@v4 - with: - python-version: 3.x - - - name: Install dependencies - run: pip install -r requirements.txt - - - name: Run linters - run: pylint swarms \ No newline at end of file diff --git a/.github/workflows/makefile.yml b/.github/workflows/makefile.yml deleted file mode 100644 index ab01451f..00000000 --- a/.github/workflows/makefile.yml +++ /dev/null @@ -1,27 +0,0 @@ -name: Makefile CI - -on: - push: - branches: [ "master" ] - pull_request: - branches: [ "master" ] - -jobs: - build: - - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@v3 - - - name: configure - run: ./configure - - - name: Install dependencies - run: make - - - name: Run check - run: make check - - - name: Run distcheck - run: make distcheck diff --git a/.github/workflows/pr_request_checks.yml b/.github/workflows/pr_request_checks.yml index 56b8c1f7..ad7b691f 100644 --- a/.github/workflows/pr_request_checks.yml +++ b/.github/workflows/pr_request_checks.yml @@ -1,3 +1,4 @@ +--- name: Pull Request Checks on: @@ -24,4 +25,4 @@ jobs: - name: Run tests and checks run: | find tests/ -name "*.py" | xargs pytest - pylint swarms \ No newline at end of file + pylint swarms diff --git a/.github/workflows/pylint.yml b/.github/workflows/pylint.yml deleted file mode 100644 index 3f3ba2e2..00000000 --- a/.github/workflows/pylint.yml +++ /dev/null @@ -1,23 +0,0 @@ -name: Pylint - -on: [push] - -jobs: - build: - runs-on: ubuntu-latest - strategy: - matrix: - python-version: ["3.8", "3.9", "3.10"] - steps: - - uses: actions/checkout@v4 - - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v4 - with: - python-version: ${{ matrix.python-version }} - - name: Install dependencies - run: | - python -m pip install --upgrade pip - pip install pylint - - name: Analysing the code with pylint - run: | - pylint $(git ls-files '*.py') diff --git a/.github/workflows/pyre.yml b/.github/workflows/pyre.yml deleted file mode 100644 index 5ff88856..00000000 --- a/.github/workflows/pyre.yml +++ /dev/null @@ -1,46 +0,0 @@ -# This workflow uses actions that are not certified by GitHub. -# They are provided by a third-party and are governed by -# separate terms of service, privacy policy, and support -# documentation. - -# This workflow integrates Pyre with GitHub's -# Code Scanning feature. -# -# Pyre is a performant type checker for Python compliant with -# PEP 484. Pyre can analyze codebases with millions of lines -# of code incrementally – providing instantaneous feedback -# to developers as they write code. -# -# See https://pyre-check.org - -name: Pyre - -on: - workflow_dispatch: - push: - branches: [ "master" ] - pull_request: - branches: [ "master" ] - -permissions: - contents: read - -jobs: - pyre: - permissions: - actions: read - contents: read - security-events: write - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v3 - with: - submodules: true - - - name: Run Pyre - uses: facebook/pyre-action@60697a7858f7cc8470d8cc494a3cf2ad6b06560d - with: - # To customize these inputs: - # See https://github.com/facebook/pyre-action#inputs - repo-directory: './' - requirements-path: 'requirements.txt' diff --git a/.github/workflows/python-app.yml b/.github/workflows/python-app.yml deleted file mode 100644 index 1f634309..00000000 --- a/.github/workflows/python-app.yml +++ /dev/null @@ -1,39 +0,0 @@ -# This workflow will install Python dependencies, run tests and lint with a single version of Python -# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python - -name: Python application - -on: - push: - branches: [ "master" ] - pull_request: - branches: [ "master" ] - -permissions: - contents: read - -jobs: - build: - - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@v4 - - name: Set up Python 3.10 - uses: actions/setup-python@v4 - with: - python-version: "3.10" - - name: Install dependencies - run: | - python -m pip install --upgrade pip - pip install flake8 pytest - if [ -f requirements.txt ]; then pip install -r requirements.txt; fi - - name: Lint with flake8 - run: | - # stop the build if there are Python syntax errors or undefined names - flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics - # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide - flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics - - name: Test with pytest - run: | - pytest diff --git a/.github/workflows/python-publish.yml b/.github/workflows/python-publish.yml index c8f4ba0c..66beff23 100644 --- a/.github/workflows/python-publish.yml +++ b/.github/workflows/python-publish.yml @@ -1,7 +1,7 @@ - +--- name: Upload Python Package -on: +on: # yamllint disable-line rule:truthy release: types: [published] @@ -13,7 +13,7 @@ jobs: runs-on: ubuntu-latest - steps: + steps: - uses: actions/checkout@v4 - name: Set up Python uses: actions/setup-python@v4 @@ -29,4 +29,4 @@ jobs: uses: pypa/gh-action-pypi-publish@b7f401de30cb6434a1e19f805ff006643653240e with: user: __token__ - password: ${{ secrets.PYPI_API_TOKEN }} \ No newline at end of file + password: ${{ secrets.PYPI_API_TOKEN }} diff --git a/.github/workflows/quality.yml b/.github/workflows/quality.yml deleted file mode 100644 index 9b09cfa9..00000000 --- a/.github/workflows/quality.yml +++ /dev/null @@ -1,23 +0,0 @@ -name: Quality - -on: - push: - branches: [ "master" ] - pull_request: - branches: [ "master" ] - -jobs: - lint: - runs-on: ubuntu-latest - strategy: - fail-fast: false - steps: - - name: Checkout actions - uses: actions/checkout@v4 - with: - fetch-depth: 0 - - name: Init environment - uses: ./.github/actions/init-environment - - name: Run linter - run: | - pylint `git diff --name-only --diff-filter=d origin/master HEAD | grep -E '\.py$' | tr '\n' ' '` \ No newline at end of file diff --git a/.github/workflows/ruff.yml b/.github/workflows/ruff.yml deleted file mode 100644 index ef06d34a..00000000 --- a/.github/workflows/ruff.yml +++ /dev/null @@ -1,8 +0,0 @@ -name: Ruff -on: [ push, pull_request ] -jobs: - ruff: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - - uses: chartboost/ruff-action@v1 diff --git a/.github/workflows/run_test.yml b/.github/workflows/run_test.yml deleted file mode 100644 index 172dc64b..00000000 --- a/.github/workflows/run_test.yml +++ /dev/null @@ -1,23 +0,0 @@ -name: Python application test - -on: [push] - -jobs: - build: - - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@v4 - - name: Set up Python 3.8 - uses: actions/setup-python@v4 - with: - python-version: 3.8 - - name: Install dependencies - run: | - python -m pip install --upgrade pip - pip install pytest - if [ -f requirements.txt ]; then pip install -r requirements.txt; fi - - name: Run tests with pytest - run: | - find tests/ -name "*.py" | xargs pytest diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 65dc68d9..d9dafc76 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -1,3 +1,4 @@ +--- name: test on: @@ -9,7 +10,67 @@ on: env: POETRY_VERSION: "1.4.2" -jobs: + test: + runs-on: ubuntu-latest + strategy: + matrix: + python-version: + - "3.8" + - "3.9" + - "3.10" + - "3.11" + test_type: + - "core" + - "extended" + steps: + - uses: actions/checkout@v4 + - name: Set up Python ${{ matrix.python-version }} + uses: "snok/install-poetry@v1" + with: + python-version: ${{ matrix.python-version }} + poetry-version: "1.4.2" + cache-key: ${{ matrix.test_type }} + install-command: | + if [ "${{ matrix.test_type }}" == "core" ]; then + echo "Running core tests, installing dependencies with poetry..." + poetry install + else + echo "Running extended tests, installing dependencies with poetry..." + poetry install -E extended_testing + fi + - name: Run ${{matrix.test_type}} tests + run: | + if [ "${{ matrix.test_type }}" == "core" ]; then + make test + else + make extended_tests + fi + shell: bash + name: Python ${{ matrix.python-version }} ${{ matrix.test_type }} + steps: + - uses: actions/checkout@v4 + - name: Set up Python ${{ matrix.python-version }} + uses: "./.github/actions/poetry_setup" + with: + python-version: ${{ matrix.python-version }} + poetry-version: "1.4.2" + cache-key: ${{ matrix.test_type }} + install-command: | + if [ "${{ matrix.test_type }}" == "core" ]; then + echo "Running core tests, installing dependencies with poetry..." + poetry install + else + echo "Running extended tests, installing dependencies with poetry..." + poetry install -E extended_testing + fi + - name: Run ${{matrix.test_type}} tests + run: | + if [ "${{ matrix.test_type }}" == "core" ]; then + make test + else + make extended_tests + fi + shell: bash build: runs-on: ubuntu-latest strategy: diff --git a/.readthedocs.yml b/.readthedocs.yml index fbdc74ec..1c969083 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -1,3 +1,4 @@ +--- version: 2 build: @@ -10,4 +11,4 @@ mkdocs: python: install: - - requirements: requirements.txt \ No newline at end of file + - requirements: requirements.txt diff --git a/.yamllint b/.yamllint new file mode 100644 index 00000000..c58fcd8f --- /dev/null +++ b/.yamllint @@ -0,0 +1,4 @@ +rules: + line-length: + level: warning + allow-non-breakable-inline-mappings: true \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index e70e1a39..8616cc2f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,3 +1,4 @@ +--- site_name: Swarms Docs plugins: - glightbox @@ -19,15 +20,15 @@ extra: - icon: fontawesome/brands/python link: https://pypi.org/project/Swarms/ theme: - name: material - custom_dir: docs/overrides - logo: assets/img/SwarmsLogoIcon.png - palette: - # Palette toggle for light mode + name: material + custom_dir: docs/overrides + logo: assets/img/SwarmsLogoIcon.png + palette: + # Palette toggle for light mode - scheme: default primary: black toggle: - icon: material/brightness-7 + icon: material/brightness-7 name: Switch to dark mode # Palette toggle for dark mode - scheme: slate @@ -35,14 +36,14 @@ theme: toggle: icon: material/brightness-4 name: Switch to light mode - features: - - content.code.copy - - content.code.annotate - - navigation.tabs - - navigation.sections - - navigation.expand - - navigation.top - - announce.dismiss + features: + - content.code.copy + - content.code.annotate + - navigation.tabs + - navigation.sections + - navigation.expand + - navigation.top + - announce.dismiss markdown_extensions: - pymdownx.highlight: anchor_linenums: true @@ -58,25 +59,25 @@ markdown_extensions: - def_list - footnotes nav: -- Home: - - Overview: "index.md" - - Contributing: "contributing.md" - - Docker Container Setup: "docker_setup.md" -- Swarms: - - Overview: "swarms/index.md" + - Home: + - Overview: "index.md" + - Contributing: "contributing.md" + - Docker Container Setup: "docker_setup.md" + - Swarms: + - Overview: "swarms/index.md" - swarms.swarms: - - AbstractSwarm: "swarms/swarms/abstractswarm.md" - - GodMode: "swarms/swarms/godmode.md" - - Groupchat: "swarms/swarms/groupchat.md" + - AbstractSwarm: "swarms/swarms/abstractswarm.md" + - GodMode: "swarms/swarms/godmode.md" + - Groupchat: "swarms/swarms/groupchat.md" - swarms.workers: - - Overview: "swarms/workers/index.md" - - AbstractWorker: "swarms/workers/abstract_worker.md" + - Overview: "swarms/workers/index.md" + - AbstractWorker: "swarms/workers/abstract_worker.md" - swarms.agents: - - AbstractAgent: "swarms/agents/abstract_agent.md" - - OmniModalAgent: "swarms/agents/omni_agent.md" + - AbstractAgent: "swarms/agents/abstract_agent.md" + - OmniModalAgent: "swarms/agents/omni_agent.md" - swarms.models: - - Language: - - Overview: "swarms/models/index.md" + - Language: + - Overview: "swarms/models/index.md" - HuggingFaceLLM: "swarms/models/huggingface.md" - Anthropic: "swarms/models/anthropic.md" - OpenAI: "swarms/models/openai.md" @@ -84,54 +85,54 @@ nav: - BioGPT: "swarms/models/biogpt.md" - MPT7B: "swarms/models/mpt.md" - Mistral: "swarms/models/mistral.md" - - MultiModal: - - Fuyu: "swarms/models/fuyu.md" - - Vilt: "swarms/models/vilt.md" - - Idefics: "swarms/models/idefics.md" - - BingChat: "swarms/models/bingchat.md" - - Kosmos: "swarms/models/kosmos.md" - - Nougat: "swarms/models/nougat.md" - - Dalle3: "swarms/models/dalle3.md" - - GPT4V: "swarms/models/gpt4v.md" - - LayoutLMDocumentQA: "swarms/models/layoutlm_document_qa.md" - - DistilWhisperModel: "swarms/models/distilled_whisperx.md" - - ElevenLabsText2SpeechTool: "swarms/models/elevenlabs.md" + - MultiModal: + - Fuyu: "swarms/models/fuyu.md" + - Vilt: "swarms/models/vilt.md" + - Idefics: "swarms/models/idefics.md" + - BingChat: "swarms/models/bingchat.md" + - Kosmos: "swarms/models/kosmos.md" + - Nougat: "swarms/models/nougat.md" + - Dalle3: "swarms/models/dalle3.md" + - GPT4V: "swarms/models/gpt4v.md" + - LayoutLMDocumentQA: "swarms/models/layoutlm_document_qa.md" + - DistilWhisperModel: "swarms/models/distilled_whisperx.md" + - ElevenLabsText2SpeechTool: "swarms/models/elevenlabs.md" - swarms.structs: - - Overview: "swarms/structs/overview.md" - - AutoScaler: "swarms/swarms/autoscaler.md" - - Flow: "swarms/structs/flow.md" - - SequentialWorkflow: 'swarms/structs/sequential_workflow.md' + - Overview: "swarms/structs/overview.md" + - AutoScaler: "swarms/swarms/autoscaler.md" + - Flow: "swarms/structs/flow.md" + - SequentialWorkflow: 'swarms/structs/sequential_workflow.md' - swarms.memory: - - PineconeVectorStoreStore: "swarms/memory/pinecone.md" - - PGVectorStore: "swarms/memory/pg.md" - # - swarms.chunkers: - # - BaseChunker: "swarms/chunkers/basechunker.md" - # - PdfChunker: "swarms/chunkers/pdf_chunker.md" -- Guides: - - Overview: "examples/index.md" - - Agents: - - Flow: "examples/flow.md" - - SequentialWorkflow: "examples/reliable_autonomous_agents.md" - - OmniAgent: "examples/omni_agent.md" - - 2O+ Autonomous Agent Blogs: "examples/ideas.md" -- Applications: - - CustomerSupport: - - Overview: "applications/customer_support.md" - - Marketing: - - Overview: "applications/marketing_agencies.md" -- Corporate: - - 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" - - SwarmCloud: "corporate/swarm_cloud.md" + - PineconeVectorStoreStore: "swarms/memory/pinecone.md" + - PGVectorStore: "swarms/memory/pg.md" +# - swarms.chunkers: +# - BaseChunker: "swarms/chunkers/basechunker.md" +# - PdfChunker: "swarms/chunkers/pdf_chunker.md" + - Guides: + - Overview: "examples/index.md" + - Agents: + - Flow: "examples/flow.md" + - SequentialWorkflow: "examples/reliable_autonomous_agents.md" + - OmniAgent: "examples/omni_agent.md" + - 2O+ Autonomous Agent Blogs: "examples/ideas.md" + - Applications: + - CustomerSupport: + - Overview: "applications/customer_support.md" + - Marketing: + - Overview: "applications/marketing_agencies.md" + - Corporate: + - 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" + - SwarmCloud: "corporate/swarm_cloud.md"