Update README.md

README.md

@@ -8,11 +8,15 @@ language:
 library_name: fasttext
 pipeline_tag: text-classification
 ---
-# Model Card for Model ID
+# Open fasttext LangID models
 
 <!-- Provide a quick summary of what the model is/does. -->
 
-This model card aims to be a base template for new models. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/modelcard_template.md?plain=1).
+This repo makes readily available several fasttext based open langID models.
+While the use and distribution of this collection itself is available according to Apache 2.0, 
+but individual models maybe under different more stringent licenses and end users MUST ensure the licenses before distribution or usage.
+
+Quantized versions have been derived by the author [Chris Ha]([email protected])
 
 ## Model Details
 
@@ -22,47 +26,57 @@ This model card aims to be a base template for new models. It has been generated
 
 
 
-- **Developed by:** [More Information Needed]
+- **Developed by:** [Individual Developers]
 - **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
+- **Model type:** [Fasttext Classifier]
+- **Language(s) (NLP):** [Multilingual]
 - **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
+- **Finetuned from model [optional]:** [Individual models]
 
-### Model Sources [optional]
+### Model Source for OpenLID
 
 <!-- Provide the basic links for the model. -->
 
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
+- **Repository:** [An Open Dataset and Model for Language Identification](https://github.com/laurieburchell/open-lid-dataset)
+- **Paper [optional]:** [An Open Dataset and Model for Language Identification](https://arxiv.org/abs/2305.13820)
+- **Demo [optional]:** [More Information Needed]
+
+### Model Source for NLLB langID(lid218e)
+
+<!-- Provide the basic links for the model. -->
+
+- **Repository:** [fastText (Language Identification)](https://huggingface.co/facebook/fasttext-language-identification)
+- **Paper [optional]:** [No Language Left Behind: Scaling Human-Centered Machine Translation](https://arxiv.org/abs/2207.04672)
 - **Demo [optional]:** [More Information Needed]
 
 ## Uses
 
 <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
+Language Classification
 
 ### Direct Use
 
 <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
+Language Classification
 
 [More Information Needed]
 
 ### Downstream Use [optional]
 
 <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-
+Refer to details of each model
 [More Information Needed]
 
 ### Out-of-Scope Use
 
 <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-
+Refer to details of each model
 [More Information Needed]
 
 ## Bias, Risks, and Limitations
 
 <!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
+Refer to details of each model
 [More Information Needed]
 
 ### Recommendations