File size: 3,199 Bytes
f3d1567
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
214de10
 
f3d1567
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
---
license: mit
library_name: coreml
pipeline_tag: image-feature-extraction
tags:
  - coreml
  - core-ml
  - ios
  - macos
  - apple
  - on-device
  - face-recognition
  - face-embedding
  - metric-learning
  - arxiv:2204.00964
---

# AdaFace IR-18 — Core ML

*CVPR 2022*

Face recognition embeddings. A 112x112 aligned face goes in, a 512-dim L2-normalised embedding comes out; compare two faces with a cosine similarity. AdaFace weights the margin by image quality during training, so low-quality and blurry faces degrade gracefully instead of collapsing together.

iResNet-18 backbone trained on CASIA-WebFace.

<p><img src="https://huggingface.co/mlboydaisuke/AdaFace-IR18-CoreML/resolve/main/media/91831f60be.jpg" alt="AdaFace IR-18 demo"></p>

Core ML conversion of [mk-minchul/AdaFace](https://github.com/mk-minchul/AdaFace) for on-device inference on iPhone, iPad and Mac. Converted with `coremltools`; the packages are stateless, so all sequencing and buffering lives in your Swift code.

| | |
|---|---|
| Task | image feature extraction |
| Upstream | [mk-minchul/AdaFace](https://github.com/mk-minchul/AdaFace) |
| Packages | 1 |
| Download size | 42 MB |
| Minimum iOS | 17.0 |

## Files

| File | Size | Compute units | SHA-256 |
|---|---:|---|---|
| `AdaFace_IR18.mlpackage.zip` | 42 MB | `all` | - |
| **Total** | **42 MB** | | |

`compute_units` is not a suggestion -- it is the configuration the conversion was verified against. Moving a package to a different compute unit can silently change the numerics (FP16 attention overflow) or crash on the GPU.

## Download

```bash
hf download mlboydaisuke/coreml-zoo --include "adaface/*" --local-dir ./adaface
unzip './adaface/adaface/*.zip' -d ./adaface
```

## Use in Swift

```swift
import CoreML

let config = MLModelConfiguration()
config.computeUnits = .all   // as converted — see the table above

// Unzip the .mlpackage, drop it into your Xcode target and Xcode compiles it
// at build time:
let model = try AdaFace_IR18(configuration: config)

// ...or compile a downloaded .mlpackage at runtime:
let compiled = try await MLModel.compileModel(at: mlpackageURL)
let model = try MLModel(contentsOf: compiled, configuration: config)
```

## Demo

- **Sample app** — [`sample_apps/AdaFaceDemo`](https://github.com/john-rocky/CoreML-Models/tree/master/sample_apps/AdaFaceDemo), a standalone SwiftUI project.
- **Models Zoo** — this model is downloadable and runnable inside the [Models Zoo app](https://apps.apple.com/app/id6762083207) on the App Store, no build required.

## Conversion

- Script: [`convert_adaface.py`](https://github.com/john-rocky/CoreML-Models/blob/master/conversion_scripts/convert_adaface.py)
- Pitfalls hit during conversion (FP16 overflow, ANE buffer limits, stride handling): [`docs/coreml_conversion_notes.md`](https://github.com/john-rocky/CoreML-Models/blob/master/docs/coreml_conversion_notes.md)
- Model index: [CoreML-Models](https://github.com/john-rocky/CoreML-Models)

## License

The conversion inherits the upstream license: **MIT**.

## Credits

- Upstream authors: [mk-minchul/AdaFace](https://github.com/mk-minchul/AdaFace), 2022
- Core ML conversion: john-rocky (Daisuke Majima)