all-MiniLM-L6-v2 / README.md
martinkorelic's picture
Upload README.md with huggingface_hub
382e43c verified
|
Raw
History Blame Contribute Delete
2.64 kB
---
base_model: sentence-transformers/all-MiniLM-L6-v2
library_name: mobiletransformers
pipeline_tag: text-classification
tags:
- mobiletransformers
- onnx
- on-device
- android
- lora
- int4
---
![MobileTransformers](mobiletransformers_banner.png)
# sentence-transformers/all-MiniLM-L6-v2 β€” MobileTransformers package
On-device (Android) package exported from **sentence-transformers/all-MiniLM-L6-v2** with MobileTransformers.
## What this package can do
- `core` β€” shared files every other group needs
- `inference` β€” generate or score on device
- `train` β€” **fine-tune on device**, then merge the adapter back into the base weights
- `rag` β€” retrieve over documents you ingest, and ground answers in them
## Fine-tuning method
- **lora** β€” LoRA β€” low-rank adapters on the attention projections.
- Rank: `8`
- Adapted modules: `query`, `value`
## Provenance
- Base model: `sentence-transformers/all-MiniLM-L6-v2`
- Selected task: `text-classification`
- Quantization: int4
- Toolchain: optimum-onnx 0.1.0, transformers 4.57.6, ort-training 1.23.0+cpu
## Licenses
- Framework: not declared in this package β€” see the repository
- Base model weights: see the base model above (this package redistributes an export of those weights, so their terms govern its contents)
## Android runtime
- Minimum API: 28
- Required ABIs: any
## Variants
| id | EP | quant | engines | features | min API | rec. RAM (MB) |
| --- | --- | --- | --- | --- | --- | --- |
| cpu-int4 | cpu | int4 | native | core, inference, train, rag | 28 | β€” |
Default variant: `cpu-int4`.
## Running this model
This is a **MobileTransformers package**, not a plain Hugging Face model: it is a manifest plus per-variant ONNX stages and a weight-handoff map. `transformers`, `optimum` and plain `onnxruntime` cannot load it. Use the framework:
**https://github.com/martinkorelic/mobiletransformers**
```kotlin
// Android β€” pulls, verifies and installs on first use.
val model = MobileTransformers.fromPretrained(
context = context,
repoId = "mobiletransformers/all-MiniLM-L6-v2",
)
```
```bash
# Host β€” download and inspect the package without a device.
mobiletransformers pull --repo-id mobiletransformers/all-MiniLM-L6-v2
```
## Citation
If you are using this framework for your own work, please cite:
```bibtex
@misc{mobiletransformers2025,
author = {Koreli\v{c}, Martin and Pejovi{\'c}, Veljko},
title = {MobileTransformers: An On-Device LLM PEFT Framework for Fine-Tuning and Inference},
year = {2025},
howpublished = {\url{https://gitlab.fri.uni-lj.si/lrk/mobiletransformers}}
}
```