docs: lead install instructions with the Hub-tracked download path
Browse files
README.md
CHANGED
|
@@ -144,10 +144,15 @@ are all right here in [`batterymhm/`](./batterymhm) — read them, fork them, bu
|
|
| 144 |
### 1. Install
|
| 145 |
|
| 146 |
```bash
|
| 147 |
-
# Option A —
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 148 |
pip install "git+https://huggingface.co/williamTLmiller/batterymhm"
|
| 149 |
|
| 150 |
-
# Option
|
| 151 |
git clone https://huggingface.co/williamTLmiller/batterymhm
|
| 152 |
cd batterymhm
|
| 153 |
pip install -e ".[dev]" # ".[dev]" adds pytest, ruff, and xgboost
|
|
|
|
| 144 |
### 1. Install
|
| 145 |
|
| 146 |
```bash
|
| 147 |
+
# Option A — via the Hub (recommended)
|
| 148 |
+
pip install huggingface_hub
|
| 149 |
+
huggingface-cli download williamTLmiller/batterymhm batterymhm-1.0.0-py3-none-any.whl --local-dir .
|
| 150 |
+
pip install ./batterymhm-1.0.0-py3-none-any.whl
|
| 151 |
+
|
| 152 |
+
# Option B — straight from git
|
| 153 |
pip install "git+https://huggingface.co/williamTLmiller/batterymhm"
|
| 154 |
|
| 155 |
+
# Option C — clone and install editable (recommended for tinkering)
|
| 156 |
git clone https://huggingface.co/williamTLmiller/batterymhm
|
| 157 |
cd batterymhm
|
| 158 |
pip install -e ".[dev]" # ".[dev]" adds pytest, ruff, and xgboost
|