docs/underthesea_integration.md

Underthesea Integration

This document describes how to integrate UVW 2026 into the underthesea project.

1. Add to datasets.yaml

Add the following entry to underthesea/datasets.yaml:

UVW_2026:
  cache_dir: datasets/UVW_2026
  type: Plaintext
  license: Open
  year: 2026
  filepath: ''
  url: https://github.com/undertheseanlp/underthesea/releases/download/resources/UVW_2026.zip
  url_filename: UVW_2026.zip

2. Create Release Package

Package the processed data for release:

cd data/processed
zip -r UVW_2026.zip plaintext/ uvw_2026.jsonl metadata.json

Upload UVW_2026.zip to GitHub releases.

3. Usage with DataFetcher

from underthesea import DataFetcher

# List available datasets
DataFetcher.list()

# Download and load corpus
corpus = DataFetcher.load_corpus("UVW_2026")

# Access data
for doc in corpus:
    print(doc)

4. HuggingFace Hub Upload

# Login to HuggingFace
huggingface-cli login

# Create dataset repository
huggingface-cli repo create UVW-2026 --type dataset --organization undertheseanlp

# Upload parquet files
cd data/huggingface/uvw_2026_parquet
huggingface-cli upload undertheseanlp/UVW-2026 . --repo-type dataset

# Upload README
cd ..
huggingface-cli upload undertheseanlp/UVW-2026 README.md --repo-type dataset

5. Integration Tests

Add test to tests/test_corpus.py:

def test_uvw_2026():
    from underthesea import DataFetcher

    corpus = DataFetcher.load_corpus("UVW_2026")
    assert corpus is not None

    # Check first document
    docs = list(corpus)
    assert len(docs) > 0

6. Documentation

Add dataset documentation to docs/datasets/UVW-2026.md in the underthesea repository (see docs/UVW-2026.md in this project).