Update README.md
Browse files
README.md
CHANGED
|
@@ -70,6 +70,38 @@ Users (both direct and downstream) should be made aware of the risks, biases and
|
|
| 70 |
|
| 71 |
## How to Get Started with the Model
|
| 72 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 73 |
```python
|
| 74 |
import torch
|
| 75 |
from vocos import get_voco
|
|
|
|
| 70 |
|
| 71 |
## How to Get Started with the Model
|
| 72 |
|
| 73 |
+
### Installation
|
| 74 |
+
|
| 75 |
+
```bash
|
| 76 |
+
pip install "huggingface-hub[cli]"
|
| 77 |
+
huggingface-cli login # Paste access token w/ read access to this repository.
|
| 78 |
+
# Tokens look like this: hf_*****
|
| 79 |
+
export TEMP_DIR=$(mktemp -d)
|
| 80 |
+
huggingface-cli download optimizerai/vocos --exclude "*.safetensors" --local-dir $TEMP_DIR
|
| 81 |
+
pip install "file://$TEMP_DIR"
|
| 82 |
+
```
|
| 83 |
+
|
| 84 |
+
Or for an automated approach:
|
| 85 |
+
|
| 86 |
+
```bash
|
| 87 |
+
pip install "huggingface-hub[cli]"
|
| 88 |
+
export HF_TOKEN=hf_******
|
| 89 |
+
export TEMP_DIR=$(mktemp -d)
|
| 90 |
+
huggingface-cli download optimizerai/vocos --exclude "*.safetensors" --local-dir $TEMP_DIR
|
| 91 |
+
pip install "file://$TEMP_DIR"
|
| 92 |
+
```
|
| 93 |
+
|
| 94 |
+
If you want to hardcode your token for some reason:
|
| 95 |
+
|
| 96 |
+
```bash
|
| 97 |
+
pip install "huggingface-hub[cli]"
|
| 98 |
+
export TEMP_DIR=$(mktemp -d)
|
| 99 |
+
huggingface-cli download optimizerai/vocos --exclude "*.safetensors" --local-dir $TEMP_DIR --token hf_*****
|
| 100 |
+
pip install "file://$TEMP_DIR"
|
| 101 |
+
```
|
| 102 |
+
|
| 103 |
+
### Example usage
|
| 104 |
+
|
| 105 |
```python
|
| 106 |
import torch
|
| 107 |
from vocos import get_voco
|