diff --git a/README.md b/README.md index 0096579..c178780 100644 --- a/README.md +++ b/README.md @@ -1,48 +1,26 @@ -# Swarms Models +# Swarm Models [![Join our Discord](https://img.shields.io/badge/Discord-Join%20our%20server-5865F2?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/agora-999382051935506503) [![Subscribe on YouTube](https://img.shields.io/badge/YouTube-Subscribe-red?style=for-the-badge&logo=youtube&logoColor=white)](https://www.youtube.com/@kyegomez3242) [![Connect on LinkedIn](https://img.shields.io/badge/LinkedIn-Connect-blue?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/kye-g-38759a207/) [![Follow on X.com](https://img.shields.io/badge/X.com-Follow-1DA1F2?style=for-the-badge&logo=x&logoColor=white)](https://x.com/kyegomezb) +Swarm Models provides a unified, secure, and highly scalable interface for interacting with multiple LLM and multi-modal APIs across different providers. It is built to streamline your API integrations, ensuring production-grade reliability and robust performance. +### **Key Features**: -**Leverage LLM APIs with Unparalleled Speed, Security, and Reliability** +- **Multi-Provider Support**: Integrate seamlessly with APIs from OpenAI, Anthropic, Azure, and more. + +- **Enterprise-Grade Security**: Built-in security protocols to protect your API keys and sensitive data, ensuring compliance with industry standards. +- **Lightning-Fast Performance**: Optimized for low-latency and high-throughput, Swarm Models delivers blazing-fast API responses, suitable for real-time applications. -## **Why Swarm Models?** +- **Ease of Use**: Simplified API interaction with intuitive `.run(task)` and `__call__` methods, making integration effortless. -- **Multi-Provider Support**: Effortlessly integrate APIs from various providers into your projects. +- **Scalability for All Use Cases**: Whether it's a small script or a massive enterprise-scale application, Swarm Models scales effortlessly. -- **Bleeding-Edge Speed**: Experience lightning-fast performance optimized for efficiency. - -- **Robust Security**: Built with top-notch security protocols to protect your data and API keys. - -- **Ease of Use**: Simple initialization and execution with intuitive `.run(task)` and `__call__` methods. -- **Scalability**: Designed to handle everything from small scripts to large-scale applications. +- **Production-Grade Reliability**: Tested and proven in enterprise environments, ensuring consistent uptime and failover capabilities. --- -## **Code Example** - -```python -from swarm_models import OpenAIChat -import os - -# Get the OpenAI API key from the environment variable -api_key = os.getenv("OPENAI_API_KEY") - -# Create an instance of the OpenAIChat class -model = OpenAIChat(openai_api_key=api_key, model_name="gpt-4o-mini") - -# Query the model with a question -out = model( - "What is the best state to register a business in the US for the least amount of taxes?" -) - -# Print the model's response -print(out) -``` - - ## **How It Works** @@ -51,7 +29,7 @@ Swarm Models simplifies the way you interact with different APIs by providing a ### **1. Install Swarm Models** ```bash -$ pip3 install swarm-models +$ pip3 install -U swarm-models ``` ### **2. Set Your Keys** @@ -93,29 +71,39 @@ print(result) --- +## **Full Code Example** ---- +```python +from swarm_models import OpenAIChat +import os +# Get the OpenAI API key from the environment variable +api_key = os.getenv("OPENAI_API_KEY") -## **Get Started Now** +# Create an instance of the OpenAIChat class +model = OpenAIChat(openai_api_key=api_key, model_name="gpt-4o-mini") -Ready to streamline your API integrations and boost your application's performance? +# Query the model with a question +out = model( + "What is the best state to register a business in the US for the least amount of taxes?" +) -1. **Install the Package** +# Print the model's response +print(out) +``` - ```bash - $ pip install swarm-models - ``` +--- -2. **Explore the Documentation** - Dive into our comprehensive [Documentation](https://docs.swarms.world) to learn more about the available models and features. +## **Enterprise-Grade Features** -3. **Join the Community** +1. **Security**: API keys and user data are handled with utmost care, utilizing encryption and best security practices to protect your sensitive information. + +2. **Production Reliability**: Swarm Models has undergone rigorous testing to ensure that it can handle high traffic and remains resilient in enterprise-grade environments. - Connect with other developers on our [GitHub](https://github.com/swarm-models) and contribute to the project. +3. **Fail-Safe Mechanisms**: Built-in failover handling to ensure uninterrupted service even under heavy load or network issues. -[Download Now](https://pypi.org/project/swarm-models/) | [Documentation](https://example.com/docs) | [GitHub](https://github.com/The-Swarm-Corporation/swarm-models) +4. **Unified API**: No more dealing with multiple SDKs or libraries. Swarm Models standardizes your interactions across providers like OpenAI, Anthropic, Azure, and more, so you can focus on what matters. --- @@ -143,19 +131,28 @@ Ready to streamline your API integrations and boost your application's performan +--- -## **Frequently Asked Questions** +## **Support & Contributions** -**Q:** *Which providers are supported?* +- **Documentation**: Comprehensive guides, API references, and best practices are available in our official [Documentation](https://docs.swarms.world). +- **GitHub**: Explore the code, report issues, and contribute to the project via our [GitHub repository](https://github.com/The-Swarm-Corporation/swarm-models). -**A:** Swarm Models supports a wide range of API providers. Check out the [documentation](https://docs.swarms.world) for a full list. +--- -**Q:** *How do I secure my API keys?* +## **License** -**A:** We recommend using environment variables or a secure key management system. Swarm Models ensures your keys are handled securely within the package. +Swarm Models is released under the [MIT License](https://github.com/The-Swarm-Corporation/swarm-models/LICENSE). --- -## **Contact Us** -Join our [Discord](https://discord.gg/agora-999382051935506503) to stay updated and get support. + + + + + + + + +