Update README.md

README.md

@@ -14,16 +14,39 @@ The intended use-case is for document translation tasks.
 # Dataset format
 ```json
 {
- 'src' : 'JAPANESE CHAPTER'
- 'trg' : 'ENGLISH TRANSLATION'
- 'meta' : {
- "source": 'SAME ACROSS ALL ENTRIES',
- "series": 'NAME OF WEB NOVEL SERIES',
- "missed_lines": 'NUMBER OF LINES THAT WERE AT THE SAME INDEX BUT NOT DETECTED AS BEING TRANSLATIONS OF EACH OTHER',
- "inserted_lines_src": 'NUMBER OF LINES IN THE JAPANESE TEXT THAT DID NOT HAVE A MATCHING TRANSLATION BUT ARE BUFFERED BY TRANSLATED LINES',
- "inserted_lines_trg": 'SAME AS ABOVE BUT FOR ENGLISH',
+ 'src': 'JAPANESE WEB NOVEL CHAPTER',
+ 'trg': 'CORRESPONDING ENGLISH TRANSLATION',
+ 'meta': {
+ 'general': {
+ 'series_title_eng': 'ENGLISH SERIES TITLE',
+ 'series_title_jap': 'JAPANESE SERIES TITLE',
+ 'sentence_alignment_score': 'ALIGNMENT SCORE'
+ },
+ 'novelupdates': {
+ 'link': 'NOVELUPDATES URL',
+ 'genres': 'NOVELUPDATES GENRES',
+ 'tags': 'NOVELUPDATES TAGS (think sub-genres)',
+ 'rating': 'NOVELUPDATES RATING (X/5)',
+ 'rating_votes': 'NOVELUPDATES RATING VOTES'
+ },
+ 'syosetu': {
+ 'link': 'SYOSETU URL',
+ 'series_active': 'IS THE SERIES STILL UP ON SYOSETU (is false for 3 series, each one has no syosetu metadata beyond the link and active status)',
+ 'writer': 'AUTHOR'S NAME ON SYOSETU',
+ 'fav_novel_cnt': 'FROM SYOSETU API FOR CHECKING SERIES QUALITY',
+ 'global_points': 'ALSO FROM SYOSETU API FOR CHECKING SERIES QUALITY'
+ }
+
  }
 }
 ```
-A high number of inserted lines is not necessarily a sign of a bad pair, as many translations concatenate or divide source chapters when publishing. 
-Instead, watch out for high numbers of missed lines or entries where the inserted line count is high for both source and target.
+This is version 2 of the dataset. It contains more series (roughtly three thousand more), but has fewer tokens due to an overhaul of alignment code.
+This version should fix the issues found in discussions #3 and #4, and adds series-specific metadata as requested in #1.
+No translation quality filtering has been applied to the dataset. Methods for doing so are being researched.
+
+License note:
+The texts and site-specific metadata is distributed under fair use principles, with everything else being under an Apache 2.0 license.
+If an author, translator or one of the sites mentioned above requests a takedown of one or more series, it will be promptly addressed.
+Takedowns can be requested through the creation of a Huggingface disscussion.
+
+I am not a lawyer, and the above notice is probably not legally sound. As such, I recommend discretion when using the contents of the dataset.