Update README.md

README.md

@@ -12,46 +12,60 @@ language: ["aar", "abe", "abk", "abq", "abt", "abz", "act", "acu", "acw", "ady",
 
 # Dataset Card for panlex-meanings
 
-This is a dataset of expressions (words and phrases) in several thousand languages, extracted from https://panlex.org (the `20240301` database dump).
-Each expression is associated with some meanings (if there is more than one meaning, they are in separate rows). 
-Thus, by joining per-language datasets by meaning ids, one can obtain a bilingual dictionary. 
+This is a dataset of words in several thousand languages, extracted from https://panlex.org.
 
 ## Dataset Details
 
 ### Dataset Description
 
-<!-- Provide a longer summary of what this dataset is. -->
+This dataset has been extracted from https://panlex.org (the `20240301` database dump) and rearranged on the per-language basis.
 
+Each language subset consists of expressions (words and phrases). 
+Each expression is associated with some meanings (if there is more than one meaning, they are in separate rows). 
 
+Thus, by joining per-language datasets by meaning ids, one can obtain a bilingual dictionary for the chosen language pair. 
 
-- **Curated by:** [More Information Needed]
+- **Curated by:** David Dale (@cointegrated), based on a snapshot of the Panlex database (https://panlex.org/snapshot). 
 - **Language(s) (NLP):** The Panlex database mentions 7558 languages, but only 6241 of them have at least one entry (where entry is a combination of expression and meaning),
- and only 1012 have at least 1000 entries. These 1012 languages are listed in the current dataset.
-- **License:** [More Information Needed]
+ and only 1012 have at least 1000 entries. These 1012 languages are tagged in the current dataset.
+- **License:** [CC0 1.0 Universal License](https://creativecommons.org/publicdomain/zero/1.0/), as explained in https://panlex.org/license.
 
 ### Dataset Sources [optional]
 
 <!-- Provide the basic links for the dataset. -->
 
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
-
+- **Original website:** https://panlex.org/
+- **Paper:** Kamholz, David, Jonathan Pool, and Susan M. Colowick. 2014. [PanLex: Building a Resource for Panlingual Lexical Translation](http://www.lrec-conf.org/proceedings/lrec2014/pdf/1029_Paper.pdf). Proceedings of the 9th International Conference on Language Resources and Evaluation (LREC 2014).
+ 
 ## Uses
 
-<!-- Address questions around how the dataset is intended to be used. -->
+The intended use of the dataset is to extract bilingual dictionaries for the purposes of language learning by machines or humans.
 
-### Direct Use
+The code below illustrates how the dataset could be used to extract a bilingual Avar-English dictionary.
 
-<!-- This section describes suitable use cases for the dataset. -->
+```Python
+from datasets import load_dataset
+ds_ava = load_dataset('cointegrated/panlex-meanings', name='ava', split='train')
+ds_eng = load_dataset('cointegrated/panlex-meanings', name='eng', split='train')
+df_ava = ds_ava.to_pandas()
+df_eng = ds_eng.to_pandas()
 
-[More Information Needed]
+df_ava_eng = df_ava.merge(df_eng, on='meaning', suffixes=['_ava', '_eng']).drop_duplicates(subset=['txt_ava', 'txt_eng'])
+print(df_ava_eng.shape)
+# (10565, 11)
 
-### Out-of-Scope Use
+print(df_ava_eng.sample(5)[['txt_ava', 'txt_eng', 'langvar_uid_ava']])
+#           txt_ava txt_eng langvar_uid_ava
+# 7921        калим     rug         ava-002
+# 3279       хІераб     old         ava-001
+# 41     бакьулълъи  middle         ava-000
+# 9542        шумаш    nose         ava-006
+# 15030     гӏащтӏи     axe         ava-000
+```
 
-<!-- This section addresses misuse, malicious use, and uses that the dataset will not work well for. -->
+Apart from these direct translations, one could also try extracting multi-hop translations (e.g. enrich the direct Avar-English word pairs with the word pairs that share a common Russian translation). 
+However, given that many words have multiple meaning, this approach usually generates some false translations, so it should be used with caution.
 
-[More Information Needed]
 
 ## Dataset Structure
 
@@ -59,6 +73,8 @@ Thus, by joining per-language datasets by meaning ids, one can obtain a bilingua
 
 The dataset is split by languages, denoted by their ISO 639 codes. Each language might contain multiple varieties; they are annotated within each per-language split.
 
+To determine a code for your language, please consult the https://panlex.org webside. For additional information about a language, you may also want to consult https://glottolog.org/.
+
 Each split contains the following fields:
 - `id` (int): id of the expression
 - `langvar` (int): id of the language variaety
@@ -67,53 +83,10 @@ Each split contains the following fields:
 - `meaning` (int): id of the meaning. This is the column to join for obtaining synonyms (within a language) or translations (across languages)
 - `langvar_uid` (str): more human-readable id of the language (e.g. `eng-000` stands for generic English, `eng-001` for simple English, `eng-004` for American English). These ids could be looked up in the language dropdown at https://vocab.panlex.org/.
 
-[More Information Needed]
 
 ## Dataset Creation
 
-### Curation Rationale
-
-<!-- Motivation for the creation of this dataset. -->
-
-[More Information Needed]
-
-### Source Data
-
-<!-- This section describes the source data (e.g. news text and headlines, social media posts, translated sentences, ...). -->
-
-#### Data Collection and Processing
-
-<!-- This section describes the data collection and processing process such as data selection criteria, filtering and normalization methods, tools and libraries used, etc. -->
-
-[More Information Needed]
-
-#### Who are the source data producers?
-
-<!-- This section describes the people or systems who originally created the data. It should also include self-reported demographic or identity information for the source data creators if this information is available. -->
-
-[More Information Needed]
-
-### Annotations [optional]
-
-<!-- If the dataset contains annotations which are not part of the initial data collection, use this section to describe them. -->
-
-#### Annotation process
-
-<!-- This section describes the annotation process such as annotation tools used in the process, the amount of data annotated, annotation guidelines provided to the annotators, interannotator statistics, annotation validation, etc. -->
-
-[More Information Needed]
-
-#### Who are the annotators?
-
-<!-- This section describes the people or systems who created the annotations. -->
-
-[More Information Needed]
-
-#### Personal and Sensitive Information
-
-<!-- State whether the dataset contains data that might be considered personal, sensitive, or private (e.g., data that reveals addresses, uniquely identifiable names or aliases, racial or ethnic origins, sexual orientations, religious beliefs, political opinions, financial or health data, etc.). If efforts were made to anonymize the data, describe the anonymization process. -->
-
-[More Information Needed]
+This dataset has been extracted from https://panlex.org (the `20240301` database dump) and automatically rearranged on the per-language basis.
 
 ## Bias, Risks, and Limitations