Add note on data schemata

README.md

@@ -2632,16 +2632,106 @@ translations into 221 Low-Resource Languages, for the purpose of training
 translation models, and otherwise increasing the representations of said
 languages in NLP and technology.
 
-Please read the [SMOL Paper](...) and the [GATITOS Paper](https://arxiv.org/abs/2303.15265) for a much more thorough description!
+Please read the [SMOL Paper](https://arxiv.org/abs/2502.12301) and the
+[GATITOS Paper](https://arxiv.org/abs/2303.15265) for a much more
+thorough description!
 
 There are three resources in this directory:
 
-*   **GATITOS:** token-level translations into 172 languages
-*   **SmolSent:** sentence-level translations into 81 languages
 *   **SmolDoc:** document-level translations into 100 languages
+*   **SmolSent:** sentence-level translations into 81 languages
+*   **GATITOS:** token-level translations into 172 languages
 *   **SmolDoc-factuality-annotations:** factuality annotations and rationales
     for 661 documents from `SmolDoc`
-             
+
+
+## Data schemata
+
+The schemata are pretty straightforward. Source and Target languge are 
+provided in `sl` and `tl` fields. The `is_src_orig` field has a value
+of `true` if the source text was the original text, and the target field
+was translated, and avalue of `false` if the data is back-translated.
+
+### SmolDoc
+
+SmolDoc provides sentence-split and aligned translations through the `srcs` and `trgs` fields. These will always have the same length.
+
+```
+{
+'id': 'topic_587__weyiwiniwaaotiwenwy',
+ 'sl': 'en',
+ 'tl': 'pcm',
+ 'is_src_orig': True,
+ 'factuality': 'ok',  # this is a story so there is no factual claim that could be wrong
+ 'srcs': ['"What the hell are you doing, you idiot?!"',
+          '"Excuse me?"', 
+          '"You cut me off! You almost made me crash!"', 
+          '"I\'m sorry, I didn\'t mean to. I was just trying to get around that slow-moving truck."',
+          '"Well, you could have at least used your turn signal!"',
+          '"I did use my turn signal!"',
+          '"No, you didn\'t! You just pulled right out in front of me!"',
+          '"I\'m telling you, I used my turn signal!"',
+          '"Whatever. You\'re still a terrible driver."',
+          '"And you\'re a jerk!"', 
+          '"At least I know how to drive!"',
+          '"Oh, yeah? Well, I\'m a better writer than you are!"',
+          '"That\'s debatable."',
+          '"It\'s not debatable! I\'m Ernest Hemingway!"',
+          '"Who?"',
+          '"Ernest Hemingway! The greatest writer of all time!"',
+          '"Never heard of him."',
+          '"Well, you\'ve heard of me now!"',
+          '"Yeah, I heard of you."'],
+ 'trgs': ['"Wetin di hell dey do, yu idiot?!"',
+          '"Ekskuse mi?"', 
+          '"Yu komot mi! Yu almost make mi krash!"',
+          '"I dey sorry, I nor wont do am. I just dey try get around dat truk wey slow."',
+          '"Well, yu for don yus yor turn sign!"',
+          '"I yus mai turn sign!"',
+          '"No, yu nor turn am! Yu just turn rite in front of mi!"',
+          '"I dey tell yu, I yus mai turn sign!"',
+          '"Wateva. Yu still bi one tribol driva."',
+          '"And yu bi jerk!"',
+          '"At least I sabi hau to drive!"',
+          '"Oh, yeah? Well, I bi ogbonge writa pass yu!"',
+          '"Wi fit dibate dat."',
+          '"nortin to dibate! I bi Ernest Hemingway!"',
+          '"Who?"',
+          '"Ernest Hemingway! De writa of all taim wey grate pass!"',
+          '"Neva hear am."',
+          '"Well, yu don hear mi nau!"',
+          '"Na so, I don hear yu."']
+}
+```
+
+### SmolSent
+
+SmolSent's schema differs from SmolDoc's only in that `src` and `trg` are single strings, not lists:
+
+```
+{'id': 381,
+ 'sl': 'en',
+ 'tl': 'ber',
+ 'is_src_orig': True,
+ 'src': 'Rih, a deaf former soldier, plots rebellion while married to a queer, teenage god.',
+ 'trg': 'ⵔⵉⵀ, ⴷ ⴰⴷⴻⴼⵔⵉⵔ ⴰⵇⴱⵓⵔ ⴰⴻⵎⴻⵙⵍⵉ, ⵢⴻⵜⵜⵀⴻⴳⴳⵉ ⵜⴰⴴⴻⵡⵡⴰⵜ-ⵉⵙ, ⴴⴰⵙ ⴰⴽⴽⴻⵏ ⵢⴻⵣⵡⴻⴵ ⴷ ⵢⵉⵡⴻⵏ ⵢⵉⵍⵓ ⵉⵍⴻⵎⵥⵉ ⵉⵁⴻⵎⵎⵍⴻⵏ ⴰⵔⵔⴰⵛ.'
+}
+```
+
+### GATITOS
+
+GATITOS has a one-to-many schema, with each source mapping to one or more targets:
+
+```
+{
+ 'sl': 'en',
+ 'tl': 'aa',
+ 'is_source_orig': True,
+ 'src': 'how are you',
+ 'trgs': ['mannah taniih?', 'anninnaay?']
+}
+```
+
 ## Notes on the GATITOS multilingual Lexicon
 
 The GATITOS (Google's Additional Translations Into Tail-languages: Often Short)
@@ -2649,11 +2739,12 @@ dataset is a high-quality, multi-way parallel dataset of tokens and short
 phrases, intended for training and improving machine translation models.
 Experiments on this dataset and Panlex focusing on unsupervised translation in
 a 208-language model can be found in
-[BiLex Rx: Lexical Data Augmentation for Massively Multilingual Machine Translation](https://arxiv.org/abs/2303.15265).
+the [GATITOS paper](https://arxiv.org/abs/2303.15265).
 
 This dataset consists in 4,000 English segments (4,500 tokens) that have been
-translated into each of 173 languages, 170 of which are low-resource, and three
-of which are mid-high resource (es, fr, hi). All translations were made
+translated into each of 173 languages, and as a 4001st token, the endonym.
+Of these, 170 are low-resource, and three
+are mid-high resource (es, fr, hi). All translations were made
 directly from English, with the exception of Aymara, which was translated from
 the Spanish.