docs: add Zenodo DOI badge
Browse files
README.md
CHANGED
|
@@ -1,55 +1 @@
|
|
| 1 |
-
|
| 2 |
-
license: mit
|
| 3 |
-
tags:
|
| 4 |
-
- bigsmall
|
| 5 |
-
- compressed
|
| 6 |
-
- lossless
|
| 7 |
-
---
|
| 8 |
-
|
| 9 |
-
# Phi-3.5 Mini Instruct — BigSmall Compressed
|
| 10 |
-
|
| 11 |
-
Lossless compressed version of [microsoft/Phi-3.5-mini-instruct](https://huggingface.co/microsoft/Phi-3.5-mini-instruct).
|
| 12 |
-
**65.6% smaller. Bit-identical weights. No quality loss.**
|
| 13 |
-
|
| 14 |
-
## Quick start
|
| 15 |
-
|
| 16 |
-
```bash
|
| 17 |
-
pip install bigsmall
|
| 18 |
-
```
|
| 19 |
-
|
| 20 |
-
```python
|
| 21 |
-
from transformers import AutoModelForCausalLM, AutoTokenizer
|
| 22 |
-
|
| 23 |
-
model = AutoModelForCausalLM.from_pretrained("wpferrell/phi-3.5-mini-instruct-bigsmall")
|
| 24 |
-
tokenizer = AutoTokenizer.from_pretrained("microsoft/Phi-3.5-mini-instruct")
|
| 25 |
-
```
|
| 26 |
-
|
| 27 |
-
## Low-VRAM streaming
|
| 28 |
-
|
| 29 |
-
```python
|
| 30 |
-
from bigsmall import BigSmallStreamingModel
|
| 31 |
-
|
| 32 |
-
model = BigSmallStreamingModel.from_pretrained("wpferrell/phi-3.5-mini-instruct-bigsmall")
|
| 33 |
-
```
|
| 34 |
-
|
| 35 |
-
## Details
|
| 36 |
-
|
| 37 |
-
| | Value |
|
| 38 |
-
|---|---|
|
| 39 |
-
| Original model | [microsoft/Phi-3.5-mini-instruct](https://huggingface.co/microsoft/Phi-3.5-mini-instruct) |
|
| 40 |
-
| Original size | 7.2 GB |
|
| 41 |
-
| Compressed size | 4.67 GB |
|
| 42 |
-
| Compression ratio | 65.6% of original |
|
| 43 |
-
| Format | BigSmall lossless (.bs) |
|
| 44 |
-
| Reconstruction | Bit-identical, md5-verified |
|
| 45 |
-
| Requires | bigsmall >= 3.0.0 |
|
| 46 |
-
|
| 47 |
-
## All pre-compressed models
|
| 48 |
-
|
| 49 |
-
See [wpferrell on HuggingFace](https://huggingface.co/wpferrell) for all available models.
|
| 50 |
-
|
| 51 |
-
## License
|
| 52 |
-
|
| 53 |
-
Model weights: same license as the original model ([microsoft/Phi-3.5-mini-instruct](https://huggingface.co/microsoft/Phi-3.5-mini-instruct)).
|
| 54 |
-
BigSmall format: [Elastic License 2.0](https://www.elastic.co/licensing/elastic-license) — free for personal, research, and internal commercial use.
|
| 55 |
-
Commercial/SaaS licensing: wpferrell@gmail.com
|
|
|
|
| 1 |
+
LS0tDQpsaWNlbnNlOiBtaXQNCnRhZ3M6DQogIC0gYmlnc21hbGwNCiAgLSBjb21wcmVzc2VkDQogIC0gbG9zc2xlc3MNCi0tLQ0KClshW0RPSV0oaHR0cHM6Ly96ZW5vZG8ub3JnL2JhZGdlL0RPSS8xMC41MjgxL3plbm9kby4yMDI3OTI0OC5zdmcpXShodHRwczovL2RvaS5vcmcvMTAuNTI4MS96ZW5vZG8uMjAyNzkyNDgpCg0KIyBQaGktMy41IE1pbmkgSW5zdHJ1Y3Qg4oCUIEJpZ1NtYWxsIENvbXByZXNzZWQNCg0KTG9zc2xlc3MgY29tcHJlc3NlZCB2ZXJzaW9uIG9mIFttaWNyb3NvZnQvUGhpLTMuNS1taW5pLWluc3RydWN0XShodHRwczovL2h1Z2dpbmdmYWNlLmNvL21pY3Jvc29mdC9QaGktMy41LW1pbmktaW5zdHJ1Y3QpLg0KKio2NS42JSBzbWFsbGVyLiBCaXQtaWRlbnRpY2FsIHdlaWdodHMuIE5vIHF1YWxpdHkgbG9zcy4qKg0KDQojIyBRdWljayBzdGFydA0KDQpgYGBiYXNoDQpwaXAgaW5zdGFsbCBiaWdzbWFsbA0KYGBgDQoNCmBgYHB5dGhvbg0KZnJvbSB0cmFuc2Zvcm1lcnMgaW1wb3J0IEF1dG9Nb2RlbEZvckNhdXNhbExNLCBBdXRvVG9rZW5pemVyDQoNCm1vZGVsID0gQXV0b01vZGVsRm9yQ2F1c2FsTE0uZnJvbV9wcmV0cmFpbmVkKCJ3cGZlcnJlbGwvcGhpLTMuNS1taW5pLWluc3RydWN0LWJpZ3NtYWxsIikNCnRva2VuaXplciA9IEF1dG9Ub2tlbml6ZXIuZnJvbV9wcmV0cmFpbmVkKCJtaWNyb3NvZnQvUGhpLTMuNS1taW5pLWluc3RydWN0IikNCmBgYA0KDQojIyBMb3ctVlJBTSBzdHJlYW1pbmcNCg0KYGBgcHl0aG9uDQpmcm9tIGJpZ3NtYWxsIGltcG9ydCBCaWdTbWFsbFN0cmVhbWluZ01vZGVsDQoNCm1vZGVsID0gQmlnU21hbGxTdHJlYW1pbmdNb2RlbC5mcm9tX3ByZXRyYWluZWQoIndwZmVycmVsbC9waGktMy41LW1pbmktaW5zdHJ1Y3QtYmlnc21hbGwiKQ0KYGBgDQoNCiMjIERldGFpbHMNCg0KfCB8IFZhbHVlIHwNCnwtLS18LS0tfA0KfCBPcmlnaW5hbCBtb2RlbCB8IFttaWNyb3NvZnQvUGhpLTMuNS1taW5pLWluc3RydWN0XShodHRwczovL2h1Z2dpbmdmYWNlLmNvL21pY3Jvc29mdC9QaGktMy41LW1pbmktaW5zdHJ1Y3QpIHwNCnwgT3JpZ2luYWwgc2l6ZSB8IDcuMiBHQiB8DQp8IENvbXByZXNzZWQgc2l6ZSB8IDQuNjcgR0IgfA0KfCBDb21wcmVzc2lvbiByYXRpbyB8IDY1LjYlIG9mIG9yaWdpbmFsIHwNCnwgRm9ybWF0IHwgQmlnU21hbGwgbG9zc2xlc3MgKC5icykgfA0KfCBSZWNvbnN0cnVjdGlvbiB8IEJpdC1pZGVudGljYWwsIG1kNS12ZXJpZmllZCB8DQp8IFJlcXVpcmVzIHwgYmlnc21hbGwgPj0gMy4wLjAgfA0KDQojIyBBbGwgcHJlLWNvbXByZXNzZWQgbW9kZWxzDQoNClNlZSBbd3BmZXJyZWxsIG9uIEh1Z2dpbmdGYWNlXShodHRwczovL2h1Z2dpbmdmYWNlLmNvL3dwZmVycmVsbCkgZm9yIGFsbCBhdmFpbGFibGUgbW9kZWxzLg0KDQojIyBMaWNlbnNlDQoNCk1vZGVsIHdlaWdodHM6IHNhbWUgbGljZW5zZSBhcyB0aGUgb3JpZ2luYWwgbW9kZWwgKFttaWNyb3NvZnQvUGhpLTMuNS1taW5pLWluc3RydWN0XShodHRwczovL2h1Z2dpbmdmYWNlLmNvL21pY3Jvc29mdC9QaGktMy41LW1pbmktaW5zdHJ1Y3QpKS4NCkJpZ1NtYWxsIGZvcm1hdDogW0VsYXN0aWMgTGljZW5zZSAyLjBdKGh0dHBzOi8vd3d3LmVsYXN0aWMuY28vbGljZW5zaW5nL2VsYXN0aWMtbGljZW5zZSkg4oCUIGZyZWUgZm9yIHBlcnNvbmFsLCByZXNlYXJjaCwgYW5kIGludGVybmFsIGNvbW1lcmNpYWwgdXNlLg0KQ29tbWVyY2lhbC9TYWFTIGxpY2Vuc2luZzogd3BmZXJyZWxsQGdtYWlsLmNvbQ0K
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|