Update README.md
Browse files# A11YBench
## 😃Dataset Summary
A11YBench consists of 60 real-world web projects, encompassing 145 web pages and 8,874 accessibility violations detected by the IBM Accessibility Checker (4.0.9).
The projects vary substantially in size, from 123 to 43,198 source files and from 3,610 to 1,555,532 lines of code, covering both lightweight documentation sites and large production-grade applications.
This scale ensures that A11YBench reflects the structural and technical diversity of modern web ecosystems.
## 🚀Dataset Features
Real-world accessibility violations extracted from popular open-source web repositories.
Multi-domain coverage including UI libraries, developer tools, cloud platforms, documentation sites, and more.
Two configurations:
A11YBench-Lite – small, quick-to-run subset (10 repos).
A11YBench-Full – complete benchmark with all collected repositories.
## 📃How to use it?
### 📥 Downloading the Dataset
You can download via HuggingFace Hub:
```bash
git lfs install
git clone https://huggingface.co/datasets/LLM4APR/A11YBench
```
Or load directly in Python:
```bash
from datasets import load_dataset
ds = load_dataset("LLM4APR/A11YBench")
```
### 🧩 Installing Project Instances
Before running any repair task, you must locally checkout and install the dependencies for each project included in the benchmark.
This setup requires a one-time manual installation and is typically fast and straightforward.
Make sure you have the following installed:
· Node.js
· npm
· pnpm
· yarn
Below is an example setup process using the repository ***microsoft/TypeScript-Website***.
1. Clone the repository
'''bash
git clone https://github.com/microsoft/TypeScript-Website.git
'''
2. Checkout the version used in A11YBench
'''bash
git checkout 1019cfc8f96ded4729e8ccd342742534a9826a9d
'''
3. Install dependencies and start the project
'''bash
pnpm install && pnpm bootstrap && pnpm start
'''
Once the installation finishes, the project will be served locally.
### 🚀 Launching the Repair Workflow
With the project successfully running locally, you can open the webpage in your browser:
👉 http://localhost:8000/
You should see a page similar to this:
### 🧪 Generating Accessibility Violations
Next, use any Web Accessibility Checker to detect A11Y violations on the active page.
We recommend: ***IBM Accessibility Checker***
These tools will generate a Violation Report, which can be passed to your repair system to perform automated A11Y fixing.