Model card: add Usage section
Browse files
README.md
CHANGED
|
@@ -24,6 +24,19 @@ No learned parameters were modified. The only change is state-dict key
|
|
| 24 |
remapping so that upstream checkpoints load into LibreYOLO's module
|
| 25 |
naming scheme.
|
| 26 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 27 |
## License
|
| 28 |
|
| 29 |
Apache License 2.0. See the [`LICENSE`](./LICENSE) and [`NOTICE`](./NOTICE)
|
|
|
|
| 24 |
remapping so that upstream checkpoints load into LibreYOLO's module
|
| 25 |
naming scheme.
|
| 26 |
|
| 27 |
+
## Usage
|
| 28 |
+
|
| 29 |
+
```bash
|
| 30 |
+
pip install libreyolo
|
| 31 |
+
```
|
| 32 |
+
|
| 33 |
+
```python
|
| 34 |
+
from libreyolo import LibreYOLO
|
| 35 |
+
|
| 36 |
+
model = LibreYOLO("LibreYOLOXn.pt")
|
| 37 |
+
results = model("image.jpg", save=True)
|
| 38 |
+
```
|
| 39 |
+
|
| 40 |
## License
|
| 41 |
|
| 42 |
Apache License 2.0. See the [`LICENSE`](./LICENSE) and [`NOTICE`](./NOTICE)
|