pynatlas 0.1.0__tar.gz

pynatlas-0.1.0/.gitignore

@@ -0,0 +1,13 @@
+__pycache__/
+*.py[cod]
+.venv/
+.uv-cache/
+dist/
+build/
+*.egg-info/
+.pytest_cache/
+.ruff_cache/
+.models/
+*.gguf
+.env
+.DS_Store

pynatlas-0.1.0/CHANGELOG.md

@@ -0,0 +1,48 @@
+# Changelog
+
+All notable changes to pynatlas are recorded here. The format follows
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and versions follow
+[Semantic Versioning](https://semver.org/). Until 1.0, minor versions may
+include breaking changes, each called out under its release.
+
+## [0.1.0] - 2026-10-12
+
+First release.
+
+### Client
+
+- `NAtlas` and `AsyncNAtlas` for any OpenAI-compatible endpoint serving
+  N-ATLaS, sending standard OpenAI fields only. Provider-specific options pass
+  through as keyword arguments.
+- Chat, streaming, translation and speech to text.
+- Tool calling from plain Python functions, with `run_tools()` to run the
+  call-and-answer loop.
+- Structured output from a Pydantic model or JSON schema, with recovery of
+  JSON from code fences and one corrective retry where the endpoint does not
+  enforce schemas.
+- `summarize()`, `classify()` (enforced label set) and `voice_chat()`.
+- `detect_language()`, offline, above 99% accurate on held-out text.
+- Retries with backoff for connection errors, 408, 409, 429 and 5xx, and typed
+  exceptions under `NAtlasError`.
+- Settings validated once from `NATLAS_*` environment variables.
+
+### Server
+
+- `pynatlas serve`: N-ATLaS GGUF weights behind the OpenAI API through
+  llama.cpp, with tool calling, schema-enforced JSON output and speech
+  recognition through the official NCAIR1 models.
+- API keys, OpenAI error bodies, and recovery when a client disconnects
+  mid-stream.
+- Replies independent of earlier requests, and `--date` to make benchmark runs
+  reproducible.
+- `Engine` and `Transcriber` protocols for other backends.
+- A container image and documented GPU routes.
+
+### Tooling
+
+- `pynatlas download`: pinned, SHA-256 verified, resumable weight downloads.
+- `pynatlas bench`: AfriMMLU, AfriXNLI, AfriMGSM, MAFAND, FLEURS and a held-out
+  tool-calling set, with every reply saved for audit.
+- A Streamlit playground and runnable examples.
+
+[0.1.0]: https://github.com/open-lab-technologies/natlas-sdk/releases/tag/v0.1.0

pynatlas-0.1.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.

pynatlas-0.1.0/NOTICE

@@ -0,0 +1,23 @@
+pynatlas
+Copyright 2026 Open Lab Technologies. Licensed under the Apache License, Version 2.0
+(see LICENSE).
+
+This package's code is Apache-2.0. The N-ATLaS language model and the NCAIR1
+speech models it downloads and serves are not: they are released by Awarri
+Technologies and the Federal Ministry of Communications, Innovation and Digital
+Economy under the N-ATLaS Open-Source Research and Innovation License, published
+on https://huggingface.co/NCAIR1/N-ATLaS. Anyone deploying them through this
+package must follow those terms, which include:
+
+- Attribution in all public use:
+  "N-ATLaS is an initiative of the Federal Ministry of Communications, Innovation
+  and Digital Economy, and powered by Awarri Technologies."
+- A cap of 1,000 active end-users in any rolling 30-day period. Above that, a
+  commercial licence from Awarri Technologies is required.
+- Derivative works released under the same terms, and renamed models carrying
+  the suffix "Powered by Awarri".
+- No surveillance, discriminatory profiling, disinformation, impersonation,
+  fraud, or military use.
+
+The quantised GGUF weights fetched by `pynatlas download` are a community
+conversion by QuantFactory of NCAIR1/N-ATLaS and carry the same terms.

pynatlas-0.1.0/PKG-INFO

@@ -0,0 +1,337 @@
+Metadata-Version: 2.5
+Name: pynatlas
+Version: 0.1.0
+Summary: Python SDK, OpenAI-compatible server and benchmark kit for N-ATLaS, Nigeria's open multilingual LLM
+Project-URL: Repository, https://github.com/open-lab-technologies/natlas-sdk
+Project-URL: Issues, https://github.com/open-lab-technologies/natlas-sdk/issues
+Project-URL: Changelog, https://github.com/open-lab-technologies/natlas-sdk/blob/main/CHANGELOG.md
+Author: Nazeh Abel
+Maintainer: Open Lab Technologies
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: hausa,igbo,llm,n-atlas,nigeria,speech-recognition,yoruba
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+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: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: httpx>=0.27
+Provides-Extra: asr
+Requires-Dist: numpy>=1.24; extra == 'asr'
+Requires-Dist: soundfile>=0.12; extra == 'asr'
+Requires-Dist: soxr>=0.3; extra == 'asr'
+Requires-Dist: torch>=2.4; extra == 'asr'
+Requires-Dist: transformers>=4.44; extra == 'asr'
+Provides-Extra: bench
+Requires-Dist: jiwer>=3.0; extra == 'bench'
+Requires-Dist: sacrebleu>=2.4; extra == 'bench'
+Provides-Extra: server
+Requires-Dist: fastapi>=0.115; extra == 'server'
+Requires-Dist: jinja2>=3.1; extra == 'server'
+Requires-Dist: llama-cpp-python>=0.3.8; extra == 'server'
+Requires-Dist: python-multipart>=0.0.9; extra == 'server'
+Requires-Dist: uvicorn>=0.30; extra == 'server'
+Description-Content-Type: text/markdown
+
+# pynatlas
+
+Python SDK for [N-ATLaS](https://huggingface.co/NCAIR1/N-ATLaS), Nigeria's open
+language model for English, Hausa, Igbo and Yoruba, and its speech recognition
+models. It works with any OpenAI-compatible endpoint serving N-ATLaS, can run
+one locally, and publishes measured results for every language it supports.
+
+## Install
+
+```bash
+pip install pynatlas
+```
+
+| Install            | Adds                                                            | Size   |
+| ------------------ | --------------------------------------------------------------- | ------ |
+| `pynatlas`         | Sync and async clients                                          | 2.5 MB |
+| `pynatlas[server]` | `pynatlas serve`: N-ATLaS on your machine behind the OpenAI API | 109 MB |
+| `pynatlas[asr]`    | Speech recognition for `pynatlas serve --asr`                   | 690 MB |
+| `pynatlas[bench]`  | `pynatlas bench`: benchmarks for any endpoint                   | 51 MB  |
+
+Python 3.10 or newer. `import pynatlas` loads only httpx. Release notes are in
+the [changelog](https://github.com/open-lab-technologies/natlas-sdk/blob/main/CHANGELOG.md).
+
+## Quick start
+
+```python
+from pynatlas import NAtlas
+
+client = NAtlas(base_url="http://localhost:8000/v1")
+
+client.chat("Kí ni olú ìlú Nàìjíríà?").text        # 'Olú ìlú Nàìjíríà ni Abuja.'
+client.translate("Wash your hands before eating.", to="ig")
+client.transcribe("voice-note.ogg", language="ha")  # needs a server with speech
+
+for piece in client.stream("Ka bayyana mini menene noma a takaice"):
+    print(piece, end="")
+```
+
+To run N-ATLaS locally:
+
+```bash
+pip install "pynatlas[server]"
+pynatlas download      # 4.9 GB, 4-bit weights
+pynatlas serve         # http://127.0.0.1:8000/v1
+```
+
+To run the model on the GPU, install the server extra with
+`CMAKE_ARGS="-DGGML_METAL=on"` on Apple Silicon or `CMAKE_ARGS="-DGGML_CUDA=on"`
+on NVIDIA.
+
+## Client
+
+### Providers
+
+| Provider                       | `base_url`                  | `model`             |
+| ------------------------------ | --------------------------- | ------------------- |
+| `pynatlas serve`               | `http://localhost:8000/v1`  | `n-atlas` (default) |
+| vLLM with the official weights | `http://host:8000/v1`       | `NCAIR1/N-ATLaS`    |
+| llama.cpp server               | `http://host:8080/v1`       | its `--model_alias` |
+| Ollama                         | `http://localhost:11434/v1` | your model tag      |
+
+Requests carry standard OpenAI fields only. Provider-specific options pass
+through as keyword arguments, such as `repetition_penalty=1.12` on vLLM. Tested
+end to end against `pynatlas serve` and llama.cpp's server.
+
+### Helpers
+
+```python
+from pynatlas import detect_language
+
+detect_language("Bawo ni o se wa?")                       # 'yo', offline, no model call
+client.summarize(article)                                 # in the article's own language
+client.classify(message, ["complaint", "praise", "question"])
+client.voice_chat("voice-note.ogg", language="ha")        # transcript and reply
+```
+
+`detect_language` needs no model and is over 99% accurate on held-out text.
+`classify` enforces the label set, so the answer is always one of your labels.
+
+### Tool calling
+
+Pass plain functions; type hints and the docstring become the tool definition.
+
+```python
+def get_market_price(commodity: str, market: str) -> dict:
+    """Today's price of a food commodity at a named market."""
+    return {"naira_per_kg": 1450}
+
+reply = client.run_tools("Nawa ne farashin shinkafa a kasuwar Kano?", [get_market_price])
+reply.text  # answer written from the tool's result
+```
+
+`run_tools` loops until the model answers in text; a tool's exception goes back
+to the model instead of being raised. For step-by-step control, pass
+`tools=[...]` to `chat()` and read `reply.tool_calls`. `tool_choice` takes
+`"auto"`, `"none"`, `"required"` or a function name.
+
+### Structured output
+
+```python
+from typing import Literal
+from pydantic import BaseModel
+
+class Feedback(BaseModel):
+    language: Literal["en", "ha", "ig", "yo"]
+    sentiment: Literal["positive", "neutral", "negative"]
+
+client.chat("Classify: Kayan sun iso a makare.", response_format=Feedback).parsed
+```
+
+`response_format` also takes a JSON schema dict. `pynatlas serve`, vLLM and
+llama.cpp enforce the schema while generating, so the reply is always valid.
+Elsewhere the client reads JSON out of code fences, and if the reply still does
+not match, it shows the model the error and asks again (`format_retries`)
+before raising `StructuredOutputError`. Pydantic is needed only if you pass a
+Pydantic model.
+
+### Async
+
+`AsyncNAtlas` has the same methods as coroutines, and `run_tools` accepts
+async functions.
+
+```python
+async with AsyncNAtlas() as client:
+    reply = await client.chat("Sannu!")
+```
+
+### Errors and retries
+
+Connection failures and 408, 409, 429 and 5xx responses are retried with
+backoff, honouring `Retry-After`. A retried chat request can run the model
+twice; pass `max_retries=0` where that matters. Everything raised derives from
+`NAtlasError`:
+
+| Exception                               | When                                                          |
+| --------------------------------------- | ------------------------------------------------------------- |
+| `APIConnectionError`, `APITimeoutError` | Endpoint unreachable or too slow                              |
+| `BadRequestError`                       | 400 or 422, including a prompt longer than the context window |
+| `AuthenticationError`                   | 401 or 403                                                    |
+| `NotFoundError`                         | 404, or the endpoint lacks the feature                        |
+| `RateLimitError`, `InternalServerError` | 429 or 5xx after retries                                      |
+| `StructuredOutputError`                 | Reply does not match `response_format`                        |
+| `ToolLoopError`                         | `run_tools` hit `max_rounds`                                  |
+| `ConfigError`                           | A setting is malformed                                        |
+
+### Configuration
+
+| Variable             | Default                                      |
+| -------------------- | -------------------------------------------- |
+| `NATLAS_BASE_URL`    | `http://localhost:8000/v1`                   |
+| `NATLAS_API_KEY`     | none                                         |
+| `NATLAS_MODEL`       | `n-atlas`                                    |
+| `NATLAS_TIMEOUT`     | `120` seconds                                |
+| `NATLAS_MAX_RETRIES` | `2`                                          |
+| `NATLAS_MODEL_PATH`  | the downloaded weights, for `pynatlas serve` |
+| `NATLAS_CACHE`       | `~/.cache/pynatlas`                          |
+
+Client arguments override these. A malformed value raises `ConfigError` naming
+the variable, and `pynatlas config` shows what is in effect.
+
+## Server
+
+`pynatlas serve` puts a GGUF build behind the OpenAI API, so the official
+`openai` package works unchanged, including tool calls, streaming and
+`chat.completions.parse()`.
+
+```bash
+pynatlas serve --asr                                               # speech to text too
+pynatlas serve --host 0.0.0.0 --api-key "$(openssl rand -hex 16)"  # to share it
+```
+
+It handles one request at a time; for concurrent users, serve the official
+weights with vLLM (see Deployment). Other backends plug in through the `Engine`
+protocol in `pynatlas.engine`, and speech backends through
+`pynatlas.asr.Transcriber`.
+
+The NCAIR1 speech models are gated: accept the terms on each model page on
+Hugging Face, then run `hf auth login`. m4a and webm audio need ffmpeg.
+
+## Deployment
+
+### Docker
+
+```bash
+docker build -t pynatlas .
+docker run -p 8000:8000 -v pynatlas-data:/data -e NATLAS_API_KEY=change-me pynatlas
+```
+
+Weights download to the `/data` volume on first start. For speech, build with
+`--build-arg EXTRAS=server,asr`, pass `HF_TOKEN` and add `--asr` to the run.
+
+### On a GPU
+
+Point `base_url` at the GPU host; the client does not change.
+
+- vLLM, for many users: `vllm serve NCAIR1/N-ATLaS` with
+  `model="NCAIR1/N-ATLaS"`. Tool-call safeguards are `pynatlas serve` features,
+  so run `pynatlas bench --tasks tool-calling` against vLLM before relying on
+  tool calls.
+- `pynatlas serve`, for demos: install with `CMAKE_ARGS="-DGGML_CUDA=on"`.
+
+## Command line
+
+| Command                                                | Does                                      |
+| ------------------------------------------------------ | ----------------------------------------- |
+| `pynatlas download [--quant Q4_K_M]`                   | Fetch weights, resumable and hash-checked |
+| `pynatlas serve [--asr] [--api-key KEY] [--date DATE]` | Run the local server                      |
+| `pynatlas chat ["prompt"]`                             | Chat, or answer one prompt                |
+| `pynatlas translate "text" --to yo`                    | Translate between en, ha, ig and yo       |
+| `pynatlas transcribe file --language ha`               | Speech to text                            |
+| `pynatlas bench [--tasks ...] [-n 100]`                | Run benchmarks                            |
+| `pynatlas config`                                      | Show settings in effect                   |
+
+`--base-url` and `--model` point every command except `serve` and `download` at
+any endpoint.
+
+## Benchmarks
+
+`pynatlas bench` scores any endpoint and saves every reply next to its expected
+answer. Results for the 4-bit model on Apple Silicon, temperature 0:
+
+|                                          | English | Hausa | Igbo | Yoruba |
+| ---------------------------------------- | ------: | ----: | ---: | -----: |
+| AfriMMLU knowledge, % (chance 25)        |      53 |    35 |   41 |     37 |
+| AfriXNLI reasoning, % (chance 33)        |      69 |    58 |   57 |     53 |
+| AfriMGSM maths, %                        |      69 |    43 |   36 |     40 |
+| MAFAND translation from English, chrF++  |         |  33.7 | 41.0 |   28.0 |
+| MAFAND translation into English, chrF++  |         |  37.4 | 40.7 |   41.7 |
+| FLEURS speech, WER % (lower is better)   |     9.0 |  31.3 | 43.8 |   55.7 |
+| FLEURS speech ignoring tone marks, WER % |     9.0 |  31.3 | 37.3 |   28.8 |
+| Tool calling, held-out set, % correct    |     100 |    90 |   80 |     80 |
+| Language detection, held-out text, %     |    99.8 |  99.9 | 99.6 |   99.6 |
+
+- 100 items per language for text tasks (about ±10 points), 50 clips for
+  speech, 10 questions for tool calling.
+- Many FLEURS Yoruba references omit tone marks the model writes, which inflates
+  the strict Yoruba WER.
+- Tool calling uses questions and tools kept out of its design. Plain prompting
+  scores 21 of 40 and calls a tool for every question that needs none; this SDK
+  scores 35 of 40. Non-English questions are not reviewed by native speakers.
+- Language detection is trained on AfriXNLI dev and scored on its test split.
+- Some test items may have been in N-ATLaS's training data.
+- Runs used `pynatlas serve --date "10 Oct 2026"`; the template dates every
+  prompt, so only the same date reproduces them exactly.
+
+Datasets: [IrokoBench](https://huggingface.co/collections/masakhane/irokobench)
+(Apache-2.0), [MAFAND-MT](https://github.com/masakhane-io/lafand-mt) (GPL-3.0)
+and [FLEURS](https://huggingface.co/datasets/google/fleurs) (CC-BY-4.0), all
+downloaded at run time. Full replies are in
+[bench-results](https://github.com/open-lab-technologies/natlas-sdk/tree/main/bench-results/).
+
+## Known limitations
+
+- Yoruba output is the weakest: free-form answers are often incoherent and drop
+  tone marks, and Yoruba words inside tool arguments can come out garbled.
+- Structured output guarantees the JSON's shape, not its content. Field values
+  can be wrong, such as a Hausa message labelled English.
+- The model makes at most one tool call per turn.
+- `detect_language` knows only English, Hausa, Igbo and Yoruba; text in any
+  other language is still labelled as one of them.
+- Q2_K and Q3_K_M weights lose real quality; use Q4_K_M or larger.
+- The GGUF weights are a community conversion (QuantFactory), pinned and
+  hash-checked, not published by NCAIR.
+
+## Development
+
+```bash
+uv venv && uv pip install -e ".[server,asr,bench]" --group dev
+pytest                                   # unit tests, no model needed
+ruff check src tests playground examples
+mypy                                     # strict type check
+```
+
+End-to-end tests run against a live server:
+
+```bash
+pynatlas serve --asr --api-key test-key
+NATLAS_E2E_URL=http://127.0.0.1:8000/v1 NATLAS_E2E_API_KEY=test-key pytest tests/test_live.py
+```
+
+`examples/` has runnable scripts, and `streamlit run playground/app.py` (after
+`uv pip install --group playground`) opens a browser playground.
+
+## Licence
+
+The code is Apache-2.0, maintained by Open Lab Technologies. The N-ATLaS and
+speech models it runs are under the N-ATLaS Open-Source Research and Innovation
+License, which requires attribution in all public use and caps deployments at
+1,000 active end-users a month without a commercial licence. Read the
+[NOTICE](https://github.com/open-lab-technologies/natlas-sdk/blob/main/NOTICE) before
+deploying.
+
+N-ATLaS is an initiative of the Federal Ministry of Communications, Innovation
+and Digital Economy, and powered by Awarri Technologies.