Upload README.md with huggingface_hub

README.md

@@ -20,12 +20,12 @@ EdgeFace replaces the classifier of an `edgenext` (timm) backbone with a 512-d e
 
 ## Model variants
 
-| Subfolder | Backbone | Low-rank ratio | Params |
-|---|---|---|---|
-| `edgeface-base` | `edgenext_base` | — | ~18 M |
-| `edgeface-s-gamma-05` | `edgenext_small` | 0.5 | ~5 M |
-| `edgeface-xs-gamma-06` | `edgenext_x_small` | 0.6 | ~3 M |
-| `edgeface-xxs` | `edgenext_xx_small` | — | ~1 M |
+| Subfolder | Backbone | Low-rank ratio | Params | |
+|---|---|---|---|---|
+| `edgeface-base` | `edgenext_base` | — | ~18 M | **default** |
+| `edgeface-s-gamma-05` | `edgenext_small` | 0.5 | ~5 M | |
+| `edgeface-xs-gamma-06` | `edgenext_x_small` | 0.6 | ~3 M | |
+| `edgeface-xxs` | `edgenext_xx_small` | — | ~1 M | |
 
 ## Installation
 
@@ -38,6 +38,16 @@ pip install mediapipe opencv-python
 
 ## Quick start
 
+### Pipeline (default — edgeface-xxs)
+
+```python
+from transformers import pipeline
+
+pipe = pipeline("image-feature-extraction", model="anjith2006/edgeface", trust_remote_code=True)
+```
+
+### AutoModel (any variant)
+
 ```python
 import torch
 import torch.nn.functional as F
@@ -136,6 +146,15 @@ model = get_peft_model(model, lora_cfg)
 model.print_trainable_parameters()
 ```
 
+## Source files
+
+| File | Purpose |
+|---|---|
+| `configuration_edgeface.py` | `EdgeFaceConfig` |
+| `modeling_edgeface.py` | `EdgeFaceModel`, `LowRankLinear`, `EdgeFaceOutput` |
+| `image_processing_edgeface.py` | `EdgeFaceImageProcessor` (MediaPipe alignment + normalize) |
+| `convert_edgeface.py` | Download original `.pt` checkpoints, convert, push |
+| `example.py` | Same-person / different-person sanity check |
 
 ## License