mlx-learn 0.1.0a1__tar.gz

mlx_learn-0.1.0a1/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 2026 Bojan Tunguz
+
+   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.

mlx_learn-0.1.0a1/PKG-INFO

@@ -0,0 +1,226 @@
+Metadata-Version: 2.4
+Name: mlx-learn
+Version: 0.1.0a1
+Summary: MLX-accelerated classical machine learning with a scikit-learn compatible API for Apple silicon
+Author: Bojan Tunguz
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/tabulai/mlxlearn
+Project-URL: Repository, https://github.com/tabulai/mlxlearn
+Project-URL: Changelog, https://github.com/tabulai/mlxlearn/blob/main/CHANGELOG.md
+Project-URL: Issues, https://github.com/tabulai/mlxlearn/issues
+Keywords: machine-learning,mlx,apple-silicon,scikit-learn,gpu
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: MacOS :: MacOS X
+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
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: THIRD_PARTY_NOTICES.md
+Requires-Dist: numpy>=1.23.5
+Requires-Dist: scikit-learn<1.10,>=1.7
+Requires-Dist: mlx<1.0,>=0.29
+Provides-Extra: test
+Requires-Dist: pytest>=8.0; extra == "test"
+Requires-Dist: scipy>=1.10; extra == "test"
+Requires-Dist: packaging>=23.0; extra == "test"
+Provides-Extra: bench
+Requires-Dist: pytest>=8.0; extra == "bench"
+Requires-Dist: scipy>=1.10; extra == "bench"
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: scipy>=1.10; extra == "dev"
+Requires-Dist: ruff>=0.6; extra == "dev"
+Requires-Dist: build>=1.2; extra == "dev"
+Requires-Dist: twine>=5.0; extra == "dev"
+Dynamic: license-file
+
+# mlxlearn
+
+**Classical machine learning on Apple silicon, accelerated with [MLX](https://github.com/ml-explore/mlx), with a scikit-learn compatible API.**
+
+> mlxlearn is not officially associated with scikit-learn or PROBABL, nor with Apple.
+
+`mlxlearn` has two layers.
+
+**Layer 1 — the library.** Explicit imports, typed solver configuration and state, strict
+errors, eager `fit`, no mutation of scikit-learn, no data-keyed caches:
+
+```python
+from mlxlearn.neighbors import KNeighborsClassifier
+
+clf = KNeighborsClassifier(n_neighbors=5).fit(X_train, y_train)
+y_pred = clf.predict(X_test)
+```
+
+**Layer 2 — the patching shell.** A thin adapter that points scikit-learn's own names at
+Layer 1 estimators, so existing code — including code an LLM generated against the
+scikit-learn API — runs accelerated without being edited:
+
+```python
+from mlxlearn import patch_sklearn
+patch_sklearn()
+
+from sklearn.svm import SVC          # now resolves to the accelerated class
+```
+
+The numerical library is fully usable and fully tested with the patching mechanism absent.
+
+## Status
+
+**`0.1.0a1` — alpha.** The API may change. See [CHANGELOG.md](CHANGELOG.md).
+
+| Estimator | Status |
+|---|---|
+| `mlxlearn.neighbors.NearestNeighbors` | 0.1.0 |
+| `mlxlearn.neighbors.KNeighborsClassifier` | 0.1.0 |
+| `mlxlearn.neighbors.KNeighborsRegressor` | 0.1.0 |
+| `mlxlearn.linear_model.LogisticRegression` | 0.1.0 |
+| `mlxlearn.svm.SVC` (exact) | 0.1.0 |
+| `LinearRegression`, `Ridge`, `PCA`, `KMeans`, `DBSCAN`, `TSNE` | planned, 0.2.x |
+| `SVR`, `NuSVR`, `NuSVC` | deferred — will not ship until they implement the true objective |
+| tree ensembles | out of scope |
+
+## Requirements
+
+- macOS on Apple silicon (arm64)
+- Python 3.10 – 3.13
+- scikit-learn ≥ 1.7, MLX ≥ 0.29
+
+Python 3.10 is supported against scikit-learn ≤ 1.8; scikit-learn 1.9 requires Python ≥ 3.11.
+CI tests only valid pairs — see [`docs/support_matrix.md`](docs/support_matrix.md).
+
+## Install
+
+```bash
+pip install mlx-learn
+```
+
+`0.1.0a1` ships as a pure-Python wheel — no compiler, no build step, no ABI matrix.
+
+## Import-order semantics
+
+Patching replaces attributes **on scikit-learn modules**. Attribute access
+(`sklearn.svm.SVC`) therefore resolves to the mlxlearn class whether `import sklearn`
+happened before or after `patch_sklearn()`.
+
+Symbols captured *before* patching are local bindings and cannot be rebound:
+
+```python
+from sklearn.svm import SVC     # binds the stock class into your namespace
+patch_sklearn()                 # cannot reach back and change SVC
+SVC()                           # still the stock class
+```
+
+That is Python name binding, not a bug in mlxlearn. **The supported pattern is patch-first.**
+`patch_sklearn()` is idempotent, and `unpatch_sklearn()` fully restores scikit-learn.
+
+## When mlxlearn falls back
+
+Layer 1 raises a precise error when it cannot honor a request. Layer 2 falls back to stock
+scikit-learn instead — but only for *capability* mismatches (sparse input, an unsupported
+parameter, an unsupported dtype), never to hide a bug:
+
+| Situation | Direct import | Patched |
+|---|---|---|
+| Capability mismatch | precise `MLXLearnError` | falls back, warns once per class, records diagnostics |
+| Problem below the measured crossover | internal CPU path | dispatches to scikit-learn |
+| Invalid user input | sklearn-equivalent validation error | scikit-learn's own exception, unmasked |
+| Unexpected MLX runtime failure | raises | **raises** — never silently rerun on scikit-learn |
+
+Set the policy with `fallback_policy="warn" | "raise" | "silent"`. Diagnostics are recorded
+in every mode:
+
+```python
+import mlxlearn
+
+with mlxlearn.config_context(fallback_policy="raise"):
+    ...                                     # any capability fallback becomes an error
+
+mlxlearn.get_last_backend_event()           # what the last fit/predict actually did
+mlxlearn.get_backend_diagnostics()          # everything recorded this session
+```
+
+**Sticky backend.** The backend is chosen during `fit` and recorded as
+`estimator._execution_backend_` (`"mlx"`, `"cpu"`, or `"sklearn"`). Every subsequent
+`predict` / `predict_proba` / `transform` / `kneighbors` uses the backend the model was
+fitted with. A model fitted on MLX can never wander into scikit-learn inference with
+incompatible state. A new `fit` clears state and may pick a different backend.
+
+## Configuration
+
+The public surface is deliberately small:
+
+```python
+mlxlearn.set_config(
+    device="auto",              # "auto" | "gpu" | "cpu"
+    fallback_policy="warn",     # "warn" | "raise" | "silent"
+    output_type="numpy",        # 0.1.0: NumPy in, NumPy out
+    deterministic=True,
+    random_state=0,
+    diagnostics=True,
+)
+```
+
+Crossover thresholds, block sizes, and solver tuning are private, typed, and overridable
+only through `MLXLEARN_*` environment variables for CI and debugging. They are not part of
+the public API.
+
+## Performance
+
+"Never slower than scikit-learn" is the design goal. The shipped *gate* is measurable: on
+each benchmarked workload class, patched dispatch shows no statistically significant
+regression against stock scikit-learn. Crossover points are measured per algorithm and per
+operation, published in [`docs/benchmarks.md`](docs/benchmarks.md), and wired into the
+dispatch thresholds — small problems are handed to scikit-learn on purpose.
+
+What that means in practice for 0.1.0a1, on an M4 Max:
+
+| | |
+|---|---|
+| **Neighbor queries** | **2.9×–17×** from ~250 samples up. This is the reason to use mlxlearn. |
+| Neighbor `fit` | 0.17×–0.36×. mlxlearn uploads to the device; scikit-learn stores a reference. The first query repays it several times over. |
+| `SVC` | **2.93× on wide data** (4 000 × 256, rbf), but slower than LIBSVM on narrow data — 0.47× at 4 000 × 32, worse below. `kernel="linear"` never uses MLX. Width decides, and patched dispatch routes accordingly. |
+| `LogisticRegression` | **Slower than scikit-learn below 1 024 features**, by a lot. The crossover is set high so patched dispatch hands those to scikit-learn; see [`docs/benchmarks.md`](docs/benchmarks.md) for why and what would change it. |
+
+Reproduce them:
+
+```bash
+python -m benchmarks.run --profile smoke
+```
+
+## Precision
+
+MLX computes in float32 on the GPU. mlxlearn's parity tests are written to float32
+tolerances, and the cases where float32 makes strict scikit-learn equivalence impossible
+are enumerated — not waved away — in [`docs/fp32_policy.md`](docs/fp32_policy.md).
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+pytest
+```
+
+Contributor rules, the estimator gate checklist, and the compliance checks are in
+[`docs/development.md`](docs/development.md).
+
+## Provenance
+
+mlxlearn succeeds a private research fork of an Intel-maintained scikit-learn accelerator.
+That history is not carried here: this repository was bootstrapped from an audited
+allowlist, and no source file was copied. The audit, the recorded behavioral baseline of
+the ancestor, and the authorship attestation are in [`phase0/`](phase0/). Full lineage,
+disclaimers, and third-party notices are in [`ACKNOWLEDGMENTS.md`](ACKNOWLEDGMENTS.md) and
+[`THIRD_PARTY_NOTICES.md`](THIRD_PARTY_NOTICES.md).
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE).

mlx_learn-0.1.0a1/README.md

@@ -0,0 +1,182 @@
+# mlxlearn
+
+**Classical machine learning on Apple silicon, accelerated with [MLX](https://github.com/ml-explore/mlx), with a scikit-learn compatible API.**
+
+> mlxlearn is not officially associated with scikit-learn or PROBABL, nor with Apple.
+
+`mlxlearn` has two layers.
+
+**Layer 1 — the library.** Explicit imports, typed solver configuration and state, strict
+errors, eager `fit`, no mutation of scikit-learn, no data-keyed caches:
+
+```python
+from mlxlearn.neighbors import KNeighborsClassifier
+
+clf = KNeighborsClassifier(n_neighbors=5).fit(X_train, y_train)
+y_pred = clf.predict(X_test)
+```
+
+**Layer 2 — the patching shell.** A thin adapter that points scikit-learn's own names at
+Layer 1 estimators, so existing code — including code an LLM generated against the
+scikit-learn API — runs accelerated without being edited:
+
+```python
+from mlxlearn import patch_sklearn
+patch_sklearn()
+
+from sklearn.svm import SVC          # now resolves to the accelerated class
+```
+
+The numerical library is fully usable and fully tested with the patching mechanism absent.
+
+## Status
+
+**`0.1.0a1` — alpha.** The API may change. See [CHANGELOG.md](CHANGELOG.md).
+
+| Estimator | Status |
+|---|---|
+| `mlxlearn.neighbors.NearestNeighbors` | 0.1.0 |
+| `mlxlearn.neighbors.KNeighborsClassifier` | 0.1.0 |
+| `mlxlearn.neighbors.KNeighborsRegressor` | 0.1.0 |
+| `mlxlearn.linear_model.LogisticRegression` | 0.1.0 |
+| `mlxlearn.svm.SVC` (exact) | 0.1.0 |
+| `LinearRegression`, `Ridge`, `PCA`, `KMeans`, `DBSCAN`, `TSNE` | planned, 0.2.x |
+| `SVR`, `NuSVR`, `NuSVC` | deferred — will not ship until they implement the true objective |
+| tree ensembles | out of scope |
+
+## Requirements
+
+- macOS on Apple silicon (arm64)
+- Python 3.10 – 3.13
+- scikit-learn ≥ 1.7, MLX ≥ 0.29
+
+Python 3.10 is supported against scikit-learn ≤ 1.8; scikit-learn 1.9 requires Python ≥ 3.11.
+CI tests only valid pairs — see [`docs/support_matrix.md`](docs/support_matrix.md).
+
+## Install
+
+```bash
+pip install mlx-learn
+```
+
+`0.1.0a1` ships as a pure-Python wheel — no compiler, no build step, no ABI matrix.
+
+## Import-order semantics
+
+Patching replaces attributes **on scikit-learn modules**. Attribute access
+(`sklearn.svm.SVC`) therefore resolves to the mlxlearn class whether `import sklearn`
+happened before or after `patch_sklearn()`.
+
+Symbols captured *before* patching are local bindings and cannot be rebound:
+
+```python
+from sklearn.svm import SVC     # binds the stock class into your namespace
+patch_sklearn()                 # cannot reach back and change SVC
+SVC()                           # still the stock class
+```
+
+That is Python name binding, not a bug in mlxlearn. **The supported pattern is patch-first.**
+`patch_sklearn()` is idempotent, and `unpatch_sklearn()` fully restores scikit-learn.
+
+## When mlxlearn falls back
+
+Layer 1 raises a precise error when it cannot honor a request. Layer 2 falls back to stock
+scikit-learn instead — but only for *capability* mismatches (sparse input, an unsupported
+parameter, an unsupported dtype), never to hide a bug:
+
+| Situation | Direct import | Patched |
+|---|---|---|
+| Capability mismatch | precise `MLXLearnError` | falls back, warns once per class, records diagnostics |
+| Problem below the measured crossover | internal CPU path | dispatches to scikit-learn |
+| Invalid user input | sklearn-equivalent validation error | scikit-learn's own exception, unmasked |
+| Unexpected MLX runtime failure | raises | **raises** — never silently rerun on scikit-learn |
+
+Set the policy with `fallback_policy="warn" | "raise" | "silent"`. Diagnostics are recorded
+in every mode:
+
+```python
+import mlxlearn
+
+with mlxlearn.config_context(fallback_policy="raise"):
+    ...                                     # any capability fallback becomes an error
+
+mlxlearn.get_last_backend_event()           # what the last fit/predict actually did
+mlxlearn.get_backend_diagnostics()          # everything recorded this session
+```
+
+**Sticky backend.** The backend is chosen during `fit` and recorded as
+`estimator._execution_backend_` (`"mlx"`, `"cpu"`, or `"sklearn"`). Every subsequent
+`predict` / `predict_proba` / `transform` / `kneighbors` uses the backend the model was
+fitted with. A model fitted on MLX can never wander into scikit-learn inference with
+incompatible state. A new `fit` clears state and may pick a different backend.
+
+## Configuration
+
+The public surface is deliberately small:
+
+```python
+mlxlearn.set_config(
+    device="auto",              # "auto" | "gpu" | "cpu"
+    fallback_policy="warn",     # "warn" | "raise" | "silent"
+    output_type="numpy",        # 0.1.0: NumPy in, NumPy out
+    deterministic=True,
+    random_state=0,
+    diagnostics=True,
+)
+```
+
+Crossover thresholds, block sizes, and solver tuning are private, typed, and overridable
+only through `MLXLEARN_*` environment variables for CI and debugging. They are not part of
+the public API.
+
+## Performance
+
+"Never slower than scikit-learn" is the design goal. The shipped *gate* is measurable: on
+each benchmarked workload class, patched dispatch shows no statistically significant
+regression against stock scikit-learn. Crossover points are measured per algorithm and per
+operation, published in [`docs/benchmarks.md`](docs/benchmarks.md), and wired into the
+dispatch thresholds — small problems are handed to scikit-learn on purpose.
+
+What that means in practice for 0.1.0a1, on an M4 Max:
+
+| | |
+|---|---|
+| **Neighbor queries** | **2.9×–17×** from ~250 samples up. This is the reason to use mlxlearn. |
+| Neighbor `fit` | 0.17×–0.36×. mlxlearn uploads to the device; scikit-learn stores a reference. The first query repays it several times over. |
+| `SVC` | **2.93× on wide data** (4 000 × 256, rbf), but slower than LIBSVM on narrow data — 0.47× at 4 000 × 32, worse below. `kernel="linear"` never uses MLX. Width decides, and patched dispatch routes accordingly. |
+| `LogisticRegression` | **Slower than scikit-learn below 1 024 features**, by a lot. The crossover is set high so patched dispatch hands those to scikit-learn; see [`docs/benchmarks.md`](docs/benchmarks.md) for why and what would change it. |
+
+Reproduce them:
+
+```bash
+python -m benchmarks.run --profile smoke
+```
+
+## Precision
+
+MLX computes in float32 on the GPU. mlxlearn's parity tests are written to float32
+tolerances, and the cases where float32 makes strict scikit-learn equivalence impossible
+are enumerated — not waved away — in [`docs/fp32_policy.md`](docs/fp32_policy.md).
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+pytest
+```
+
+Contributor rules, the estimator gate checklist, and the compliance checks are in
+[`docs/development.md`](docs/development.md).
+
+## Provenance
+
+mlxlearn succeeds a private research fork of an Intel-maintained scikit-learn accelerator.
+That history is not carried here: this repository was bootstrapped from an audited
+allowlist, and no source file was copied. The audit, the recorded behavioral baseline of
+the ancestor, and the authorship attestation are in [`phase0/`](phase0/). Full lineage,
+disclaimers, and third-party notices are in [`ACKNOWLEDGMENTS.md`](ACKNOWLEDGMENTS.md) and
+[`THIRD_PARTY_NOTICES.md`](THIRD_PARTY_NOTICES.md).
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE).