Skip to main content

Bridge HuggingFace datasets with Apache Iceberg

Project description

Faceberg

Faceberg

Bridge HuggingFace datasets with Apache Iceberg tables — no data copying, just metadata.

Faceberg maps HuggingFace datasets to Apache Iceberg tables. Your catalog metadata lives on HuggingFace Spaces with an auto-deployed REST API, and any Iceberg-compatible query engine can access the data.

Installation

pip install faceberg

Quick Start

export HF_TOKEN=your_huggingface_token

# Create a catalog on HuggingFace Hub
faceberg user/mycatalog init

# Add datasets
faceberg user/mycatalog add stanfordnlp/imdb --config plain_text
faceberg user/mycatalog add openai/gsm8k --config main

# Query with interactive DuckDB shell
faceberg user/mycatalog quack
SELECT label, substr(text, 1, 100) as preview
FROM iceberg_catalog.stanfordnlp.imdb
LIMIT 10;

How It Works

HuggingFace Hub
┌─────────────────────────────────────────────────────────┐
│                                                         │
│  ┌─────────────────────┐    ┌─────────────────────────┐ │
│  │  HF Datasets        │    │  HF Spaces (Catalog)    │ │
│  │  (Original Parquet) │◄───│  • Iceberg metadata     │ │
│  │                     │    │  • REST API endpoint    │ │
│  │  stanfordnlp/imdb/  │    │  • faceberg.yml         │ │
│  │   └── *.parquet     │    │                         │ │
│  └─────────────────────┘    └───────────┬─────────────┘ │
│                                         │               │
└─────────────────────────────────────────┼───────────────┘
                                          │ Iceberg REST API
                                          ▼
                              ┌─────────────────────────┐
                              │     Query Engines       │
                              │  DuckDB, Pandas, Spark  │
                              └─────────────────────────┘

No data is copied — only metadata is created. Query with DuckDB, PyIceberg, Spark, or any Iceberg-compatible tool.

Python API

import os
from faceberg import catalog

cat = catalog("user/mycatalog", hf_token=os.environ.get("HF_TOKEN"))
table = cat.load_table("stanfordnlp.imdb")
df = table.scan(limit=100).to_pandas()

Share Your Catalog

Your catalog is accessible to anyone via the REST API:

import duckdb

conn = duckdb.connect()
conn.execute("INSTALL iceberg; LOAD iceberg")
conn.execute("ATTACH 'https://user-mycatalog.hf.space' AS cat (TYPE ICEBERG)")

result = conn.execute("SELECT * FROM cat.stanfordnlp.imdb LIMIT 5").fetchdf()

Documentation

Read the docs →

Development

git clone https://github.com/kszucs/faceberg
cd faceberg
pip install -e .

License

Apache 2.0

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

faceberg-0.3.0.tar.gz (85.3 kB view details)

Uploaded Source

Built Distribution

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

faceberg-0.3.0-py3-none-any.whl (93.3 kB view details)

Uploaded Python 3

File details

Details for the file faceberg-0.3.0.tar.gz.

File metadata

  • Download URL: faceberg-0.3.0.tar.gz
  • Upload date:
  • Size: 85.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for faceberg-0.3.0.tar.gz
Algorithm Hash digest
SHA256 0de0490d6b2f646a4173ef6a609948eb81d0fe3d2347fd6eff11f63e6a15727b
MD5 18911162dec15c86c0581f268e9222e0
BLAKE2b-256 b4616f7d2a1e65ee980b43013222c96a2621cf1a55a3da95df90656e02cd382c

See more details on using hashes here.

Provenance

The following attestation bundles were made for faceberg-0.3.0.tar.gz:

Publisher: main.yml on kszucs/faceberg

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file faceberg-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: faceberg-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 93.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for faceberg-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 db4916da7c182a07fc36f132d6d6261ab57f672157d50a1d89b0479d00158b4e
MD5 77244594fd8712186250c18a78ce2d5b
BLAKE2b-256 91f5d21a738f766c4db778ea0adf42270150cbc84f7855334d24ac106cfe4e78

See more details on using hashes here.

Provenance

The following attestation bundles were made for faceberg-0.3.0-py3-none-any.whl:

Publisher: main.yml on kszucs/faceberg

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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