Upload weights, notebooks, sample images

README.md

@@ -17,10 +17,9 @@ tags:
 [![Demo](https://img.shields.io/badge/Demo-HF%20-FFD21E?logo=huggingface&logoColor=FFD21E)](https://huggingface.co/spaces/AlbeRota/UnReflectAnything)
 [![Modelcard](https://img.shields.io/badge/Model%20Card-HF%20-FFD21E?logo=huggingface&logoColor=FFD21E)](https://huggingface.co/AlbeRota/UnReflectAnything)
 [![Wiki](https://img.shields.io/badge/API-Wiki-9187FF?logo=wikipedia&logoColor=9187FF)](https://github.com/alberto-rota/UnReflectAnything/wiki)
-[![Colab](https://img.shields.io/badge/Examples-Colab-F9AB00?logo=googlecolab&logoColor=F9AB00)](https://colab.research.google.com/#fileId=https%3A//huggingface.co/AlbeRota/UnReflectAnything/blob/main/notebooks/UnReflectAnything.ipynb)
 [![Licence](https://img.shields.io/badge/MIT-License-1E811F)](https://mit-license.org/)
 
-UnReflectAnything inputs any RGB image and removes specular highlights, returning a clean diffuse-only output. We trained UnReflectAnything by synthetizing specularities and supervising in DINOv3 feature space.
+UnReflectAnything inputs any RGB image and removes specular highlights, returning a clean diffuse-only outputs. We trained UnReflectAnything by synthetizing specularities and supervising in DINOv3 feature space.
 
 UnReflectAnything works on both natural indoor and surgical/endoscopic domain data. 
 
@@ -70,42 +69,32 @@ to download the `.pth` weights in the package cache dir. The cache dir is usuall
 ### Basic Python Usage
 
 ```python
-import unreflectanything as ura
+import unreflectanything
 import torch
 
-# Load the pretrained model (run 'ura download --weights' first)
-model = ura.model(pretrained=True)
+# Load the pretrained model (uses cached weights)
+unreflect_model = unreflectanything.model() 
 
 # Run inference on a tensor [B, 3, H, W] in range [0, 1]
-images = torch.rand(2, 3, 448, 448, device="cuda")
-diffuse_output = model(images)  # [B, 3, H, W]
+images = torch.rand(2, 3, 448, 448).cuda()
+diffuse_output = unreflect_model(images) 
 
-# File-based inference (one-shot)
-ura.inference("input_with_highlights.png", output="diffuse_result.png")
-# Tensor in, tensor out
-result = ura.inference(images)
-
-# Cache directory (where weights are stored)
-weights_dir = ura.cache("weights")
+# Simple file-based inference
+unreflectanything.inference("input_with_highlights.png", output="diffuse_result.png")
 ```
-Refer to the [Wiki](https://github.com/alberto-rota/UnReflectAnything/wiki) for full API and CLI documentation.
+Refer to the [Wiki](https://github.com/alberto-rota/UnReflectAnything/wiki) for all details on the API endpoints
 
 ---
 
 ### CLI Overview
 
-The package provides a command-line interface via `ura`, `unreflect`, or `unreflectanything`.
+The package provides a comprehensive command-line interface via `ura`, `unreflect`, or `unreflectanything`.
 
-| Subcommand | Description | Example |
-|------------|-------------|---------|
-| `inference` | Run inference on image(s) to remove reflections | `ura inference /path/to/images -o /path/to/output` |
-| `download` | Download weights, sample images, notebooks, configs | `ura download --weights` |
-| `cache` | Print cache directory or clear cached assets | `ura cache --dir` or `ura cache --clear` |
-| `verify` | Verify weights or dataset structure | `ura verify --weights` or `ura verify --dataset --path /path/to/dataset` |
-| `cite` | Print citation (BibTeX, APA, etc.) | `ura cite --bibtex` |
-| `completion` | Print or install shell completion (bash/zsh) | `ura completion bash` |
+* **Inference**: `ura inference --input /path/to/images --output /path/to/output`
+* **Evaluation**: `ura evaluate --output /path/to/results --gt /path/to/groundtruth`
+* **Verification**: `ura verify --dataset /path/to/dataset`
 
-Training, testing, and evaluation are available via the [Python API](https://github.com/alberto-rota/UnReflectAnything/wiki). Refer to the [Wiki](https://github.com/alberto-rota/UnReflectAnything/wiki) for full CLI and API documentation.
+Refer to the [Wiki](https://github.com/alberto-rota/UnReflectAnything/wiki) for all details on the CLI endpoints
 
 ---