genarena 0.0.1__tar.gz → 0.1.0__tar.gz

genarena-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,72 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - "v*"  # Trigger on tags like v0.1.0, v1.0.0, etc.
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install build dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Upload distribution artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+  create-release:
+    name: Create GitHub Release
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write  # Required for creating releases
+    steps:
+      - name: Download distribution artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: dist/*
+          generate_release_notes: true
+
+  publish-to-pypi:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/genarena
+    permissions:
+      id-token: write  # Required for trusted publishing
+
+    steps:
+      - name: Download distribution artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

genarena-0.1.0/.gitignore

@@ -0,0 +1,207 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

genarena-0.1.0/PKG-INFO

@@ -0,0 +1,178 @@
+Metadata-Version: 2.4
+Name: genarena
+Version: 0.1.0
+Summary: GenArena Arena Evaluation - VLM-based pairwise image generation evaluation
+Author: GenArena Team
+License: Apache-2.0
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.10
+Requires-Dist: datasets>=2.0.0
+Requires-Dist: huggingface-hub>=0.20.0
+Requires-Dist: json-repair>=0.25.0
+Requires-Dist: openai>=1.0.0
+Requires-Dist: pandas>=2.0.0
+Requires-Dist: pillow>=9.0.0
+Requires-Dist: pyarrow>=12.0.0
+Requires-Dist: tqdm>=4.65.0
+Provides-Extra: web
+Requires-Dist: flask>=2.0.0; extra == 'web'
+Description-Content-Type: text/markdown
+
+# GenArena
+
+A unified evaluation framework for visual generation tasks using VLM-based pairwise comparison and Elo ranking.
+
+[![arXiv](https://img.shields.io/badge/arXiv-2602.XXXXX-b31b1b.svg)](https://arxiv.org/abs/2602.XXXXX)
+[![Project Page](https://img.shields.io/badge/Project-Website-orange)](https://genarena.github.io)
+[![Leaderboard](https://img.shields.io/badge/%F0%9F%8F%86%20Leaderboard-Live-brightgreen)](https://huggingface.co/spaces/genarena/leaderboard)
+[![Hugging Face](https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-GenArena-yellow)](https://huggingface.co/datasets/rhli/genarena)
+
+
+## Abstract
+
+The rapid advancement of visual generation models has outpaced traditional evaluation approaches, necessitating the adoption of Vision-Language Models as surrogate judges. In this work, we systematically investigate the reliability of the prevailing absolute pointwise scoring standard, across a wide spectrum of visual generation tasks. Our analysis reveals that this paradigm is limited due to stochastic inconsistency and poor alignment with human perception. To resolve these limitations, we introduce **GenArena**, a unified evaluation framework that leverages a *pairwise comparison* paradigm to ensure stable and human-aligned evaluation. Crucially, our experiments uncover a transformative finding that simply adopting this pairwise protocol enables off-the-shelf open-source models to outperform top-tier proprietary models. Notably, our method boosts evaluation accuracy by over 20% and achieves a Spearman correlation of 0.86 with the authoritative LMArena leaderboard, drastically surpassing the 0.36 correlation of pointwise methods. Based on GenArena, we benchmark state-of-the-art visual generation models across diverse tasks, providing the community with a rigorous and automated evaluation standard for visual generation.
+
+## Quick Start
+
+### Installation
+
+```bash
+pip install genarena
+```
+
+Or install from source:
+
+```bash
+git clone https://github.com/ruihanglix/genarena.git
+cd genarena
+pip install -e .
+```
+
+### Initialize Arena
+
+Download benchmark data and official arena data with one command:
+
+```bash
+genarena init --arena_dir ./arena --data_dir ./data
+```
+
+This downloads:
+- Benchmark Parquet data from `rhli/genarena` (HuggingFace)
+- Official arena data (model outputs + battle logs) from `rhli/genarena-battlefield`
+
+### Environment Setup
+
+Set your VLM API credentials:
+
+```bash
+export OPENAI_API_KEY="your-api-key"
+export OPENAI_BASE_URL="https://api.example.com/v1"
+```
+
+For multi-endpoint support (load balancing and failover), use comma-separated values:
+
+```bash
+export OPENAI_BASE_URLS="https://api1.example.com/v1,https://api2.example.com/v1"
+export OPENAI_API_KEYS="key1,key2,key3"
+```
+
+### Run Evaluation
+
+```bash
+genarena run --arena_dir ./arena --data_dir ./data
+```
+
+### View Leaderboard
+
+```bash
+genarena leaderboard --arena_dir ./arena --subset basic
+```
+
+### Check Status
+
+```bash
+genarena status --arena_dir ./arena --data_dir ./data
+```
+
+## Running Your Own Experiments
+
+### Directory Structure
+
+To add your own model for evaluation, organize outputs in the following structure:
+
+```
+arena_dir/
+└── <subset>/
+    └── models/
+        └── <GithubID>_<modelName>_<yyyymmdd>/
+            └── <model_name>/
+                ├── 000000.png
+                ├── 000001.png
+                └── ...
+```
+
+For example:
+```
+arena/basic/models/johndoe_MyNewModel_20260205/MyNewModel/
+```
+
+### Generate Images with Diffgentor
+
+Use [Diffgentor](https://github.com/ruihanglix/diffgentor) to batch generate images for evaluation:
+
+```bash
+# Download benchmark data
+hf download rhli/genarena --repo-type dataset --local-dir ./data
+
+# Generate images with your model
+diffgentor edit --backend diffusers \
+    --model_name YourModel \
+    --input ./data/basic/ \
+    --output_dir ./arena/basic/models/yourname_YourModel_20260205/YourModel/
+```
+
+### Run Battles for New Models
+
+```bash
+genarena run --arena_dir ./arena --data_dir ./data \
+    --subset basic \
+    --exp_name yourname_YourModel_20260205
+```
+
+GenArena automatically detects new models and schedules battles against existing models.
+
+## Submit to Official Leaderboard
+
+> **Coming Soon**: The `genarena submit` command will allow you to submit your evaluation results to the official GenArena leaderboard via GitHub PR.
+
+The workflow will be:
+1. Run evaluation locally with `genarena run`
+2. Upload results to your HuggingFace repository
+3. Submit via `genarena submit` which creates a PR for review
+
+## Documentation
+
+| Document | Description |
+|----------|-------------|
+| [Quick Start](./docs/quickstart.md) | Installation and basic usage guide |
+| [Architecture](./docs/architecture.md) | System design and key concepts |
+| [CLI Reference](./docs/cli-reference.md) | Complete command-line interface documentation |
+| [Experiment Management](./docs/experiments.md) | How to organize and manage experiments |
+| [FAQ](./docs/faq.md) | Frequently asked questions |
+
+## Citation
+
+```bibtex
+TBD
+```
+
+## License
+
+Apache License 2.0

genarena-0.1.0/README.md

@@ -0,0 +1,151 @@
+# GenArena
+
+A unified evaluation framework for visual generation tasks using VLM-based pairwise comparison and Elo ranking.
+
+[![arXiv](https://img.shields.io/badge/arXiv-2602.XXXXX-b31b1b.svg)](https://arxiv.org/abs/2602.XXXXX)
+[![Project Page](https://img.shields.io/badge/Project-Website-orange)](https://genarena.github.io)
+[![Leaderboard](https://img.shields.io/badge/%F0%9F%8F%86%20Leaderboard-Live-brightgreen)](https://huggingface.co/spaces/genarena/leaderboard)
+[![Hugging Face](https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-GenArena-yellow)](https://huggingface.co/datasets/rhli/genarena)
+
+
+## Abstract
+
+The rapid advancement of visual generation models has outpaced traditional evaluation approaches, necessitating the adoption of Vision-Language Models as surrogate judges. In this work, we systematically investigate the reliability of the prevailing absolute pointwise scoring standard, across a wide spectrum of visual generation tasks. Our analysis reveals that this paradigm is limited due to stochastic inconsistency and poor alignment with human perception. To resolve these limitations, we introduce **GenArena**, a unified evaluation framework that leverages a *pairwise comparison* paradigm to ensure stable and human-aligned evaluation. Crucially, our experiments uncover a transformative finding that simply adopting this pairwise protocol enables off-the-shelf open-source models to outperform top-tier proprietary models. Notably, our method boosts evaluation accuracy by over 20% and achieves a Spearman correlation of 0.86 with the authoritative LMArena leaderboard, drastically surpassing the 0.36 correlation of pointwise methods. Based on GenArena, we benchmark state-of-the-art visual generation models across diverse tasks, providing the community with a rigorous and automated evaluation standard for visual generation.
+
+## Quick Start
+
+### Installation
+
+```bash
+pip install genarena
+```
+
+Or install from source:
+
+```bash
+git clone https://github.com/ruihanglix/genarena.git
+cd genarena
+pip install -e .
+```
+
+### Initialize Arena
+
+Download benchmark data and official arena data with one command:
+
+```bash
+genarena init --arena_dir ./arena --data_dir ./data
+```
+
+This downloads:
+- Benchmark Parquet data from `rhli/genarena` (HuggingFace)
+- Official arena data (model outputs + battle logs) from `rhli/genarena-battlefield`
+
+### Environment Setup
+
+Set your VLM API credentials:
+
+```bash
+export OPENAI_API_KEY="your-api-key"
+export OPENAI_BASE_URL="https://api.example.com/v1"
+```
+
+For multi-endpoint support (load balancing and failover), use comma-separated values:
+
+```bash
+export OPENAI_BASE_URLS="https://api1.example.com/v1,https://api2.example.com/v1"
+export OPENAI_API_KEYS="key1,key2,key3"
+```
+
+### Run Evaluation
+
+```bash
+genarena run --arena_dir ./arena --data_dir ./data
+```
+
+### View Leaderboard
+
+```bash
+genarena leaderboard --arena_dir ./arena --subset basic
+```
+
+### Check Status
+
+```bash
+genarena status --arena_dir ./arena --data_dir ./data
+```
+
+## Running Your Own Experiments
+
+### Directory Structure
+
+To add your own model for evaluation, organize outputs in the following structure:
+
+```
+arena_dir/
+└── <subset>/
+    └── models/
+        └── <GithubID>_<modelName>_<yyyymmdd>/
+            └── <model_name>/
+                ├── 000000.png
+                ├── 000001.png
+                └── ...
+```
+
+For example:
+```
+arena/basic/models/johndoe_MyNewModel_20260205/MyNewModel/
+```
+
+### Generate Images with Diffgentor
+
+Use [Diffgentor](https://github.com/ruihanglix/diffgentor) to batch generate images for evaluation:
+
+```bash
+# Download benchmark data
+hf download rhli/genarena --repo-type dataset --local-dir ./data
+
+# Generate images with your model
+diffgentor edit --backend diffusers \
+    --model_name YourModel \
+    --input ./data/basic/ \
+    --output_dir ./arena/basic/models/yourname_YourModel_20260205/YourModel/
+```
+
+### Run Battles for New Models
+
+```bash
+genarena run --arena_dir ./arena --data_dir ./data \
+    --subset basic \
+    --exp_name yourname_YourModel_20260205
+```
+
+GenArena automatically detects new models and schedules battles against existing models.
+
+## Submit to Official Leaderboard
+
+> **Coming Soon**: The `genarena submit` command will allow you to submit your evaluation results to the official GenArena leaderboard via GitHub PR.
+
+The workflow will be:
+1. Run evaluation locally with `genarena run`
+2. Upload results to your HuggingFace repository
+3. Submit via `genarena submit` which creates a PR for review
+
+## Documentation
+
+| Document | Description |
+|----------|-------------|
+| [Quick Start](./docs/quickstart.md) | Installation and basic usage guide |
+| [Architecture](./docs/architecture.md) | System design and key concepts |
+| [CLI Reference](./docs/cli-reference.md) | Complete command-line interface documentation |
+| [Experiment Management](./docs/experiments.md) | How to organize and manage experiments |
+| [FAQ](./docs/faq.md) | Frequently asked questions |
+
+## Citation
+
+```bibtex
+TBD
+```
+
+## License
+
+Apache License 2.0

genarena-0.1.0/docs/README.md

@@ -0,0 +1,37 @@
+# GenArena Documentation
+
+GenArena is a VLM-based pairwise evaluation system for image generation models using Bradley-Terry ELO ranking.
+
+## Documentation Structure
+
+| Document | Description |
+|----------|-------------|
+| [Quick Start](./quickstart.md) | Installation and basic usage guide |
+| [Architecture](./architecture.md) | System design and key concepts |
+| [CLI Reference](./cli-reference.md) | Complete command-line interface documentation |
+| [Experiment Management](./experiments.md) | How to organize and manage experiments |
+| [FAQ](./faq.md) | Frequently asked questions |
+
+## Key Features
+
+- **Pairwise Evaluation**: Compare image generation models head-to-head using VLM judges
+- **Position Debiasing**: Double-call swap method to eliminate position bias
+- **Bradley-Terry ELO**: Order-independent batch scoring (not online K-factor)
+- **Incremental Evaluation**: Add new models without re-running historical battles
+- **Milestone Anchoring**: Stable ELO scores across experiments via anchored fitting
+- **Adaptive Sampling**: CI-based sampling to achieve target confidence efficiently
+- **Multi-endpoint Support**: Load balancing across multiple VLM API endpoints
+- **Git/HuggingFace Sync**: Built-in version control and dataset sharing
+
+## Quick Links
+
+- **Installation**: `uv pip install -e .`
+- **Run battles**: `genarena run --arena_dir <path> --data_dir <path>`
+- **View leaderboard**: `genarena leaderboard --arena_dir <path> --subset basic`
+- **Start visualization**: `genarena serve --arena_dir <path> --data_dir <path>`
+
+## System Requirements
+
+- Python 3.10+
+- VLM API access (OpenAI-compatible endpoint)
+- Parquet dataset with prompts and model outputs