From 49498d829ec08bb66d8e8d829fb578e788c571cb Mon Sep 17 00:00:00 2001 From: Your Name Date: Wed, 9 Oct 2024 17:37:32 -0400 Subject: [PATCH] [CLEANUP] --- docs/index.md | 2 +- docs/mkdocs.yml | 14 +-- docs/swarms_cloud/cli.md | 100 ++++++++++++++++++ docs/swarms_cloud/vision.md | 90 ++++++++++++++++ .../agents/use_cases/pharma/pharma_swarm.py | 2 +- 5 files changed, 200 insertions(+), 8 deletions(-) create mode 100644 docs/swarms_cloud/cli.md create mode 100644 docs/swarms_cloud/vision.md diff --git a/docs/index.md b/docs/index.md index 2c7aab6f..84e5930e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -6,7 +6,7 @@ | Section | Links | |----------------------|--------------------------------------------------------------------------------------------| -| Instllation | [Installation](https://docs.swarms.world/en/latest/swarms/install/install/) | +| Installation | [Installation](https://docs.swarms.world/en/latest/swarms/install/install/) | | Quickstart | [Get Started](https://docs.swarms.world/en/latest/swarms/install/quickstart/) | | Agent Internal Mechanisms | [Agent Architecture](https://docs.swarms.world/en/latest/swarms/framework/agents_explained/) | | Agent API | [Agent API](https://docs.swarms.world/en/latest/swarms/structs/agent/) | diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index e50f308b..ecdb3e82 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -198,12 +198,14 @@ nav: - BaseMultiModalModel: "swarms/models/base_multimodal_model.md" - Multi Modal Models Available: "swarms/models/multimodal_models.md" - GPT4VisionAPI: "swarms/models/gpt4v.md" - # - Swarms Cloud API: - # - Overview: "swarms_cloud/main.md" - # - Available Models: "swarms_cloud/available_models.md" - # - Agent API: "swarms_cloud/agent_api.md" - # - Migrate from OpenAI to Swarms in 3 lines of code: "swarms_cloud/migrate_openai.md" - # - Getting Started with SOTA Vision Language Models VLM: "swarms_cloud/getting_started.md" + - Swarms Cloud API: + # - Overview: "swarms_cloud/main.md" + - Overview: "swarms_cloud/vision.md" + - Swarms Cloud CLI: "swarms_cloud/cli.md" + # - Available Models: "swarms_cloud/available_models.md" + # - Agent API: "swarms_cloud/agent_api.md" + # - Migrate from OpenAI to Swarms in 3 lines of code: "swarms_cloud/migrate_openai.md" + # - Getting Started with SOTA Vision Language Models VLM: "swarms_cloud/getting_started.md" - Swarms Memory: - Overview: "swarms_memory/index.md" - Memory Systems: diff --git a/docs/swarms_cloud/cli.md b/docs/swarms_cloud/cli.md new file mode 100644 index 00000000..dc098b09 --- /dev/null +++ b/docs/swarms_cloud/cli.md @@ -0,0 +1,100 @@ +# Swarms Cloud CLI Documentation + +Welcome to the Swarms Cloud CLI documentation. This guide will help you understand how to use the CLI to interact with the Swarms Cloud platform. + +## Table of Contents + +1. [Introduction](#introduction) +2. [Installation](#installation) +3. [Usage](#usage) +4. [Commands](#commands) + - [onboarding](#onboarding) + - [help](#help) + - [get-api-key](#get-api-key) + - [check-login](#check-login) + - [read-docs](#read-docs) +5. [Troubleshooting](#troubleshooting) +6. [FAQs](#faqs) +7. [Contact Support](#contact-support) + +## Introduction + +The Swarms Cloud CLI is a command-line interface tool that allows you to interact with the Swarms Cloud platform. It provides various commands to help you manage your account, retrieve API keys, and access documentation. + +## Installation + +To install the Swarms Cloud CLI, you need to have Python installed on your system. You can then install the CLI using pip: + +```bash +pip install swarms-cloud-cli +``` + +## Usage + +Once installed, you can use the CLI by typing `swarms-cloud` followed by the command you wish to execute. For example: + +```bash +swarms-cloud help +``` + +## Commands + +### onboarding + +Starts the onboarding process to help you set up your account. + +```bash +swarms-cloud onboarding +``` + +### help + +Displays the help message with a list of available commands. + +```bash +swarms-cloud help +``` + +### get-api-key + +Opens the API key retrieval page in your default web browser. + +```bash +swarms-cloud get-api-key +``` + +### check-login + +Checks if you are logged in and starts the cache if necessary. + +```bash +swarms-cloud check-login +``` + +### read-docs + +Redirects you to the Swarms Cloud documentation page. + +```bash +swarms-cloud read-docs +``` + +## Troubleshooting + +If you encounter any issues while using the CLI, ensure that you have the latest version installed. You can update the CLI using: + +```bash +pip install --upgrade swarms-cloud-cli +``` + +## FAQs + +**Q: How do I retrieve my API key?** +A: Use the `get-api-key` command to open the API key retrieval page. + +**Q: What should I do if I am not logged in?** +A: Use the `check-login` command to log in and start the cache. + +## Contact Support + +If you need further assistance, please contact our support team at kye@swarms.world \ No newline at end of file diff --git a/docs/swarms_cloud/vision.md b/docs/swarms_cloud/vision.md new file mode 100644 index 00000000..e5b10d49 --- /dev/null +++ b/docs/swarms_cloud/vision.md @@ -0,0 +1,90 @@ +## Visionary Document: The Swarms Cloud and Agent Marketplace + +### Introduction + +We stand at the dawn of a new era—the **Agentic Economy**, where the power of intelligent automation is in the hands of everyone. The Swarms Cloud and Agent Marketplace will serve as the epicenter of this economy, enabling developers, businesses, and creators to easily publish, discover, and leverage intelligent agents. Our vision is to make publishing agents as simple as possible through an intuitive CLI, while empowering users to generate income by posting their APIs on the marketplace. + +The Swarms Marketplace is more than just a platform—it’s a **revolutionary ecosystem** that will change how we think about automation and intelligence. By building this platform, we aim to democratize access to agent-driven solutions, enabling a seamless bridge between creators and consumers of automation. With every agent posted to the marketplace, a ripple effect is created, driving innovation across industries and providing an unparalleled opportunity for monetization. + +--- + +### The Agent Marketplace + +#### A Unified Platform for Automation + +In the Swarms Marketplace, **agents will be the new currency of efficiency**. Whether you’re building agents for marketing, finance, customer service, or any other domain, the Swarms Cloud will allow you to showcase your agentic APIs, easily discoverable by anyone needing those capabilities. + +We envision the marketplace to function like an API store, where users can search for specific agent capabilities, purchase access to agents, or even integrate their existing systems with agent-based APIs that others have developed. Each agent you publish will come with a potential income stream as businesses and developers integrate your creations into their workflows. + +#### The Opportunity to Monetize Your APIs + +The Swarms Marketplace is designed to let developers and businesses generate income by sharing their agent APIs. Once your agent is published to the marketplace, other users can browse, test, and integrate it into their operations. You will be able to set custom pricing, usage tiers, and licensing terms for your API, ensuring you can profit from your innovations. + +Our vision for monetization includes: +- **API subscriptions**: Allow users to subscribe to your agent API with recurring payments. +- **Per-use pricing**: Offer users a pay-as-you-go model where they only pay for the API calls they use. +- **Licensing**: Enable others to purchase full access to your agent for a set period or on a project basis. + +### Publishing Agents: Simplicity Through CLI + +The complexity of deploying agents to a marketplace should never be a barrier. Our goal is to **streamline the publishing process** into something as simple as a command-line interaction. The Swarms CLI will be your one-stop solution to get your agent up and running on the marketplace. + +#### CLI Workflow: + +1. **Create an Agent**: Build your agent using the Swarms framework or any custom framework of your choice. +2. **Set Agent Metadata**: Through the CLI, input the metadata about your agent, including its capabilities, pricing, and target industries. +3. **Publish to Marketplace**: Run the simple `swarms publish` command to instantly deploy your agent to the marketplace. +4. **Monitor Usage and Income**: Use the Swarms Cloud dashboard to view your agent's interactions, track API usage, and receive payouts. + +Here’s an example of how easy publishing will be: + +```bash +$ swarms create-agent --name "CustomerSupportAgent" --type "LLM" +$ swarms set-metadata --description "An intelligent agent for customer support operations" --pricing "subscription" --rate "$20/month" +$ swarms publish +``` + +Within minutes, your agent will be live and accessible to the global marketplace! + +--- + +### Empowering Businesses + +For businesses, the marketplace offers **an unprecedented opportunity to automate tasks**, integrate pre-built agents, and drastically cut operational costs. Companies no longer need to build every system from scratch. With the marketplace, they can simply discover and plug in the agentic solutions that best suit their needs. + +Mermaid Diagram for Publishing Agents: + +```mermaid +graph TD + A[Build Agent] --> B[Set Metadata] + B --> C[Publish to Marketplace] + C --> D{Agent Available Globally} + D --> E[Developers Discover API] + D --> F[Businesses Integrate API] + F --> G[Revenue Stream for Agent Creator] + E --> G +``` + +--- + +### The Future of Automation: Agents as APIs + +In this future we’re creating, **agents will be as ubiquitous as APIs**. The Swarms Marketplace will be an expansive repository of intelligent agents, each contributing to the automation and streamlining of everyday tasks. Imagine a world where every business can access highly specific, pre-built intelligence for any task, from customer support to supply chain management, and integrate these agents into their processes in minutes. + +Mermaid Diagram for API Discovery and Integration: + +```mermaid +graph LR + A[Search for Agent API] --> B[Find Agent That Fits] + B --> C[Purchase Access] + C --> D[Integrate with Business System] + D --> E[Business Operations Streamlined] +``` + +--- + +### Conclusion + +The Swarms Cloud and Agent Marketplace will usher in an **agent-powered future**, where **automation is accessible to all**, and **monetization opportunities** are boundless. Our vision is to create a space where developers can not only build and showcase their agents but can also create sustainable income streams from their creations. The CLI will remove the friction of deployment, and the marketplace will enable a **self-sustaining ecosystem** of agentic intelligence that powers the next generation of automation. + +Together, we will shape the **Agentic Economy**, where **collaboration, innovation, and financial opportunity** intersect. Welcome to the future of intelligent automation. Welcome to **Swarms Cloud**. \ No newline at end of file diff --git a/examples/agents/use_cases/pharma/pharma_swarm.py b/examples/agents/use_cases/pharma/pharma_swarm.py index df08b01d..25817fa0 100644 --- a/examples/agents/use_cases/pharma/pharma_swarm.py +++ b/examples/agents/use_cases/pharma/pharma_swarm.py @@ -4,7 +4,7 @@ from loguru import logger from swarms import Agent from swarm_models import OpenAIChat from pydantic import BaseModel, Field -from typing import Any, Dict, Optional +from typing import Optional from datetime import datetime from dotenv import load_dotenv