millid 0.2.0__tar.gz

millid-0.2.0/.gitignore

@@ -0,0 +1,26 @@
+.venv/
+models/
+data/
+# ...except the package's own data: the frozen script table.
+!src/millid/data/
+__pycache__/
+# Training outputs and local runs: models and reports live on Hugging Face, runs in W&B.
+wandb/
+leaderboard/
+millid-out/
+millid-eval/
+millid-onnx/
+millid-smoke*/
+*.log
+.pytest_cache/
+.ruff_cache/
+dist/
+build/
+*.egg-info/
+
+# JavaScript package
+js/node_modules/
+
+# Local secrets (NPM_API_TOKEN and the like): never committed.
+.env
+.env.*

millid-0.2.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

millid-0.2.0/PKG-INFO

@@ -0,0 +1,225 @@
+Metadata-Version: 2.5
+Name: millid
+Version: 0.2.0
+Summary: Detect the language of any text, offline: 1,550 languages in 56 scripts, many of them low-resource, with ONNX Runtime (no PyTorch, no server).
+Project-URL: Homepage, https://huggingface.co/baobabtech/millid-tiny-v1.5
+Project-URL: Documentation, https://github.com/baobab-tech/millid#readme
+Project-URL: Repository, https://github.com/baobab-tech/millid
+Project-URL: Issues, https://github.com/baobab-tech/millid/issues
+Project-URL: Leaderboard, https://huggingface.co/baobabtech/millid
+Project-URL: JavaScript package, https://www.npmjs.com/package/@baobabtechai/millid
+Author: Baobab Tech
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: african-languages,langid,language-detection,language-identification,low-resource-languages,multilingual,nlp,onnx,onnxruntime
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Text Processing :: Linguistic
+Requires-Python: >=3.10
+Requires-Dist: huggingface-hub>=0.25
+Requires-Dist: numpy>=1.24
+Provides-Extra: cpu
+Requires-Dist: onnxruntime>=1.18; extra == 'cpu'
+Provides-Extra: data
+Requires-Dist: datasets; extra == 'data'
+Requires-Dist: fasttext-wheel; extra == 'data'
+Requires-Dist: langcodes; extra == 'data'
+Requires-Dist: pandas; extra == 'data'
+Requires-Dist: pyarrow; extra == 'data'
+Requires-Dist: pymupdf; extra == 'data'
+Provides-Extra: dev
+Requires-Dist: httpx; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Provides-Extra: gpu
+Requires-Dist: onnxruntime-gpu[cuda,cudnn]>=1.20; extra == 'gpu'
+Provides-Extra: server
+Requires-Dist: fastapi>=0.110; extra == 'server'
+Requires-Dist: pydantic>=2.6; extra == 'server'
+Requires-Dist: uvicorn[standard]>=0.29; extra == 'server'
+Provides-Extra: train
+Requires-Dist: fasttext-wheel; extra == 'train'
+Requires-Dist: onnx>=1.16; extra == 'train'
+Requires-Dist: onnxscript; extra == 'train'
+Requires-Dist: pandas; extra == 'train'
+Requires-Dist: pyarrow; extra == 'train'
+Requires-Dist: safetensors; extra == 'train'
+Requires-Dist: torch>=2.4; extra == 'train'
+Requires-Dist: tyro>=0.8; extra == 'train'
+Requires-Dist: wandb; extra == 'train'
+Description-Content-Type: text/markdown
+
+# MillID
+
+**Detect the language of any text, offline, in Python.** MillID recognises 1,550 languages written in 56 scripts, including hundreds of African, Asian and Indigenous languages that common language detectors do not cover. It runs on a CPU with no PyTorch and no server; the smallest model is 11 MB.
+
+```python
+from millid import MillID
+
+model = MillID.from_pretrained("tiny-v1.5")
+model.predict("Mo fẹ́ràn láti ka ìwé ní àkókò òmìnira mi.", k=1)
+# [Prediction(label='yor_Latn', language='Yoruba', probability=0.973627)]
+```
+
+## What is MillID?
+
+MillID (MultiLingual Language IDentifier) is an open language identification model built by [Baobab Tech](https://huggingface.co/baobabtech). Give it a piece of text, from a short sentence to a whole document, and it tells you which language the text is written in, with a probability for each answer. Every answer names a language and its script, so Serbian in Cyrillic (`srp_Cyrl`) and Serbian in Latin (`srp_Latn`) are told apart.
+
+Developers use it to:
+
+- send each document to the right translation, OCR or speech model;
+- sort or filter text by language when building a dataset;
+- show an interface in the reader's language, or flag text in an unexpected one;
+- count which languages a collection of documents contains.
+
+## What this package does
+
+This package runs MillID on your own machine. The first time you load a model it downloads the model's files from the [Hugging Face Hub](https://huggingface.co/baobabtech/millid-tiny-v1.5) into the Hugging Face cache; after that it works offline. The model runs in [ONNX Runtime](https://onnxruntime.ai), on a CPU or an NVIDIA GPU, with NumPy for the text encoding. There is no API to call and no PyTorch to install, and the text you identify never leaves your machine.
+
+It also gives you a command-line tool and, if you want one, an HTTP service. The JavaScript package [`@baobabtechai/millid`](https://www.npmjs.com/package/@baobabtechai/millid) gives the same answers in Node.js and the browser.
+
+## Install
+
+```bash
+pip install "millid[cpu]"           # ONNX Runtime for the CPU
+pip install "millid[gpu]"           # ONNX Runtime for NVIDIA GPUs (CUDA 12, its libraries from pip)
+pip install "millid[cpu,server]"    # and the HTTP service
+```
+
+Python 3.10 or later. ONNX Runtime comes as an extra because its CPU and GPU builds cannot be installed side by side: choose one.
+
+## Quick start
+
+```python
+from millid import MillID
+
+model = MillID.from_pretrained("tiny-v1.5")     # downloads 11 MB once
+
+model.predict("Je voudrais réserver une table pour deux personnes ce soir.", k=2)
+# [Prediction(label='fra_Latn', language='French', probability=0.954421),
+#  Prediction(label='frp_Latn', language='Arpitan', probability=0.001443)]
+
+model.predict(["Lave men ou ak savon anvan ou manje.", "Ndimakonda kuwerenga mabuku nthawi yanga yaulere."], k=1)
+# [[Prediction(label='hat_Latn', language='Haitian Creole', probability=0.978552)],
+#  [Prediction(label='nya_Latn', language='Nyanja', probability=0.940327)]]
+```
+
+`predict(text, k)` returns the `k` most likely languages (3 by default), most likely first. Pass a list to identify many texts in one call: they are batched together, which is much faster than one call per text.
+
+## Command line
+
+```bash
+millid predict "Lave men ou ak savon anvan ou manje." -k 2
+# hat_Latn 0.979, crs_Latn 0.000	Lave men ou ak savon anvan ou manje.
+
+cat sentences.txt | millid predict -k 1                     # one text per line
+millid predict --document < report.txt                      # the whole file as one document, as JSON
+millid predict --model large-v1.5 --device cuda "..."       # another model, on the GPU
+```
+
+## Choose a model
+
+| Model | Download | Top-1 accuracy | Macro F1 | Best for |
+|---|---|---|---|---|
+| `tiny-v1.5` (default) | 11 MB | 95.9% | 0.955 | any CPU, laptops, small servers |
+| `medium-v1` | 455 MB | 96.2% | 0.958 | servers |
+| `large-v1.5` | 764 MB | 96.7% | 0.965 | servers with a GPU: the most accurate |
+
+Measured on 240,241 test passages in 1,621 languages, from documents the models never saw in training. Macro F1 weighs every language equally, so it shows how well the small languages are served, not just the large ones. The [leaderboard](https://huggingface.co/baobabtech/millid) compares the three with GlotLID and Meta's fastText identifier, language by language.
+
+`from_pretrained` also takes a Hugging Face repo id (`"baobabtech/millid-large-v1.5"`) or a local directory holding `config.json`, `labels.json` and `onnx/model.onnx`, and these options:
+
+```python
+model = MillID.from_pretrained(
+    "large-v1.5",
+    device="cuda",       # "cpu" (the default), "cuda", or "auto": the GPU when there is one
+    threads=4,           # CPU threads for ONNX Runtime; its default when omitted
+    batch_size=64,       # texts per model call
+)
+```
+
+## Reading the results
+
+Each answer is a `Prediction` with three fields:
+
+| Field | Example | Meaning |
+|---|---|---|
+| `label` | `'yor_Latn'` | the language's [ISO 639-3](https://iso639-3.sil.org) code and its [ISO 15924](https://www.unicode.org/iso15924/) script code |
+| `language` | `'Yoruba'` | the language's English name |
+| `probability` | `0.973627` | how likely this answer is, from 0 to 1; the answers for a text add up to at most 1 |
+
+A few labels end in a script alone, such as `und_Tibt`: text in that script whose language MillID cannot name more precisely.
+
+## Long text and whole documents
+
+`predict` reads the first 255 bytes of a text, about 250 characters of English or 85 of Hindi. For anything longer, use `identify_document`: it reads the whole text in windows, gives the document's languages weighted by how much of the text each one covers, and marks where each language runs.
+
+```python
+doc = model.identify_document(long_text, k=2)
+doc.languages
+# [Prediction(label='eng_Latn', language='English', probability=0.576472),
+#  Prediction(label='fra_Latn', language='French', probability=0.381211)]
+doc.segments
+# [Segment(start=0, end=250, label='eng_Latn', language='English', probability=0.952214),
+#  Segment(start=251, end=414, label='fra_Latn', language='French', probability=0.96499)]
+doc.windows, doc.characters
+# (2, 414)
+```
+
+`start` and `end` count characters in the text after normalisation (`millid.normalize(text)`), which collapses whitespace and applies Unicode NFKC.
+
+## An HTTP service
+
+```bash
+millid serve --models "tiny-v1.5=baobabtech/millid-tiny-v1.5@cpu" --port 8050
+curl -s localhost:8050/identify -H 'content-type: application/json' -d '{"text": "Lave men ou ak savon anvan ou manje.", "k": 1}'
+# {"model": "tiny-v1.5", "results": [{"languages": [{"label": "hat_Latn", "language": "Haitian Creole", "probability": 0.978552}]}]}
+```
+
+`POST /identify` takes `text` or `texts`, `k`, `model`, and `document: true` for a whole document; `GET /models` describes the loaded models and `GET /health` reports that the service is up. Requests that arrive together are answered in shared batches, so throughput grows with load. To serve MillID inside an application of your own, build on `millid.Registry` and `millid.MicroBatcher`.
+
+## Tips
+
+- **Give it a sentence or more.** A word or a short greeting carries little evidence: "Bonjour tout le monde" alone comes back as `nrm_Latn` (Norman) rather than French. A full sentence or more gives much more reliable answers.
+- **Treat a low probability as unsure.** When the first answer is below 0.5, look at the next ones too, or ask for more text.
+- **Close languages share their answers.** Swahili and Congo Swahili, or Bosnian and Croatian, differ by a few words; a short passage of either often gets both in its top answers. Ask for `k=3` and decide with what you know about your text.
+- **Pass the text as it is.** Accents, tone marks and the script are much of what the model reads: do not strip, transliterate or romanise it first.
+- **One text alone and the same text in a batch can score a little differently.** A batch is lower-cased as one string; call `predict` with one text where scores must not depend on their neighbours.
+
+## API
+
+| | |
+|---|---|
+| `MillID.from_pretrained(ref="tiny-v1.5", revision=None, token=None, **options)` | Load a model: `"tiny-v1.5"`, `"medium-v1"`, `"large-v1.5"`, a Hugging Face repo id, or a directory. `token` only for a private repo; options `device`, `threads`, `batch_size`, `gpu_mem_limit_mb` |
+| `model.predict(text, k=3)` | The `k` most likely languages of a text, as `Prediction`s. A list of texts gives one list per text |
+| `model.identify_document(text, k=3, max_windows=256)` | A text of any length, as a `DocumentResult`: `languages`, `segments`, `windows`, `characters` |
+| `model.probabilities(texts)` | A NumPy array, one row per text, a probability for each label in `model.labels` |
+| `millid.MODELS` | The released models by short name |
+| `millid.normalize`, `millid.encode_batch` | The model's input, to run the ONNX file elsewhere |
+
+`MillID` is `millid.LanguageIdentifier` under a shorter name. A model is safe to call from several threads at once.
+
+## How it works
+
+MillID is a small transformer that reads text as UTF-8 bytes rather than words, so there is no vocabulary to outgrow: any script, even one it has rarely seen, is input it can read. Each byte is described by the byte itself, the Unicode script of its character and the character sequences ending there; the network turns a passage into one vector and scores it against a vector for every label, built from the label itself, its language (shared across scripts) and its script. The full design is in [the architecture document](https://github.com/baobab-tech/millid/blob/main/training/ARCHITECTURE.md), and each model's card on the Hub has its evaluation.
+
+## Links
+
+- Models: [tiny v1.5](https://huggingface.co/baobabtech/millid-tiny-v1.5), [medium v1](https://huggingface.co/baobabtech/millid-medium-v1), [large v1.5](https://huggingface.co/baobabtech/millid-large-v1.5)
+- Leaderboard: [baobabtech/millid](https://huggingface.co/baobabtech/millid)
+- Dataset: [baobabtech/millid-dataset](https://huggingface.co/datasets/baobabtech/millid-dataset)
+- JavaScript package: [`@baobabtechai/millid` on npm](https://www.npmjs.com/package/@baobabtechai/millid)
+- Source, training code and issues: [github.com/baobab-tech/millid](https://github.com/baobab-tech/millid)
+
+## Licence
+
+Apache-2.0, for the code and the model weights. Built by [Baobab Tech](https://huggingface.co/baobabtech).

millid-0.2.0/README.pypi.md

@@ -0,0 +1,165 @@
+# MillID
+
+**Detect the language of any text, offline, in Python.** MillID recognises 1,550 languages written in 56 scripts, including hundreds of African, Asian and Indigenous languages that common language detectors do not cover. It runs on a CPU with no PyTorch and no server; the smallest model is 11 MB.
+
+```python
+from millid import MillID
+
+model = MillID.from_pretrained("tiny-v1.5")
+model.predict("Mo fẹ́ràn láti ka ìwé ní àkókò òmìnira mi.", k=1)
+# [Prediction(label='yor_Latn', language='Yoruba', probability=0.973627)]
+```
+
+## What is MillID?
+
+MillID (MultiLingual Language IDentifier) is an open language identification model built by [Baobab Tech](https://huggingface.co/baobabtech). Give it a piece of text, from a short sentence to a whole document, and it tells you which language the text is written in, with a probability for each answer. Every answer names a language and its script, so Serbian in Cyrillic (`srp_Cyrl`) and Serbian in Latin (`srp_Latn`) are told apart.
+
+Developers use it to:
+
+- send each document to the right translation, OCR or speech model;
+- sort or filter text by language when building a dataset;
+- show an interface in the reader's language, or flag text in an unexpected one;
+- count which languages a collection of documents contains.
+
+## What this package does
+
+This package runs MillID on your own machine. The first time you load a model it downloads the model's files from the [Hugging Face Hub](https://huggingface.co/baobabtech/millid-tiny-v1.5) into the Hugging Face cache; after that it works offline. The model runs in [ONNX Runtime](https://onnxruntime.ai), on a CPU or an NVIDIA GPU, with NumPy for the text encoding. There is no API to call and no PyTorch to install, and the text you identify never leaves your machine.
+
+It also gives you a command-line tool and, if you want one, an HTTP service. The JavaScript package [`@baobabtechai/millid`](https://www.npmjs.com/package/@baobabtechai/millid) gives the same answers in Node.js and the browser.
+
+## Install
+
+```bash
+pip install "millid[cpu]"           # ONNX Runtime for the CPU
+pip install "millid[gpu]"           # ONNX Runtime for NVIDIA GPUs (CUDA 12, its libraries from pip)
+pip install "millid[cpu,server]"    # and the HTTP service
+```
+
+Python 3.10 or later. ONNX Runtime comes as an extra because its CPU and GPU builds cannot be installed side by side: choose one.
+
+## Quick start
+
+```python
+from millid import MillID
+
+model = MillID.from_pretrained("tiny-v1.5")     # downloads 11 MB once
+
+model.predict("Je voudrais réserver une table pour deux personnes ce soir.", k=2)
+# [Prediction(label='fra_Latn', language='French', probability=0.954421),
+#  Prediction(label='frp_Latn', language='Arpitan', probability=0.001443)]
+
+model.predict(["Lave men ou ak savon anvan ou manje.", "Ndimakonda kuwerenga mabuku nthawi yanga yaulere."], k=1)
+# [[Prediction(label='hat_Latn', language='Haitian Creole', probability=0.978552)],
+#  [Prediction(label='nya_Latn', language='Nyanja', probability=0.940327)]]
+```
+
+`predict(text, k)` returns the `k` most likely languages (3 by default), most likely first. Pass a list to identify many texts in one call: they are batched together, which is much faster than one call per text.
+
+## Command line
+
+```bash
+millid predict "Lave men ou ak savon anvan ou manje." -k 2
+# hat_Latn 0.979, crs_Latn 0.000	Lave men ou ak savon anvan ou manje.
+
+cat sentences.txt | millid predict -k 1                     # one text per line
+millid predict --document < report.txt                      # the whole file as one document, as JSON
+millid predict --model large-v1.5 --device cuda "..."       # another model, on the GPU
+```
+
+## Choose a model
+
+| Model | Download | Top-1 accuracy | Macro F1 | Best for |
+|---|---|---|---|---|
+| `tiny-v1.5` (default) | 11 MB | 95.9% | 0.955 | any CPU, laptops, small servers |
+| `medium-v1` | 455 MB | 96.2% | 0.958 | servers |
+| `large-v1.5` | 764 MB | 96.7% | 0.965 | servers with a GPU: the most accurate |
+
+Measured on 240,241 test passages in 1,621 languages, from documents the models never saw in training. Macro F1 weighs every language equally, so it shows how well the small languages are served, not just the large ones. The [leaderboard](https://huggingface.co/baobabtech/millid) compares the three with GlotLID and Meta's fastText identifier, language by language.
+
+`from_pretrained` also takes a Hugging Face repo id (`"baobabtech/millid-large-v1.5"`) or a local directory holding `config.json`, `labels.json` and `onnx/model.onnx`, and these options:
+
+```python
+model = MillID.from_pretrained(
+    "large-v1.5",
+    device="cuda",       # "cpu" (the default), "cuda", or "auto": the GPU when there is one
+    threads=4,           # CPU threads for ONNX Runtime; its default when omitted
+    batch_size=64,       # texts per model call
+)
+```
+
+## Reading the results
+
+Each answer is a `Prediction` with three fields:
+
+| Field | Example | Meaning |
+|---|---|---|
+| `label` | `'yor_Latn'` | the language's [ISO 639-3](https://iso639-3.sil.org) code and its [ISO 15924](https://www.unicode.org/iso15924/) script code |
+| `language` | `'Yoruba'` | the language's English name |
+| `probability` | `0.973627` | how likely this answer is, from 0 to 1; the answers for a text add up to at most 1 |
+
+A few labels end in a script alone, such as `und_Tibt`: text in that script whose language MillID cannot name more precisely.
+
+## Long text and whole documents
+
+`predict` reads the first 255 bytes of a text, about 250 characters of English or 85 of Hindi. For anything longer, use `identify_document`: it reads the whole text in windows, gives the document's languages weighted by how much of the text each one covers, and marks where each language runs.
+
+```python
+doc = model.identify_document(long_text, k=2)
+doc.languages
+# [Prediction(label='eng_Latn', language='English', probability=0.576472),
+#  Prediction(label='fra_Latn', language='French', probability=0.381211)]
+doc.segments
+# [Segment(start=0, end=250, label='eng_Latn', language='English', probability=0.952214),
+#  Segment(start=251, end=414, label='fra_Latn', language='French', probability=0.96499)]
+doc.windows, doc.characters
+# (2, 414)
+```
+
+`start` and `end` count characters in the text after normalisation (`millid.normalize(text)`), which collapses whitespace and applies Unicode NFKC.
+
+## An HTTP service
+
+```bash
+millid serve --models "tiny-v1.5=baobabtech/millid-tiny-v1.5@cpu" --port 8050
+curl -s localhost:8050/identify -H 'content-type: application/json' -d '{"text": "Lave men ou ak savon anvan ou manje.", "k": 1}'
+# {"model": "tiny-v1.5", "results": [{"languages": [{"label": "hat_Latn", "language": "Haitian Creole", "probability": 0.978552}]}]}
+```
+
+`POST /identify` takes `text` or `texts`, `k`, `model`, and `document: true` for a whole document; `GET /models` describes the loaded models and `GET /health` reports that the service is up. Requests that arrive together are answered in shared batches, so throughput grows with load. To serve MillID inside an application of your own, build on `millid.Registry` and `millid.MicroBatcher`.
+
+## Tips
+
+- **Give it a sentence or more.** A word or a short greeting carries little evidence: "Bonjour tout le monde" alone comes back as `nrm_Latn` (Norman) rather than French. A full sentence or more gives much more reliable answers.
+- **Treat a low probability as unsure.** When the first answer is below 0.5, look at the next ones too, or ask for more text.
+- **Close languages share their answers.** Swahili and Congo Swahili, or Bosnian and Croatian, differ by a few words; a short passage of either often gets both in its top answers. Ask for `k=3` and decide with what you know about your text.
+- **Pass the text as it is.** Accents, tone marks and the script are much of what the model reads: do not strip, transliterate or romanise it first.
+- **One text alone and the same text in a batch can score a little differently.** A batch is lower-cased as one string; call `predict` with one text where scores must not depend on their neighbours.
+
+## API
+
+| | |
+|---|---|
+| `MillID.from_pretrained(ref="tiny-v1.5", revision=None, token=None, **options)` | Load a model: `"tiny-v1.5"`, `"medium-v1"`, `"large-v1.5"`, a Hugging Face repo id, or a directory. `token` only for a private repo; options `device`, `threads`, `batch_size`, `gpu_mem_limit_mb` |
+| `model.predict(text, k=3)` | The `k` most likely languages of a text, as `Prediction`s. A list of texts gives one list per text |
+| `model.identify_document(text, k=3, max_windows=256)` | A text of any length, as a `DocumentResult`: `languages`, `segments`, `windows`, `characters` |
+| `model.probabilities(texts)` | A NumPy array, one row per text, a probability for each label in `model.labels` |
+| `millid.MODELS` | The released models by short name |
+| `millid.normalize`, `millid.encode_batch` | The model's input, to run the ONNX file elsewhere |
+
+`MillID` is `millid.LanguageIdentifier` under a shorter name. A model is safe to call from several threads at once.
+
+## How it works
+
+MillID is a small transformer that reads text as UTF-8 bytes rather than words, so there is no vocabulary to outgrow: any script, even one it has rarely seen, is input it can read. Each byte is described by the byte itself, the Unicode script of its character and the character sequences ending there; the network turns a passage into one vector and scores it against a vector for every label, built from the label itself, its language (shared across scripts) and its script. The full design is in [the architecture document](https://github.com/baobab-tech/millid/blob/main/training/ARCHITECTURE.md), and each model's card on the Hub has its evaluation.
+
+## Links
+
+- Models: [tiny v1.5](https://huggingface.co/baobabtech/millid-tiny-v1.5), [medium v1](https://huggingface.co/baobabtech/millid-medium-v1), [large v1.5](https://huggingface.co/baobabtech/millid-large-v1.5)
+- Leaderboard: [baobabtech/millid](https://huggingface.co/baobabtech/millid)
+- Dataset: [baobabtech/millid-dataset](https://huggingface.co/datasets/baobabtech/millid-dataset)
+- JavaScript package: [`@baobabtechai/millid` on npm](https://www.npmjs.com/package/@baobabtechai/millid)
+- Source, training code and issues: [github.com/baobab-tech/millid](https://github.com/baobab-tech/millid)
+
+## Licence
+
+Apache-2.0, for the code and the model weights. Built by [Baobab Tech](https://huggingface.co/baobabtech).