docs: update card to bigsmall v3.14.1 (V10 streaming, version pin)
Browse files
README.md
CHANGED
|
@@ -15,7 +15,7 @@ tags:
|
|
| 15 |
## Use it in 2 lines
|
| 16 |
|
| 17 |
```bash
|
| 18 |
-
pip install bigsmall
|
| 19 |
```
|
| 20 |
|
| 21 |
```python
|
|
@@ -55,10 +55,19 @@ model = BigSmallStreamingModel.from_pretrained(
|
|
| 55 |
|
| 56 |
Uses up to ~12× less VRAM than standard loading by streaming layers on demand.
|
| 57 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 58 |
## Decompress to safetensors
|
| 59 |
|
| 60 |
```bash
|
| 61 |
-
pip install bigsmall
|
| 62 |
bigsmall decompress wpferrell/mistral-7b-instruct-bigsmall -o mistral-7b-instruct-bigsmall/
|
| 63 |
```
|
| 64 |
|
|
@@ -69,7 +78,7 @@ This is a lossless-compressed copy of [mistralai/Mistral-7B-Instruct-v0.3](https
|
|
| 69 |
## Want to compress your own model?
|
| 70 |
|
| 71 |
```bash
|
| 72 |
-
pip install bigsmall
|
| 73 |
bigsmall compress my-model/ -o my-model.bs
|
| 74 |
```
|
| 75 |
|
|
@@ -95,4 +104,4 @@ See [github.com/wpferrell/Bigsmall](https://github.com/wpferrell/Bigsmall) for t
|
|
| 95 |
|
| 96 |
## Requires
|
| 97 |
|
| 98 |
-
`bigsmall >= 3.
|
|
|
|
| 15 |
## Use it in 2 lines
|
| 16 |
|
| 17 |
```bash
|
| 18 |
+
pip install "bigsmall>=3.14.1"
|
| 19 |
```
|
| 20 |
|
| 21 |
```python
|
|
|
|
| 55 |
|
| 56 |
Uses up to ~12× less VRAM than standard loading by streaming layers on demand.
|
| 57 |
|
| 58 |
+
## Stream straight from the Hub (no disk)
|
| 59 |
+
|
| 60 |
+
```python
|
| 61 |
+
import bigsmall
|
| 62 |
+
state_dict = bigsmall.stream_from_hub("wpferrell/mistral-7b-instruct-bigsmall", device="cpu")
|
| 63 |
+
```
|
| 64 |
+
|
| 65 |
+
Decompresses directly from the HuggingFace CDN over HTTP range requests. With the default `cache=False`, no `.bs` file is ever written to disk (V10).
|
| 66 |
+
|
| 67 |
## Decompress to safetensors
|
| 68 |
|
| 69 |
```bash
|
| 70 |
+
pip install "bigsmall>=3.14.1"
|
| 71 |
bigsmall decompress wpferrell/mistral-7b-instruct-bigsmall -o mistral-7b-instruct-bigsmall/
|
| 72 |
```
|
| 73 |
|
|
|
|
| 78 |
## Want to compress your own model?
|
| 79 |
|
| 80 |
```bash
|
| 81 |
+
pip install "bigsmall>=3.14.1"
|
| 82 |
bigsmall compress my-model/ -o my-model.bs
|
| 83 |
```
|
| 84 |
|
|
|
|
| 104 |
|
| 105 |
## Requires
|
| 106 |
|
| 107 |
+
`bigsmall >= 3.14.1` for the latest features. Earlier versions (>= 3.0.0) can still decode this model.
|