Add model card (README)
Browse files
README.md
ADDED
|
@@ -0,0 +1,62 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
license: mit
|
| 3 |
+
tags:
|
| 4 |
+
- image-to-image
|
| 5 |
+
- reflection-removal
|
| 6 |
+
- highlight-removal
|
| 7 |
+
- computer-vision
|
| 8 |
+
---
|
| 9 |
+
|
| 10 |
+
# UnReflectAnything – Pretrained Weights
|
| 11 |
+
|
| 12 |
+
Pretrained weights for **UnReflectAnything**: *RGB-Only Highlight Removal by Rendering Synthetic Specular Supervision*.
|
| 13 |
+
|
| 14 |
+
- **Project**: [alberto-rota.github.io/UnReflectAnything](https://alberto-rota.github.io/UnReflectAnything/)
|
| 15 |
+
- **Paper**: [arXiv](https://arxiv.org/abs/2501.12345)
|
| 16 |
+
- **PyPI**: `pip install unreflectanything`
|
| 17 |
+
- **Demo**: [Hugging Face Space](https://huggingface.co/spaces/AlbeRota/UnReflectAnything)
|
| 18 |
+
|
| 19 |
+
## Model description
|
| 20 |
+
|
| 21 |
+
These weights support the `unreflectanything` package for removing specular highlights and reflections from RGB images without polarization or multi-view input.
|
| 22 |
+
|
| 23 |
+
| File | Description |
|
| 24 |
+
|------|-------------|
|
| 25 |
+
| `fullmodel_896.pt` | Full model checkpoint (recommended for inference) |
|
| 26 |
+
| `decoder_896.pth` | Decoder weights (896px; e.g. for pretraining) |
|
| 27 |
+
| `rgb_decoder.pth` | RGB decoder weights |
|
| 28 |
+
| `rgb_film_decoder.pth` | RGB FiLM decoder weights |
|
| 29 |
+
| `token_inpainter.pth` | Token inpainter module weights |
|
| 30 |
+
|
| 31 |
+
## How to use
|
| 32 |
+
|
| 33 |
+
1. **Install the package** (with optional weight-download support):
|
| 34 |
+
|
| 35 |
+
```bash
|
| 36 |
+
pip install unreflectanything[weights]
|
| 37 |
+
```
|
| 38 |
+
|
| 39 |
+
2. **Download these weights** into the default cache:
|
| 40 |
+
|
| 41 |
+
```bash
|
| 42 |
+
unreflectanything download-weights
|
| 43 |
+
```
|
| 44 |
+
|
| 45 |
+
By default the CLI uses the official weights repo. To use this Hugging Face repo instead, set:
|
| 46 |
+
|
| 47 |
+
```bash
|
| 48 |
+
export UNREFLECTANYTHING_WEIGHTS_REPO="<your-username>/<this-repo-name>"
|
| 49 |
+
unreflectanything download-weights
|
| 50 |
+
```
|
| 51 |
+
|
| 52 |
+
Weights are stored under `~/.cache/unreflectanything/weights` (or `$XDG_CACHE_HOME/unreflectanything/weights`). Use `--output-dir` to override.
|
| 53 |
+
|
| 54 |
+
3. **Run inference** with a YAML config that points `weights_path` to the downloaded directory (e.g. to `fullmodel_896.pt` for full-model inference).
|
| 55 |
+
|
| 56 |
+
## Citation
|
| 57 |
+
|
| 58 |
+
If you use these weights or the method, please cite the paper and/or link to this repository.
|
| 59 |
+
|
| 60 |
+
## License
|
| 61 |
+
|
| 62 |
+
MIT.
|