Update README.md

README.md

@@ -1,3 +1,29 @@
----
-license: unlicense
----
+---
+license: unlicense
+---
+# OkayLID
+OkayLID is a language identification model in FastText that is only 3 megabytes, meant for basic language detection. It can detect over 201 languages, at an extremely small size. OkayLID trained on a smaller subset of the OpenLID dataset.
+
+## Installation
+
+```bash
+pip install fasttext huggingface_hub
+```
+
+## Usage
+
+```python
+import numpy as np
+import fasttext
+from huggingface_hub import hf_hub_download
+
+np.array = lambda obj, *args, **kwargs: np.asarray(obj, *args, **{k: v for k, v in kwargs.items() if k != "copy"})
+
+model_path = hf_hub_download(repo_id="Cutecat6152/OkayLID", filename="OkayLID.bin")
+model = fasttext.load_model(model_path)
+
+text = "The quick brown fox jumps over the lazy dog."
+labels, probs = model.predict(text, k=1)
+
+print(f"Language: {labels[0].replace('__label__', '')}")
+```