Skip to main content

Take your best shot

Project description

🎯 FewShots: The best few shots with LLMs

Python 3.8+ License: MIT

Ever wished your AI model had a better memory? Meet FewShot - the simple yet powerful library for managing and retrieving few-shot examples with style! 🧠✨

🌟 Features

  • 🎮 Easy to Use: Simple, intuitive API for managing your AI's example database
  • 🔄 Structured Output: Support for structured outputs

💡 Use Cases

  • 🤖 Enhance your chatbot with dynamic example retrieval
  • 📚 Build a self-improving knowledge base
  • 🎯 Implement context-aware few-shot learning

🛠️ Core Components

  • Shot: The fundamental unit representing an input-output pair with a unique ID (bring your own ID or let FewShots hash the inputs)
  • Embed: Converts inputs into vector embeddings for similarity search
  • Store: Manages storage and retrieval of examples
  • Client: Ties everything together with a clean, simple interface

🚀 Quick Start

from sentence_transformers import SentenceTransformer # Can also use OpenAI, etc.
from few_shots.client import FewShots
from few_shots.embed.transformers import TransformersEmbed
from few_shots.store.memory import MemoryStore

# Create a FewShot client
shots = FewShots(
    embed=TransformersEmbed(SentenceTransformer("all-MiniLM-L6-v2")),
    store=MemoryStore()
)

# Add some examples
shots.add(
    inputs="How do I make a pizza?",
    outputs="1. Make the dough 2. Add toppings 3. Bake at 450°F"
)

# Find similar examples
best_shots = shots.list("What's the recipe for pizza?", limit=1)
for shot, similarity in results:
    print(f"Found match (similarity: {similarity:.2f}):")
    print(f"Q: {shot.inputs}")
    print(f"A: {shot.outputs}")

# Use with your LLM
from few_shots.utils.format import shots_to_messages

openai.chat.completions.create(
    ...,
    messages=[
        {"role": "system", "content": "You are a helpful assistant."},
        *shots_to_messages(best_shots),
        {"role": "user", "content": "What's the recipe for pizza?"},
    ]
)

🔧 Installation

pip install few-shots
rye add few-shots
poetry add few-shots

🎮 Usage Examples

Working with Structured Output I/O

# Add structured data
shots.add(
    inputs={"type": "greeting", "language": "English"},
    outputs={"text": "Hello, world!"}
)

# Search with similar inputs
best_shots = shots.list({"type": "greeting", "language": "English"})

Async Support

from few_shots.async_client import AsyncFewShot

shots = AsyncFewShots(embed=async_embedder, store=async_store)

# Add examples asynchronously
await shots.add(
    inputs="What's the weather like?",
    outputs="I don't have access to real-time weather data."
)

# Search asynchronously
best_shots = await shots.list("How's the weather today?", limit=1)

Using LiteLLM for Embeddings

from functools import partial
from litellm import aembedding
from few_shots import AsyncFewShots
from few_shots.embed.litellm import AsyncLiteLLMEmbed

shots = AsyncFewShots(
    embed=AsyncLiteLLMEmbed(
        partial(aembedding, model="...", **kwargs),
    ),
    store=MemoryStore()
)

Using different Vector Stores

from few_shots.store.chroma import ChromaStore, AsyncChromaStore
from few_shots.store.qdrant import QdrantStore, AsyncQdrantStore
from few_shots.store.weaviate import WeaviateStore, AsyncWeaviateStore
from few_shots.store.milvus import MilvusStore
from few_shots.store.pg import PGStore, AsyncPGStore # TODO

🤝 Contributing

We love contributions! Feel free to:

  1. Fork the repository
  2. Create a feature branch
  3. Submit a pull request

📝 License

MIT License - feel free to use it in your projects!


Made with ❤️ by developers who believe in the power of learning from examples.

Remember: The best AI is the one that learns from experience! 🌟

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

few_shots-0.1.3.tar.gz (13.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

few_shots-0.1.3-py3-none-any.whl (13.0 kB view details)

Uploaded Python 3

File details

Details for the file few_shots-0.1.3.tar.gz.

File metadata

  • Download URL: few_shots-0.1.3.tar.gz
  • Upload date:
  • Size: 13.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.12.2

File hashes

Hashes for few_shots-0.1.3.tar.gz
Algorithm Hash digest
SHA256 16180ad9907e349cbb4558a9f042161de9a7f87210ab611a0a973b7180a2ba60
MD5 c192774c85556829dc02f62c4a6c30c7
BLAKE2b-256 7662e8e6fd649dceaff5780ff960c017776a0e067589ee315ca52f541d087941

See more details on using hashes here.

File details

Details for the file few_shots-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: few_shots-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 13.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.12.2

File hashes

Hashes for few_shots-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 40a67aa9d1fe6f9bed1f229fbf181d09d52ce84c436981ace75fbee155274eac
MD5 5aa320951643d191b468bb4e8f6253f6
BLAKE2b-256 4be45ae9902886027a4120fd796a7c733642ec753244feeeb7cb047322f9953b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page