Update README.md

README.md

@@ -2,6 +2,16 @@
 language:
 - pt
 pretty_name: ParlaSpoof-BR
+license: cc-by-4.0
+tags:
+- audio
+- deepfake-detection
+- anti-spoofing
+- brazilian-portuguese
+- political-speech
+- text-to-speech
+- voice-conversion
+- speech-infilling
 task_categories:
 - audio-classification
 size_categories:
@@ -103,13 +113,294 @@ dataset_info:
 
 # ParlaSpoof-BR
 
-Brazilian Portuguese speech dataset for bona fide and spoofed speech research.
-Audio is embedded as an `Audio` feature in Parquet shards. WAV bytes are preserved
-without transcoding; Zstandard compression is applied at the Parquet layer.
-The compact view keeps the fields listed in the data schema. Complete source metadata
-is available in `metadata/metadata_complete.parquet`, with CSV values preserved as strings.
+**Benchmark de deepfakes de áudio em português brasileiro, construído a partir de falas parlamentares da Câmara dos Deputados.**
 
-Load the default split with `datasets.load_dataset("freds0/ParlaSpoof-BR")`
-after selecting or merging the `vf-parquet` revision.
+ParlaSpoof-BR reúne gravações reais, síntese de voz por texto (*text-to-speech*, TTS), conversão de voz (*voice conversion*, VC) e manipulações parciais por *speech infilling*. O conjunto permite estudar a generalização de detectores para o domínio político brasileiro, a robustez a transformações acústicas e diferenças de desempenho entre condições de geração e grupos demográficos.
 
-No license is declared here; confirm the source license before publishing.
+O benchmark é apresentado no artigo [Cloned Voices, Real Consequences: Evaluating Bias in Political Deepfake Detection for Electoral Integrity in Brazil](https://arxiv.org/abs/2607.28770v2). Exemplos de áudio estão disponíveis na [página de demonstração](https://ermisai.github.io/parlaspoof-br-demo/).
+
+## Visão geral
+
+| Característica | Valor |
+| --- | --- |
+| Idioma | Português brasileiro |
+| Domínio | Discurso parlamentar |
+| Participantes na base de origem | 40: 20 homens e 20 mulheres, conforme os metadados |
+| Gravações reais de origem usadas no benchmark | 2.000, com 50 por participante |
+| Total de registros de áudio, incluindo derivações | **139.200** |
+| Classe `real` (*bona fide*) | **11.200** |
+| Classe `fake` (*spoof*) | **128.000** |
+| Duração acumulada das variantes | Aproximadamente **526,70 horas** |
+| Distribuição | 140 shards de áudio em Parquet, metadados completos e manifesto |
+| Tamanho da exportação | Aproximadamente 62,96 GB, ou 58,64 GiB |
+| Split disponível no Hub | `train`, contendo o benchmark completo |
+
+As 526,70 horas somam as durações registradas nos metadados de todas as variantes. **Esse total não corresponde a 526,70 horas de falas independentes**: várias versões compartilham a mesma fala de origem.
+
+## Origem e seleção das falas
+
+As gravações reais foram obtidas do [Acervo Sonoro da Câmara dos Deputados](https://imagem.camara.leg.br/internet/audio/). Segundo o artigo, a coleta compreende o período de 1º de janeiro de 2024 a 1º de julho de 2026. Os registros preservam características do ambiente parlamentar, incluindo reverberação, variações de microfone e interferências de fundo.
+
+Foram selecionados 40 participantes, com 50 falas por participante. O protocolo descrito no artigo também utiliza cinco segmentos adicionais de pelo menos dez segundos por participante como referências de clonagem, separados das 2.000 gravações reais de avaliação. Essas referências não integram a contagem de 139.200 áudios desta exportação.
+
+A base real apresenta a seguinte distribuição regional, conferida nos metadados:
+
+| Região | Participantes |
+| --- | ---: |
+| Centro-Oeste | 6 |
+| Nordeste | 8 |
+| Norte | 7 |
+| Sudeste | 11 |
+| Sul | 8 |
+| **Total** | **40** |
+
+A seleção tem paridade de gênero na base de origem e cobertura das cinco regiões, mas não tem quantidades iguais por região. As contagens por gênero e região de todas as variantes também dependem do pareamento entre participantes e das transformações aplicadas.
+
+## Composição do benchmark
+
+| Classe | Condição | Áudios |
+| --- | --- | ---: |
+| `real` | Gravações reais originais | 2.000 |
+| `real` | Gravações reais após aprimoramento de fala | 6.000 |
+| `real` | Variantes reais após MP3/OGG e decodificação para WAV | 3.200 |
+| **Subtotal `real`** | | **11.200** |
+| `fake` | TTS: cinco sistemas | 10.000 |
+| `fake` | VC: cinco sistemas | 10.000 |
+| `fake` | Manipulações parciais por infilling | 16.000 |
+| `fake` | Variantes TTS/VC com ruído babble | 60.000 |
+| `fake` | Variantes falsas após MP3/OGG e decodificação para WAV | 32.000 |
+| **Subtotal `fake`** | | **128.000** |
+| **Total** | | **139.200** |
+
+`real` significa fala de origem real, incluindo suas versões aprimoradas ou submetidas a codecs. Portanto, nem todo áudio `real` é uma gravação sem processamento. Analogamente, um áudio `fake` pode preservar as palavras originais e ainda assim conter voz sintetizada ou convertida.
+
+### Síntese e conversão de voz
+
+O protocolo utiliza pares de participantes distintos: um fornece a identidade vocal de destino e o outro fornece o conteúdo linguístico ou o áudio de origem.
+
+| Modalidade | Sistemas | Áudios sem babble ou codec |
+| --- | --- | ---: |
+| TTS | Chatterbox Multilingual, XTTS-v2, OmniVoice, VoxCPM2 e Qwen3-TTS | 10.000 |
+| VC | EZ-VC, kNN-VC, OpenVoice-v2, Seed-VC e X-VC | 10.000 |
+
+Cada sistema contribui com 2.000 áudios nessa base de síntese/conversão. As contagens por gerador no benchmark completo também incluem derivações com ruído e codecs; elas não devem ser interpretadas como contagens de falas independentes.
+
+### Manipulações parciais
+
+O artigo descreve o uso do infilling nativo do OmniVoice, orientado por alinhamentos temporais de palavras, para substituir somente uma região do áudio. Há duas variantes de localização:
+
+- **Full:** a região modificada pode ocorrer ao longo da fala.
+- **Short:** a seleção da região modificada fica restrita aos primeiros quatro segundos. O restante da gravação é preservado; isso não significa que o arquivo inteiro tenha quatro segundos.
+
+Cada variante contém quatro condições de 2.000 áudios, totalizando 16.000 registros:
+
+| Condição | Full | Short | Objetivo |
+| --- | ---: | ---: | --- |
+| 25% | 2.000 | 2.000 | Ressintetizar uma sequência contígua de palavras, mantendo o texto |
+| 50% | 2.000 | 2.000 | Ressintetizar uma sequência contígua de palavras, mantendo o texto |
+| 75% | 2.000 | 2.000 | Ressintetizar uma sequência contígua de palavras, mantendo o texto |
+| LLM Attack | 2.000 | 2.000 | Introduzir alterações semânticas orientadas por um modelo de linguagem |
+
+Os percentuais fazem parte do protocolo de seleção de palavras; não devem ser tratados como frações exatas da duração em segundos. Para localizar a intervenção, consulte `infill_start_time`, `infill_end_time` e os metadados completos, quando preenchidos.
+
+O protocolo do artigo prevê categorias semânticas como antonímia, números, nomes, expressões e negação. Os valores preenchidos de `attack_type` nesta exportação incluem `ANTONYM`, `NUMBER` e `NEGATION`, além de `percentage` para ressíntese sem troca de texto. Não se deve supor que todas as categorias previstas pelo protocolo estejam representadas nos arquivos.
+
+### Condições de robustez
+
+- **Aprimoramento de fala:** Demucs, Resemble Enhance e SpeechBrain/MetricGAN+, com 2.000 versões reais por sistema.
+- **Babble:** adição de interferência de fala aos 20.000 áudios TTS/VC, com SNR de 20, 15 e 10 dB. São 20.000 variantes por nível, totalizando 60.000. Essa etapa não é aplicada à base real nem ao infilling.
+- **Codecs:** conversão para MP3 ou OGG, seguida de decodificação para WAV. Há 17.600 áudios por codec, totalizando 35.200; os metadados registram bitrate de `16k`. A seleção exclui infilling e referências de clonagem.
+
+## Organização dos arquivos
+
+```text
+ParlaSpoof-BR/
+├── README.md
+├── dataset_manifest.json
+├── data/
+│   ├── train-00000.parquet
+│   ├── train-00001.parquet
+│   └── ... train-00139.parquet
+└── metadata/
+    └── metadata_complete.parquet
+```
+
+Os 140 shards contêm os bytes dos arquivos WAV na coluna `audio`, acompanhados de metadados selecionados. São 1.000 registros por shard, exceto o último, com 200. A exportação usa compressão Zstandard no Parquet e preserva os bytes WAV de entrada, sem recodificar o áudio durante o empacotamento.
+
+`metadata/metadata_complete.parquet` contém uma linha por áudio e preserva todas as colunas de `metadata_complete.csv` como texto. O CSV completo, o CSV reduzido `metadata_model.csv` e os JSONs auxiliares da árvore de origem não são distribuídos como arquivos separados nesta exportação. `dataset_manifest.json` documenta o esquema e os shards preparados.
+
+### Formato de áudio
+
+Todos os arquivos de origem empacotados são WAV PCM de 16 bits. **A taxa de amostragem e o número de canais não são uniformes:**
+
+| Taxa de amostragem registrada | Áudios |
+| --- | ---: |
+| 16.000 Hz | 105.200 |
+| 22.050 Hz | 4.000 |
+| 24.000 Hz | 24.000 |
+| 44.100 Hz | 4.000 |
+| 48.000 Hz | 2.000 |
+
+Há 137.200 áudios mono e 2.000 estéreo. As durações registradas variam de 0,80 a 163,76 segundos, com média de 13,62 e mediana de 13,41 segundos. Adapte os canais e a taxa de amostragem aos requisitos do detector usado.
+
+### Campos principais
+
+| Campo | Descrição |
+| --- | --- |
+| `audio` | Bytes WAV embutidos e caminho relativo, expostos pela feature `Audio` |
+| `label` | Classe textual: `real` ou `fake` |
+| `subset` | Família da árvore de origem: `original`, `real_enhanced`, `babble_fake_only`, `codec_roundtrip` ou `infilling` |
+| `audio_path_relative` | Identificador de caminho relativo na árvore de origem; útil para junção com os metadados completos |
+| `generation_type` | `real`, `tts`, `vc` ou `infilling` |
+| `generator`, `generator_model` | Sistema e identificação de modelo registrados na origem |
+| `dataset_variant`, `condition` | Variante e condição de processamento |
+| `sample_id`, `record_key`, `pair_id` | Identificadores de amostra, registro e pareamento; sua unicidade e abrangência dependem da família |
+| `audio_speaker`, `source_speaker`, `target_speaker` | Identificações de participantes ou pareamentos vocais |
+| `audio_gender`, `source_gender`, `target_gender` | Anotações de gênero dos papéis envolvidos |
+| `audio_region`, `source_region`, `target_region` | Anotações regionais dos papéis envolvidos |
+| `duration`, `sample_rate`, `channels` | Duração em segundos, taxa em Hz e número de canais, armazenados como texto |
+| `noise_type`, `requested_snr_db`, `measured_snr_db` | Tipo de interferência e SNR solicitado/medido, quando disponíveis |
+| `codec`, `codec_bitrate` | Codec intermediário e bitrate aplicado |
+| `infilling_strategy`, `infilling_percentage_pct`, `attack_type` | Estratégia, percentual e tipo de intervenção parcial |
+| `infill_start_time`, `infill_end_time` | Limites temporais da intervenção, em segundos, quando registrados |
+| `content_modified` | Indicador textual de alteração de conteúdo; distinto do rótulo de falsificação |
+| `target_text`, `original_transcription` | Texto de geração e transcrição original, quando disponíveis |
+
+Com exceção de `audio`, as colunas da visão principal são strings, inclusive os números e indicadores booleanos. Valores ausentes podem aparecer como strings vazias. Alguns registros têm identificações compostas de participantes, gêneros ou regiões; por isso, contar valores distintos de `audio_speaker` não equivale a contar pessoas.
+
+O arquivo de metadados completos inclui campos adicionais de proveniência, processamento, identificadores de origem e controle de qualidade. A presença de uma coluna não garante que esteja preenchida para todas as famílias.
+
+## Como carregar
+
+Instale as bibliotecas:
+
+```bash
+pip install -U datasets huggingface_hub
+```
+
+Para inspecionar os registros sem baixar o conjunto inteiro nem decodificar o áudio:
+
+```python
+from datasets import Audio, load_dataset
+
+dataset = load_dataset(
+    "freds0/ParlaSpoof-BR",
+    split="train",
+    streaming=True,
+)
+dataset = dataset.cast_column("audio", Audio(decode=False))
+
+example = next(iter(dataset))
+print(example["label"], example["generation_type"], example["generator"])
+print(example["audio_path_relative"])
+print(len(example["audio"]["bytes"]))
+```
+
+Streaming evita o download antecipado de todo o dataset, mas ainda transfere os blocos Parquet necessários aos registros acessados.
+
+Para carregar localmente todo o split, use `streaming=False` ou omita esse argumento. Reserve espaço para o download e o cache, que podem exceder o tamanho dos arquivos publicados.
+
+### Decodificação e reamostragem
+
+Para trabalhar com a feature de áudio decodificada, instale as dependências de áudio de `datasets` e configure o FFmpeg compatível com seu ambiente:
+
+```bash
+pip install -U "datasets[audio]"
+```
+
+```python
+from datasets import Audio, load_dataset
+
+dataset = load_dataset(
+    "freds0/ParlaSpoof-BR", split="train", streaming=True
+)
+dataset = dataset.cast_column("audio", Audio(sampling_rate=16000))
+example = next(iter(dataset))
+
+# API atual de datasets/torchcodec:
+samples = example["audio"].get_all_samples()
+waveform = samples.data
+sample_rate = samples.sample_rate
+```
+
+A reamostragem acima ocorre no carregamento e não altera os arquivos do repositório. Ela não deve ser confundida com a conversão explícita de estéreo para mono que seu modelo pode exigir. A API de decodificação varia entre versões da biblioteca; consulte a [documentação de áudio de datasets](https://huggingface.co/docs/datasets/audio_load).
+
+### Selecionar o núcleo e as condições de robustez
+
+O artigo organiza o benchmark em dois conjuntos conceituais:
+
+| Conjunto | Conteúdo | Áudios |
+| --- | --- | ---: |
+| Núcleo (*core*) | 2.000 reais originais + 10.000 TTS + 10.000 VC + 16.000 infilling | 38.000 |
+| Robustez | 6.000 reais aprimorados + 60.000 variantes com babble + 35.200 variantes de codec | 101.200 |
+
+Esses conjuntos não são splits de treinamento e teste. Ambos estão armazenados no split `train`. Para reproduzir a separação conceitual:
+
+```python
+core = dataset.filter(lambda row: row["subset"] in {"original", "infilling"})
+robustness = dataset.filter(
+    lambda row: row["subset"] in {
+        "real_enhanced", "babble_fake_only", "codec_roundtrip"
+    }
+)
+```
+
+### Acessar os metadados completos
+
+```python
+from datasets import load_dataset
+from huggingface_hub import hf_hub_download
+
+metadata_path = hf_hub_download(
+    repo_id="freds0/ParlaSpoof-BR",
+    repo_type="dataset",
+    filename="metadata/metadata_complete.parquet",
+)
+metadata = load_dataset("parquet", data_files=metadata_path, split="train")
+print(metadata.column_names)
+```
+
+Use `audio_path_relative` para relacionar a visão de áudio com a tabela completa. Caminhos absolutos eventualmente preservados nos metadados documentam o ambiente de preparação e não são caminhos locais válidos para quem baixa o dataset.
+
+## Protocolo de avaliação e limitações
+
+- **Evite vazamento entre partições.** Variantes de babble, aprimoramento, codec e infilling podem compartilhar uma fala de origem. Uma divisão aleatória por linha pode colocar derivações relacionadas em treino e teste. Rastreie as origens e os pareamentos nos metadados completos; não assuma que um único campo de ID resolve todos os casos. Para avaliar generalização entre pessoas, considere tanto os participantes de origem quanto os de destino.
+- **Considere o desbalanceamento.** Aproximadamente 91,95% dos registros são `fake`. Reporte métricas por classe e condição, além de métricas balanceadas ou independentes de limiar, como macro-F1, EER e ROC-AUC. O artigo apresenta os resultados principais no núcleo e analisa robustez separadamente.
+- **Mantenha os intervalos manipulados observáveis.** Ao cortar entradas para uma duração fixa, uma intervenção Full pode ficar fora do trecho analisado. Esse é o motivo da variante Short. Não interprete uma falha de detecção sem considerar a janela efetivamente recebida pelo modelo.
+- **Separe protocolo de anotação efetiva.** Há 4.000 registros nas condições `llm_attack`, mas apenas 3.949 dos 16.000 registros de infilling estão marcados com `content_modified=True`; os outros 12.051 estão marcados como `False`. Verifique esse campo ao estudar alteração semântica, em vez de inferi-la apenas pelo nome da condição. Há também valores ausentes de `attack_type` e identificações de modelo como `not_recorded`.
+- **Não presuma representatividade populacional.** O conjunto cobre um domínio institucional específico, com 40 participantes e distribuição regional desigual. As anotações de gênero e região não descrevem toda a diversidade social, linguística ou de identidade do Brasil.
+- **Trate transcrições e indicadores automáticos como anotações sujeitas a erro.** Um status de geração bem-sucedida não equivale a revisão humana integral nem à aprovação de todas as métricas de qualidade. Campos de QC podem estar ausentes.
+
+O artigo avalia AASIST, AASIST-L e DF-Arena-1B. Os resultados, configurações e análises de viés devem ser consultados no artigo; esta distribuição contém os dados e seus metadados, não os pesos desses detectores.
+
+## Uso pretendido
+
+O dataset foi desenvolvido para pesquisa em detecção de voz sintética e convertida, localização de manipulações parciais, robustez acústica e auditoria de desempenho no contexto político brasileiro.
+
+As amostras `fake` são construções experimentais e **não devem ser apresentadas como declarações autênticas dos participantes**. Em estudos e demonstrações, identifique claramente as manipulações e preserve a distinção entre voz, conteúdo e identidade de origem. O desempenho obtido neste benchmark, isoladamente, não valida um detector para decisões sobre pessoas ou autenticidade de conteúdo no mundo real.
+
+## Licença e atribuição
+
+O dataset é disponibilizado sob [Creative Commons Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/), conforme a declaração de licença do projeto.
+
+Ao reutilizar os dados, atribua o dataset e seus autores, cite o artigo, reconheça o [Acervo Sonoro da Câmara dos Deputados](https://imagem.camara.leg.br/internet/audio/) como fonte das gravações reais e indique as alterações realizadas. A atribuição não implica endosso da Câmara dos Deputados ou das pessoas cujas vozes aparecem nas gravações.
+
+## Autores e citação
+
+O artigo é de Lucas Rafael Stefanel Gris, Daniel Casanova, Frederico Santos De Oliveira, Alef Iury Ferreira, Beatriz Almeida Felício, Raul César Reis Mata e Anderson da Silva Soares. As afiliações apresentadas no artigo incluem a Universidade Federal de Goiás, a Ermis e a Universidade Tecnológica Federal do Paraná. Lucas Rafael Gris e Daniel Casanova são identificados como autores com contribuição equivalente.
+
+Se utilizar o ParlaSpoof-BR, cite:
+
+```bibtex
+@misc{gris2026clonedvoicesrealconsequences,
+  title={Cloned Voices, Real Consequences: Evaluating Bias in Political Deepfake Detection for Electoral Integrity in Brazil},
+  author={Lucas Rafael Stefanel Gris and Daniel Casanova and Frederico Santos De Oliveira and Alef Iury Ferreira and Beatriz Almeida Felício and Raul César Reis Mata and Anderson da Silva Soares},
+  year={2026},
+  eprint={2607.28770},
+  archivePrefix={arXiv},
+  primaryClass={eess.AS},
+  url={https://arxiv.org/abs/2607.28770},
+}
+```
+
+Para dúvidas sobre o dataset, utilize a [aba Community do repositório](https://huggingface.co/datasets/freds0/ParlaSpoof-BR/discussions).