wpferrell commited on
Commit
b723495
·
verified ·
1 Parent(s): e1bad3d

docs: add Zenodo DOI badge

Browse files
Files changed (1) hide show
  1. README.md +1 -55
README.md CHANGED
@@ -1,55 +1 @@
1
- ---
2
- license: gemma
3
- tags:
4
- - bigsmall
5
- - compressed
6
- - lossless
7
- ---
8
-
9
- # Gemma 2 2B — BigSmall Compressed
10
-
11
- Lossless compressed version of [google/gemma-2-2b](https://huggingface.co/google/gemma-2-2b).
12
- **82.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/gemma-2-2b-bigsmall")
24
- tokenizer = AutoTokenizer.from_pretrained("google/gemma-2-2b")
25
- ```
26
-
27
- ## Low-VRAM streaming
28
-
29
- ```python
30
- from bigsmall import BigSmallStreamingModel
31
-
32
- model = BigSmallStreamingModel.from_pretrained("wpferrell/gemma-2-2b-bigsmall")
33
- ```
34
-
35
- ## Details
36
-
37
- | | Value |
38
- |---|---|
39
- | Original model | [google/gemma-2-2b](https://huggingface.co/google/gemma-2-2b) |
40
- | Original size | 9.8 GB |
41
- | Compressed size | 8.09 GB |
42
- | Compression ratio | 82.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 ([google/gemma-2-2b](https://huggingface.co/google/gemma-2-2b)).
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
+ LS0tDQpsaWNlbnNlOiBnZW1tYQ0KdGFnczoNCiAgLSBiaWdzbWFsbA0KICAtIGNvbXByZXNzZWQNCiAgLSBsb3NzbGVzcw0KLS0tDQoKWyFbRE9JXShodHRwczovL3plbm9kby5vcmcvYmFkZ2UvRE9JLzEwLjUyODEvemVub2RvLjIwMjc5MjQ4LnN2ZyldKGh0dHBzOi8vZG9pLm9yZy8xMC41MjgxL3plbm9kby4yMDI3OTI0OCkKDQojIEdlbW1hIDIgMkIg4oCUIEJpZ1NtYWxsIENvbXByZXNzZWQNCg0KTG9zc2xlc3MgY29tcHJlc3NlZCB2ZXJzaW9uIG9mIFtnb29nbGUvZ2VtbWEtMi0yYl0oaHR0cHM6Ly9odWdnaW5nZmFjZS5jby9nb29nbGUvZ2VtbWEtMi0yYikuDQoqKjgyLjYlIHNtYWxsZXIuIEJpdC1pZGVudGljYWwgd2VpZ2h0cy4gTm8gcXVhbGl0eSBsb3NzLioqDQoNCiMjIFF1aWNrIHN0YXJ0DQoNCmBgYGJhc2gNCnBpcCBpbnN0YWxsIGJpZ3NtYWxsDQpgYGANCg0KYGBgcHl0aG9uDQpmcm9tIHRyYW5zZm9ybWVycyBpbXBvcnQgQXV0b01vZGVsRm9yQ2F1c2FsTE0sIEF1dG9Ub2tlbml6ZXINCg0KbW9kZWwgPSBBdXRvTW9kZWxGb3JDYXVzYWxMTS5mcm9tX3ByZXRyYWluZWQoIndwZmVycmVsbC9nZW1tYS0yLTJiLWJpZ3NtYWxsIikNCnRva2VuaXplciA9IEF1dG9Ub2tlbml6ZXIuZnJvbV9wcmV0cmFpbmVkKCJnb29nbGUvZ2VtbWEtMi0yYiIpDQpgYGANCg0KIyMgTG93LVZSQU0gc3RyZWFtaW5nDQoNCmBgYHB5dGhvbg0KZnJvbSBiaWdzbWFsbCBpbXBvcnQgQmlnU21hbGxTdHJlYW1pbmdNb2RlbA0KDQptb2RlbCA9IEJpZ1NtYWxsU3RyZWFtaW5nTW9kZWwuZnJvbV9wcmV0cmFpbmVkKCJ3cGZlcnJlbGwvZ2VtbWEtMi0yYi1iaWdzbWFsbCIpDQpgYGANCg0KIyMgRGV0YWlscw0KDQp8IHwgVmFsdWUgfA0KfC0tLXwtLS18DQp8IE9yaWdpbmFsIG1vZGVsIHwgW2dvb2dsZS9nZW1tYS0yLTJiXShodHRwczovL2h1Z2dpbmdmYWNlLmNvL2dvb2dsZS9nZW1tYS0yLTJiKSB8DQp8IE9yaWdpbmFsIHNpemUgfCA5LjggR0IgfA0KfCBDb21wcmVzc2VkIHNpemUgfCA4LjA5IEdCIHwNCnwgQ29tcHJlc3Npb24gcmF0aW8gfCA4Mi42JSBvZiBvcmlnaW5hbCB8DQp8IEZvcm1hdCB8IEJpZ1NtYWxsIGxvc3NsZXNzICguYnMpIHwNCnwgUmVjb25zdHJ1Y3Rpb24gfCBCaXQtaWRlbnRpY2FsLCBtZDUtdmVyaWZpZWQgfA0KfCBSZXF1aXJlcyB8IGJpZ3NtYWxsID49IDMuMC4wIHwNCg0KIyMgQWxsIHByZS1jb21wcmVzc2VkIG1vZGVscw0KDQpTZWUgW3dwZmVycmVsbCBvbiBIdWdnaW5nRmFjZV0oaHR0cHM6Ly9odWdnaW5nZmFjZS5jby93cGZlcnJlbGwpIGZvciBhbGwgYXZhaWxhYmxlIG1vZGVscy4NCg0KIyMgTGljZW5zZQ0KDQpNb2RlbCB3ZWlnaHRzOiBzYW1lIGxpY2Vuc2UgYXMgdGhlIG9yaWdpbmFsIG1vZGVsIChbZ29vZ2xlL2dlbW1hLTItMmJdKGh0dHBzOi8vaHVnZ2luZ2ZhY2UuY28vZ29vZ2xlL2dlbW1hLTItMmIpKS4NCkJpZ1NtYWxsIGZvcm1hdDogW0VsYXN0aWMgTGljZW5zZSAyLjBdKGh0dHBzOi8vd3d3LmVsYXN0aWMuY28vbGljZW5zaW5nL2VsYXN0aWMtbGljZW5zZSkg4oCUIGZyZWUgZm9yIHBlcnNvbmFsLCByZXNlYXJjaCwgYW5kIGludGVybmFsIGNvbW1lcmNpYWwgdXNlLg0KQ29tbWVyY2lhbC9TYWFTIGxpY2Vuc2luZzogd3BmZXJyZWxsQGdtYWlsLmNvbQ0K