IMvision12 commited on
Commit
4dc398e
·
verified ·
1 Parent(s): 894e0d4

fix readme.md

Browse files
Files changed (1) hide show
  1. README.md +59 -8
README.md CHANGED
@@ -8,20 +8,71 @@ tags:
8
  - kerasformers
9
  - image-classification
10
  - efficientformer
11
- - tf
12
- - jax
13
  - pytorch
 
 
14
  ---
15
 
16
- # efficientformer_l7_snap_dist_in1k
 
 
 
 
 
 
 
 
 
 
 
 
17
 
18
- Pure-Keras 3 image-classification weight for [kerasformers](https://github.com/IMvision12/KerasFormers), converted from [timm/efficientformer_l7.snap_dist_in1k](https://huggingface.co/timm/efficientformer_l7.snap_dist_in1k).
19
 
20
- ## Usage
 
 
21
 
22
  ```python
23
- from kerasformers.models.efficientformer import EfficientFormerImageClassify
24
- model = EfficientFormerImageClassify.from_weights("efficientformer_l7_snap_dist_in1k")
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
25
  ```
26
 
27
- License: **apache-2.0**, inherited from the upstream source.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
8
  - kerasformers
9
  - image-classification
10
  - efficientformer
11
+ - backbone
12
+ - arxiv:2206.01191
13
  - pytorch
14
+ - jax
15
+ - tf
16
  ---
17
 
18
+ ## ***See [our collection](https://huggingface.co/collections/kerasformers/efficientformer-6a6bd5f104d6390a09821746) for all versions of EfficientFormer.***
19
+
20
+ # Run EfficientFormer with Keras 3: JAX, PyTorch, or TensorFlow
21
+
22
+ [![GitHub](https://img.shields.io/badge/GitHub-KerasFormers-black?logo=github)](https://github.com/IMvision12/KerasFormers) [![Docs](https://img.shields.io/badge/Docs-EfficientFormer-blue)](https://imvision12.github.io/KerasFormers/classification_backbones/) [![Collection](https://img.shields.io/badge/HF-EfficientFormer%20collection-yellow)](https://huggingface.co/collections/kerasformers/efficientformer-6a6bd5f104d6390a09821746)
23
+
24
+ # kerasformers/efficientformer_l7_snap_dist_in1k
25
+
26
+ Paper: [EfficientFormer: Vision Transformers at MobileNet Speed (arXiv:2206.01191)](https://arxiv.org/abs/2206.01191) · [HF Papers](https://huggingface.co/papers/2206.01191)
27
+
28
+ EfficientFormer redesigns transformers for MobileNet-level latency on mobile devices. Classifier or 4-stage backbone.
29
+
30
+ For more details on the model, please go to the upstream [model card](https://huggingface.co/timm/efficientformer_l7.snap_dist_in1k).
31
 
32
+ Pure-**Keras 3** conversion of [`timm/efficientformer_l7.snap_dist_in1k`](https://huggingface.co/timm/efficientformer_l7.snap_dist_in1k) for [kerasformers](https://github.com/IMvision12/KerasFormers). One implementation runs unmodified on **TensorFlow / Torch / JAX**.
33
 
34
+ This is an **image-classification / backbone** checkpoint (`EfficientFormerImageClassify` / `EfficientFormerModel`).
35
+
36
+ ## ✨ Quick start
37
 
38
  ```python
39
+ import os
40
+ os.environ["KERAS_BACKEND"] = "torch" # or "jax" / "tensorflow"
41
+
42
+ from PIL import Image
43
+ import numpy as np
44
+ from kerasformers.models.efficientformer import EfficientFormerImageClassify, EfficientFormerModel
45
+
46
+ model = EfficientFormerImageClassify.from_weights("kerasformers/efficientformer_l7_snap_dist_in1k")
47
+ backbone = EfficientFormerModel.from_weights(
48
+ "kerasformers/efficientformer_l7_snap_dist_in1k", as_backbone=True
49
+ )
50
+
51
+ image = Image.open("your_image.jpg").convert("RGB")
52
+ image = image.resize((224, 224))
53
+ x = np.asarray(image, dtype="float32")[None] # (1, H, W, 3)
54
+ print(model(x).shape) # (1, num_classes)
55
+ feats = backbone(x)
56
+ print(len(feats), [tuple(f.shape) for f in feats])
57
  ```
58
 
59
+ Load any EfficientFormer variant the same way with `from_weights("kerasformers/<variant>")`:
60
+
61
+ | Variant | Hub |
62
+ |---|---|
63
+ | `efficientformer_l1_snap_dist_in1k` | [`kerasformers/efficientformer_l1_snap_dist_in1k`](https://huggingface.co/kerasformers/efficientformer_l1_snap_dist_in1k) |
64
+ | `efficientformer_l3_snap_dist_in1k` | [`kerasformers/efficientformer_l3_snap_dist_in1k`](https://huggingface.co/kerasformers/efficientformer_l3_snap_dist_in1k) |
65
+ | `efficientformer_l7_snap_dist_in1k` | [`kerasformers/efficientformer_l7_snap_dist_in1k`](https://huggingface.co/kerasformers/efficientformer_l7_snap_dist_in1k) |
66
+
67
+ ## Tips
68
+
69
+ - Set `KERAS_BACKEND` **before** importing Keras / kerasformers.
70
+ - `EfficientFormerImageClassify` returns class logits; `EfficientFormerModel` returns features (`as_backbone=True` for multi-scale stages).
71
+ - See [docs](https://imvision12.github.io/KerasFormers/classification_backbones/) and [Loading Weights](https://imvision12.github.io/KerasFormers/loading_weights/).
72
+ - Upstream / timm checkpoints: `EfficientFormerImageClassify.from_weights("hf:timm/efficientformer_l7.snap_dist_in1k")`.
73
+
74
+ ## Special Thanks
75
+
76
+ A huge thank you to the EfficientFormer authors and the timm / Hub communities for creating and releasing these models.
77
+
78
+ License: see YAML `license` (usually matches the upstream checkpoint).