Skip to content

Latest commit

 

History

History
41 lines (23 loc) · 3.31 KB

SENTENCES.md

File metadata and controls

41 lines (23 loc) · 3.31 KB

Sentences on Common Voice

As Common Voice is a read dataset, sentences are our currency. You can help by adding new sentences to our dataset for other contributors to read, helping with bulk sentence extractions, or reporting problematic sentences.

Sentence Collector

The Sentence Collector is a tool for crowdsourcing sentences for Common Voice. You can either:

  • Add sentences for your language
  • Validate sentences that other contributors have added

Each sentence requires at least two upvotes to be considered valid.

At regular intervals, validated sentences from the Sentence Collector will be exported and added to the Common Voice database. These will be available on the site next time there's a release.

Automatic extraction

The Sentence Extractor is a tool that can scrape public domain data sources for sentences. Right now, the only source we have configured is Wikipedia. Please see this post for detailed guidance on how to use the sentence extractor.

Bulk submission

If you know of a public domain corpus of sentences with more than 10k sentences, you can manually submit a pull request to add this as a bulk dataset. However, you will need to manually perform QA (quality assurance) to make sure the sentences are valid and high-quality.

This Discourse post has a more detailed guide for how to do manual QA, but in brief:

  • You need 2-3 native speakers to review a random sample of sentences to verify their correctness
  • The sentences should be spelled correctly.
  • The sentences should be grammatically correct.
  • The sentences should be speakable (also avoiding non-native uncommon words)

We're looking for less than 5% of error rate on the random sample. You can use this tool with a confidence level of 99% and a margin of error of 2% to determine the sample size you need to review.

Feel free to set up this QA however makes most sense for you, but here's a sample Google Spreadsheets template.

Once the review is complete, submit a pull request with the # of sentences submitted, a link to the manual QA results, and the % error rate. Here's an example PR. Please make sure the sentences are in a plain .txt file with one sentence per line.

Flagging problematic sentences

If you notice sentences that need to be deleted, first check what the source of the sentence is. If the file that the sentence is located in is called sentence-collector.txt, that means it was automatically exported from Sentence Collector. In that case, please file an issue on the Sentence Collector repo with a plaintext file of all of the problem sentences, with one sentence per line.

If the sentence is from a different source, you can file a pull request that modifies the text file directly. If possible, also attach a separate plaintext file that has all of the problem sentences, with one sentence per line.