pixeltable 0.3.10__tar.gz → 0.3.11__tar.gz

pixeltable-0.3.11/PKG-INFO

@@ -0,0 +1,436 @@
+Metadata-Version: 2.3
+Name: pixeltable
+Version: 0.3.11
+Summary: AI Data Infrastructure: Declarative, Multimodal, and Incremental
+License: Apache-2.0
+Keywords: data-science,machine-learning,database,ai,computer-vision,chatbot,ml,artificial-intelligence,feature-engineering,multimodal,mlops,feature-store,vector-database,llm,genai
+Author: Pixeltable, Inc.
+Author-email: contact@pixeltable.com>
+Requires-Python: >=3.9,<4.0
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Database
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Dist: av (>=10.0.0)
+Requires-Dist: beautifulsoup4 (>=4.0.0)
+Requires-Dist: cloudpickle (>=2.2.1)
+Requires-Dist: ftfy (>=6.2.0)
+Requires-Dist: httpcore (>=1.0.3)
+Requires-Dist: httpx (>=0.27)
+Requires-Dist: jinja2 (>=3.1.3)
+Requires-Dist: jmespath (>=1.0.1)
+Requires-Dist: jsonschema (>=4.1.0)
+Requires-Dist: lxml (>=5.0)
+Requires-Dist: more-itertools (>=10.2)
+Requires-Dist: nest_asyncio (>=1.5)
+Requires-Dist: numpy (>=1.25)
+Requires-Dist: pandas (>=2.0,<3.0)
+Requires-Dist: pgvector (>=0.2.1)
+Requires-Dist: pillow (>=9.3.0)
+Requires-Dist: pixeltable-pgserver (==0.3.1)
+Requires-Dist: psutil (>=5.9.5)
+Requires-Dist: psycopg[binary] (>=3.1.18)
+Requires-Dist: puremagic (>=1.20)
+Requires-Dist: pyarrow (>=13.0.0)
+Requires-Dist: pydantic (>=2.7.4)
+Requires-Dist: pyiceberg (>=0.6.0)
+Requires-Dist: pymupdf (>=1.24.1)
+Requires-Dist: pyyaml (>=6.0.1)
+Requires-Dist: requests (>=2.31.0)
+Requires-Dist: sqlalchemy (>=2.0.23)
+Requires-Dist: tenacity (>=8.2)
+Requires-Dist: toml (>=0.10)
+Requires-Dist: tqdm (>=4.64)
+Project-URL: Documentation, https://docs.pixeltable.com/
+Project-URL: Homepage, https://pixeltable.com/
+Project-URL: Repository, https://github.com/pixeltable/pixeltable
+Description-Content-Type: text/markdown
+
+<div align="center">
+<img src="https://raw.githubusercontent.com/pixeltable/pixeltable/main/docs/resources/pixeltable-logo-large.png"
+     alt="Pixeltable Logo" width="50%" />
+<br></br>
+
+<h2>Declarative Data Infrastructure for Multimodal AI Apps</h2>
+
+[![License](https://img.shields.io/badge/License-Apache%202.0-0530AD.svg)](https://opensource.org/licenses/Apache-2.0)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pixeltable?logo=python&logoColor=white&)
+![Platform Support](https://img.shields.io/badge/platform-Linux%20%7C%20macOS%20%7C%20Windows-E5DDD4)
+<br>
+[![tests status](https://github.com/pixeltable/pixeltable/actions/workflows/pytest.yml/badge.svg)](https://github.com/pixeltable/pixeltable/actions/workflows/pytest.yml)
+[![tests status](https://github.com/pixeltable/pixeltable/actions/workflows/nightly.yml/badge.svg)](https://github.com/pixeltable/pixeltable/actions/workflows/nightly.yml)
+[![PyPI Package](https://img.shields.io/pypi/v/pixeltable?color=4D148C)](https://pypi.org/project/pixeltable/)
+[![My Discord (1306431018890166272)](https://img.shields.io/badge/💬-Discord-%235865F2.svg)](https://discord.gg/QPyqFYx2UN)
+
+[**Installation**](https://docs.pixeltable.com/docs/overview/installation) |
+[**Quick Start**](https://docs.pixeltable.com/docs/overview/quick-start) |
+[**Documentation**](https://docs.pixeltable.com/) |
+[**API Reference**](https://pixeltable.github.io/pixeltable/) |
+[**Examples**](https://docs.pixeltable.com/docs/examples/use-cases) |
+[**Discord Community**](https://discord.gg/QPyqFYx2UN)
+
+</div>
+
+---
+
+Pixeltable is the only Python framework that provides incremental storage, transformation, indexing, and orchestration of your multimodal data.
+
+## 😩 Maintaining Production-Ready Multimodal AI Apps is Still Too Hard
+
+Building robust AI applications, especially [multimodal](https://docs.pixeltable.com/docs/datastore/bringing-data) ones, requires stitching together numerous tools:
+*   ETL pipelines for data loading and transformation.
+*   Vector databases for semantic search.
+*   Feature stores for ML models.
+*   Orchestrators for scheduling.
+*   Model serving infrastructure for inference.
+*   Separate systems for parallelization, caching, versioning, and lineage tracking.
+
+This complex "data plumbing" slows down development, increases costs, and makes applications brittle and hard to reproduce.
+
+## 💾 Installation
+
+```python
+pip install pixeltable
+```
+
+**Pixeltable is a database.** It stores metadata and computed results persistently, typically in a `.pixeltable` directory in your workspace. See [configuration](https://docs.pixeltable.com/docs/overview/configuration) options for your setup.
+
+## ✨ What is Pixeltable?
+
+With Pixeltable, you define your *entire* data processing and AI workflow declaratively using **[computed columns](https://docs.pixeltable.com/docs/datastore/computed-columns)** on **[tables](https://docs.pixeltable.com/docs/datastore/tables-and-operations)**. Pixeltable's engine then automatically handles:
+
+*   **Data Ingestion & Storage:** References [files](https://docs.pixeltable.com/docs/datastore/bringing-data) (images, videos, audio, docs) in place, handles structured data.
+*   **Transformation & Processing:** Applies *any* Python function ([UDFs](https://docs.pixeltable.com/docs/datastore/custom-functions)) or built-in operations ([chunking, frame extraction](https://docs.pixeltable.com/docs/datastore/iterators)) automatically.
+*   **AI Model Integration:** Runs inference ([embeddings](https://docs.pixeltable.com/docs/datastore/embedding-index), [object detection](https://docs.pixeltable.com/docs/examples/vision/yolox), [LLMs](https://docs.pixeltable.com/docs/integrations/frameworks#cloud-llm-providers)) as part of the data pipeline.
+*   **Indexing & Retrieval:** Creates and manages vector indexes for fast [semantic search](https://docs.pixeltable.com/docs/datastore/embedding-index#phase-3%3A-query) alongside traditional filtering.
+*   **Incremental Computation:** Only [recomputes](https://docs.pixeltable.com/docs/overview/quick-start) what's necessary when data or code changes, saving time and cost.
+*   **Versioning & Lineage:** Automatically tracks data and schema changes for reproducibility.
+
+**Focus on your application logic, not the infrastructure.**
+
+
+## 🚀 Key Features
+
+* **[Unified Multimodal Interface:](https://docs.pixeltable.com/docs/datastore/tables-and-operations)** `pxt.Image`, `pxt.Video`, `pxt.Audio`, `pxt.Document`, etc. – manage diverse data consistently.
+  ```python
+  t = pxt.create_table(
+    'media', 
+    {
+        'img': pxt.Image, 
+        'video': pxt.Video
+    }
+  )
+  ```
+
+* **[Declarative Computed Columns:](https://docs.pixeltable.com/docs/datastore/computed-columns)** Define processing steps once; they run automatically on new/updated data.
+  ```python
+  t.add_computed_column(
+    classification=huggingface.vit_for_image_classification(
+        t.image
+    )
+  )
+  ```
+
+* **[Built-in Vector Search:](https://docs.pixeltable.com/docs/datastore/embedding-index)** Add embedding indexes and perform similarity searches directly on tables/views.
+  ```python
+  t.add_embedding_index(
+    'img', 
+    embedding=clip.using(
+        model_id='openai/clip-vit-base-patch32'
+    )
+  )
+
+  sim = t.img.similarity("cat playing with yarn")
+  ```
+
+* **[On-the-Fly Data Views:](https://docs.pixeltable.com/docs/datastore/views)** Create virtual tables using iterators for efficient processing without data duplication.
+  ```python
+  frames = pxt.create_view(
+    'frames', 
+    videos, 
+    iterator=FrameIterator.create(
+        video=videos.video, 
+        fps=1
+    )
+  )
+  ```
+
+* **[Seamless AI Integration:](https://docs.pixeltable.com/docs/integrations/frameworks)** Built-in functions for OpenAI, Anthropic, Hugging Face, CLIP, YOLOX, and more.
+  ```python
+  t.add_computed_column(
+    response=openai.chat_completions(
+        messages=[{"role": "user", "content": t.prompt}]
+    )
+  )
+  ```
+
+* **[Bring Your Own Code:](https://docs.pixeltable.com/docs/datastore/custom-functions)** Extend Pixeltable with simple Python User-Defined Functions.
+  ```python
+  @pxt.udf
+  def format_prompt(context: list, question: str) -> str:
+      return f"Context: {context}\nQuestion: {question}"
+  ```
+
+* **[Agentic Workflows / Tool Calling:](https://docs.pixeltable.com/docs/examples/chat/tools)** Register `@pxt.udf` or `@pxt.query` functions as tools and orchestrate LLM-based tool use (incl. multimodal).
+  ```python
+  # Example tools: a UDF and a Query function for RAG
+  tools = pxt.tools(get_weather_udf, search_context_query)
+
+  # LLM decides which tool to call; Pixeltable executes it
+  t.add_computed_column(
+       tool_output=invoke_tools(tools, t.llm_tool_choice)
+  )
+  ```
+
+* **[Persistent & Versioned:](https://docs.pixeltable.com/docs/datastore/tables-and-operations#data-operations)** All data, metadata, and computed results are automatically stored.
+  ```python
+  t.revert()  # Revert to a previous version
+  stored_table = pxt.get_table('my_existing_table')  # Retrieve persisted table
+  ```
+
+* **[SQL-like Python Querying:](https://docs.pixeltable.com/docs/datastore/filtering-and-selecting)** Familiar syntax combined with powerful AI capabilities.
+  ```python
+  results = (
+    t.where(t.score > 0.8)
+    .order_by(t.timestamp)
+    .select(t.image, score=t.score)
+    .limit(10)
+    .collect()
+  )
+  ```
+
+## 💡 Key Examples
+
+*(See the [Full Quick Start](https://docs.pixeltable.com/docs/overview/quick-start) or [Notebook Gallery](#-notebook-gallery) for more details)*
+
+**1. Multimodal Data Store and Data Transformation (Computed Column):**
+```bash
+pip install pixeltable
+```
+
+```python
+import pixeltable as pxt
+
+# Create a table
+t = pxt.create_table(
+    'films', 
+    {'name': pxt.String, 'revenue': pxt.Float, 'budget': pxt.Float}, 
+    if_exists="replace"
+)
+
+t.insert([
+  {'name': 'Inside Out', 'revenue': 800.5, 'budget': 200.0},
+  {'name': 'Toy Story', 'revenue': 1073.4, 'budget': 200.0}
+])
+
+# Add a computed column for profit - runs automatically!
+t.add_computed_column(profit=(t.revenue - t.budget), if_exists="replace")
+
+# Query the results
+print(t.select(t.name, t.profit).collect())
+# Output includes the automatically computed 'profit' column
+```
+
+**2. Object Detection with [YOLOX](https://github.com/pixeltable/pixeltable-yolox):**
+
+```bash
+pip install pixeltable pixeltable-yolox
+```
+
+```python
+import PIL
+import pixeltable as pxt
+from yolox.models import Yolox
+from yolox.data.datasets import COCO_CLASSES
+
+t = pxt.create_table('image', {'image': pxt.Image}, if_exists='replace')
+
+# Insert some images
+prefix = 'https://upload.wikimedia.org/wikipedia/commons'
+paths = [
+    '/1/15/Cat_August_2010-4.jpg',
+    '/e/e1/Example_of_a_Dog.jpg',
+    '/thumb/b/bf/Bird_Diversity_2013.png/300px-Bird_Diversity_2013.png'
+]
+t.insert({'image': prefix + p} for p in paths)
+
+@pxt.udf
+def detect(image: PIL.Image.Image) -> list[str]:
+    model = Yolox.from_pretrained("yolox_s")
+    result = model([image])
+    coco_labels = [COCO_CLASSES[label] for label in result[0]["labels"]]
+    return coco_labels
+
+t.add_computed_column(classification=detect(t.image))
+
+print(t.select().collect())
+```
+
+**3. Image Similarity Search (CLIP Embedding Index):**
+
+```bash
+pip install pixeltable sentence-transformers
+```
+
+```python
+import pixeltable as pxt
+from pixeltable.functions.huggingface import clip
+
+# Create image table and add sample images
+images = pxt.create_table('my_images', {'img': pxt.Image}, if_exists='replace')
+images.insert([
+    {'img': 'https://upload.wikimedia.org/wikipedia/commons/thumb/6/68/Orange_tabby_cat_sitting_on_fallen_leaves-Hisashi-01A.jpg/1920px-Orange_tabby_cat_sitting_on_fallen_leaves-Hisashi-01A.jpg'},
+    {'img': 'https://upload.wikimedia.org/wikipedia/commons/d/d5/Retriever_in_water.jpg'}
+])
+
+# Add CLIP embedding index for similarity search
+images.add_embedding_index(
+    'img',
+    embedding=clip.using(model_id='openai/clip-vit-base-patch32')
+)
+
+# Text-based image search
+query_text = "a dog playing fetch"
+sim_text = images.img.similarity(query_text)
+results_text = images.order_by(sim_text, asc=False).limit(3).select(
+    image=images.img, similarity=sim_text
+).collect()
+print("--- Text Query Results ---")
+print(results_text)
+
+# Image-based image search
+query_image_url = 'https://upload.wikimedia.org/wikipedia/commons/thumb/7/7a/Huskiesatrest.jpg/2880px-Huskiesatrest.jpg'
+sim_image = images.img.similarity(query_image_url)
+results_image = images.order_by(sim_image, asc=False).limit(3).select(
+    image=images.img, similarity=sim_image
+).collect()
+print("--- Image URL Query Results ---")
+print(results_image)
+```
+
+**4. Multimodal/Incremental RAG Workflow (Document Chunking & LLM Call):**
+
+```bash
+pip install pixeltable openai spacy sentence-transformers
+```
+
+```bash
+python -m spacy download en_core_web_sm
+```
+
+```python
+import pixeltable as pxt
+import pixeltable.functions as pxtf
+from pixeltable.functions import openai, huggingface
+from pixeltable.iterators import DocumentSplitter
+
+# Manage your tables by directories
+directory = "my_docs"
+pxt.drop_dir(directory, if_not_exists="ignore", force=True)
+pxt.create_dir("my_docs")
+
+# Create a document table and add a PDF
+docs = pxt.create_table(f'{directory}.docs', {'doc': pxt.Document})
+docs.insert([{'doc': 'https://github.com/pixeltable/pixeltable/raw/release/docs/resources/rag-demo/Jefferson-Amazon.pdf'}])
+
+# Create chunks view with sentence-based splitting
+chunks = pxt.create_view(
+    'doc_chunks',
+    docs,
+    iterator=DocumentSplitter.create(document=docs.doc, separators='sentence')
+)
+
+# Explicitly create the embedding function object
+embed_model = huggingface.sentence_transformer.using(model_id='all-MiniLM-L6-v2')
+# Add embedding index using the function object
+chunks.add_embedding_index('text', string_embed=embed_model)
+
+# Define query function for retrieval - Returns a DataFrame expression
+@pxt.query
+def get_relevant_context(query_text: str, limit: int = 3):
+    sim = chunks.text.similarity(query_text)
+    # Return a list of strings (text of relevant chunks)
+    return chunks.order_by(sim, asc=False).limit(limit).select(chunks.text)
+
+# Build a simple Q&A table
+qa = pxt.create_table(f'{directory}.qa_system', {'prompt': pxt.String})
+
+# 1. Add retrieved context (now a list of strings)
+qa.add_computed_column(context=get_relevant_context(qa.prompt))
+
+# 2. Format the prompt with context
+qa.add_computed_column(
+    final_prompt=pxtf.string.format(
+        """
+        PASSAGES: 
+        {0}
+        
+        QUESTION: 
+        {1}
+        """, 
+        qa.context, 
+        qa.prompt
+    )
+)
+
+# 4. Generate the answer using the well-formatted prompt column
+qa.add_computed_column(
+    answer=openai.chat_completions(
+        model='gpt-4o-mini',
+        messages=[{
+            'role': 'user',
+            'content': qa.final_prompt
+        }]
+    ).choices[0].message.content
+)
+
+# Ask a question and get the answer
+qa.insert([{'prompt': 'What can you tell me about Amazon?'}])
+print("--- Final Answer ---")
+print(qa.select(qa.answer).collect())
+```
+
+## 📚 Notebook Gallery
+
+Explore Pixeltable's capabilities interactively:
+
+| Topic | Notebook | Topic | Notebook |
+|:----------|:-----------------|:-------------------------|:---------------------------------:|
+| **Fundamentals** | | **Integrations** | |
+| 10-Min Tour | <a target="_blank" href="https://colab.research.google.com/github/pixeltable/pixeltable/blob/release/docs/notebooks/pixeltable-basics.ipynb"> <img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/> </a> | OpenAI | <a target="_blank" href="https://colab.research.google.com/github/pixeltable/pixeltable/blob/release/docs/notebooks/integrations/working-with-openai.ipynb"> <img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/> </a> |
+| Tables & Ops | <a target="_blank" href="https://colab.research.google.com/github/pixeltable/pixeltable/blob/release/docs/notebooks/fundamentals/tables-and-data-operations.ipynb"> <img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/> </a> | Anthropic | <a target="_blank" href="https://colab.research.google.com/github/pixeltable/pixeltable/blob/release/docs/notebooks/integrations/working-with-anthropic.ipynb"> <img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/> </a> |
+| UDFs | <a target="_blank" href="https://colab.research.google.com/github/pixeltable/pixeltable/blob/release/docs/notebooks/feature-guides/udfs-in-pixeltable.ipynb"> <img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/> </a> | Together AI | <a target="_blank" href="https://colab.research.google.com/github/pixeltable/pixeltable/blob/release/docs/notebooks/integrations/working-with-together.ipynb"> <img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/> </a> |
+| Embedding Index | <a target="_blank" href="https://colab.research.google.com/github/pixeltable/pixeltable/blob/release/docs/notebooks/feature-guides/embedding-and-vector-indexes.ipynb"> <img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/> </a> | Label Studio | <a target="_blank" href="https://docs.pixeltable.com/docs/cookbooks/vision/label-studio"> <img src="https://img.shields.io/badge/📚%20Docs-013056" alt="Visit Docs"/></a> |
+| External Files | <a target="_blank" href="https://colab.research.google.com/github/pixeltable/pixeltable/blob/release/docs/notebooks/feature-guides/working-with-external-files.ipynb"> <img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/> </a> | Mistral | <a target="_blank" href="https://colab.research.google.com/github/mistralai/cookbook/blob/main/third_party/Pixeltable/incremental_prompt_engineering_and_model_comparison.ipynb"> <img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Github"/> |
+| **Use Cases** | | **Sample Apps** | |
+| RAG Demo | <a target="_blank" href="https://colab.research.google.com/github/pixeltable/pixeltable/blob/release/docs/notebooks/use-cases/rag-demo.ipynb">  <img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/> | Multimodal Agent | <a target="_blank" href="https://huggingface.co/spaces/Pixeltable/Multimodal-Powerhouse"> <img src="https://img.shields.io/badge/🤗%20Demo-FF7D04" alt="HF Space"/></a> |
+| Object Detection | <a target="_blank" href="https://colab.research.google.com/github/pixeltable/pixeltable/blob/release/docs/notebooks/use-cases/object-detection-in-videos.ipynb"> <img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/> </a> | Image/Text Search | <a target="_blank" href="https://github.com/pixeltable/pixeltable/tree/main/docs/sample-apps/text-and-image-similarity-search-nextjs-fastapi">  <img src="https://img.shields.io/badge/🖥️%20App-black.svg" alt="GitHub App"/> |
+| Audio Transcription | <a target="_blank" href="https://colab.research.google.com/github/pixeltable/pixeltable/blob/release/docs/notebooks/use-cases/audio-transcriptions.ipynb">  <img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/> | Discord Bot | <a target="_blank" href="https://github.com/pixeltable/pixeltable/blob/main/docs/sample-apps/context-aware-discord-bot"> <img src="https://img.shields.io/badge/%F0%9F%92%AC%20Bot-%235865F2.svg" alt="GitHub App"/></a> |
+
+## 🔮 Roadmap (2025)
+
+### Cloud Infrastructure and Deployment
+We're working on a hosted Pixeltable service that will:
+
+- Enable Multimodal Data Sharing of Pixeltable Tables and Views
+- Provide a persistent cloud instance
+- Turn Pixeltable workflows (Tables, Queries, UDFs) into API endpoints/[MCP Servers](https://github.com/pixeltable/pixeltable-mcp-server)
+
+## 🤝 Contributing
+
+We love contributions! Whether it's reporting bugs, suggesting features, improving documentation, or submitting code changes, please check out our [Contributing Guide](CONTRIBUTING.md) and join the [Discussions](https://github.com/pixeltable/pixeltable/discussions) or our [Discord Server](https://discord.gg/QPyqFYx2UN).
+
+## 🏢 License
+
+Pixeltable is licensed under the Apache 2.0 License.
+