CONTRIBUTING.md

# Contributing images

Submit images and their JSON entries together in one pull request. Images are accepted into the official dataset only after the owner or an authorized maintainer reviews and merges the PR. A public PR's files can be visible before that review.

## Detection examples

Download the current catalog into a submission directory:

```bash
hf download EnXan/VIPI-evaluation detection_eval/cases.json --repo-type dataset --local-dir submission
mkdir -p submission/detection_eval/images
```

Add your image under `submission/detection_eval/images/` and update `submission/detection_eval/cases.json`. Follow the existing format and [suite guide](detection_eval/README.md). Group context variants under the same image entry. Record payload text exactly as it appears, including encoded text. Describe the image source or synthetic generation method and applicable license in the PR description.

Open a PR with only your images and catalog changes:

```bash
hf auth login
hf upload EnXan/VIPI-evaluation submission . --repo-type dataset --create-pr --include 'detection_eval/cases.json' --include 'detection_eval/images/*' --commit-message 'Add detection evaluation image'
```

For OCR contributions, use `ocr_eval/catalog.json` and `ocr_eval/images/` instead. Preserve exact reference text, scope, reading order, word regions and source provenance; follow the existing record format in [the OCR suite guide](ocr_eval/README.md).

You can also submit through the Hub website by choosing **Open as a pull request** when uploading files. Updates to an existing PR can use `hf upload ... --revision refs/pr/NUMBER` instead of creating another PR.

## Maintainer review

Review the image itself, the expected classification and caller context, the exact transcript, source/usage information and whether it adds useful coverage. Keep filenames unique, retain existing record identifiers, and confirm every referenced image exists. Approve by merging the PR; close submissions that should not enter the dataset. Do not grant write access for ordinary contributions.

A merged dataset commit is available for users who choose that revision. The VIPI code repository intentionally stays on its pinned revision until a separate update changes `research/dataset.json`.