IMvision12 commited on
Commit
a4a01aa
·
verified ·
1 Parent(s): 8581ca6

fix readme.md

Browse files
Files changed (1) hide show
  1. README.md +87 -6
README.md CHANGED
@@ -8,20 +8,101 @@ tags:
8
  - kerasformers
9
  - image-classification
10
  - efficientnet
 
 
11
  - pytorch
12
  - jax
13
  - tf
14
  ---
15
 
16
- # tf_efficientnet_b5_in1k
17
 
18
- Pure-Keras 3 image-classification weight for [kerasformers](https://github.com/IMvision12/KerasFormers), converted from [timm/tf_efficientnet_b5.in1k](https://huggingface.co/timm/tf_efficientnet_b5.in1k).
19
 
20
- ## Usage
 
 
 
 
 
 
 
 
 
 
 
 
 
 
21
 
22
  ```python
23
- from kerasformers.models.efficientnet import EfficientNetImageClassify
24
- model = EfficientNetImageClassify.from_weights("tf_efficientnet_b5_in1k")
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
25
  ```
26
 
27
- License: **apache-2.0**, inherited from the upstream source.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
8
  - kerasformers
9
  - image-classification
10
  - efficientnet
11
+ - backbone
12
+ - arxiv:1905.11946
13
  - pytorch
14
  - jax
15
  - tf
16
  ---
17
 
18
+ ## ***See [our collection](https://huggingface.co/collections/kerasformers/efficientnet-6a6d0d5e9b3756eaaca7dbe4) for all versions of EfficientNet.***
19
 
20
+ # Run EfficientNet 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-EfficientNet-blue)](https://imvision12.github.io/KerasFormers/classification_backbones/) [![Collection](https://img.shields.io/badge/HF-EfficientNet%20collection-yellow)](https://huggingface.co/collections/kerasformers/efficientnet-6a6d0d5e9b3756eaaca7dbe4)
23
+
24
+ # kerasformers/tf_efficientnet_b5_in1k
25
+
26
+ Paper: [EfficientNet: Rethinking Model Scaling for Convolutional Neural Networks (arXiv:1905.11946)](https://arxiv.org/abs/1905.11946) · [HF Papers](https://huggingface.co/papers/1905.11946)
27
+
28
+ EfficientNet compound-scales depth/width/resolution for strong accuracy/efficiency. Classifier or multi-scale MBConv backbone.
29
+
30
+ For more details on the model, please go to the upstream [model card](https://huggingface.co/timm/tf_efficientnet_b5.in1k).
31
+
32
+ Pure-**Keras 3** conversion of [`timm/tf_efficientnet_b5.in1k`](https://huggingface.co/timm/tf_efficientnet_b5.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 (`EfficientNetImageClassify` / `EfficientNetModel`).
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.efficientnet import EfficientNetImageClassify, EfficientNetModel
45
+
46
+ model = EfficientNetImageClassify.from_weights("kerasformers/tf_efficientnet_b5_in1k")
47
+ backbone = EfficientNetModel.from_weights(
48
+ "kerasformers/tf_efficientnet_b5_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 EfficientNet variant the same way with `from_weights("kerasformers/<variant>")`:
60
+
61
+ | Variant | Hub |
62
+ |---|---|
63
+ | `tf_efficientnet_b0_aa_in1k` | [`kerasformers/tf_efficientnet_b0_aa_in1k`](https://huggingface.co/kerasformers/tf_efficientnet_b0_aa_in1k) |
64
+ | `tf_efficientnet_b0_ap_in1k` | [`kerasformers/tf_efficientnet_b0_ap_in1k`](https://huggingface.co/kerasformers/tf_efficientnet_b0_ap_in1k) |
65
+ | `tf_efficientnet_b0_in1k` | [`kerasformers/tf_efficientnet_b0_in1k`](https://huggingface.co/kerasformers/tf_efficientnet_b0_in1k) |
66
+ | `tf_efficientnet_b0_ns_jft_in1k` | [`kerasformers/tf_efficientnet_b0_ns_jft_in1k`](https://huggingface.co/kerasformers/tf_efficientnet_b0_ns_jft_in1k) |
67
+ | `tf_efficientnet_b1_aa_in1k` | [`kerasformers/tf_efficientnet_b1_aa_in1k`](https://huggingface.co/kerasformers/tf_efficientnet_b1_aa_in1k) |
68
+ | `tf_efficientnet_b1_ap_in1k` | [`kerasformers/tf_efficientnet_b1_ap_in1k`](https://huggingface.co/kerasformers/tf_efficientnet_b1_ap_in1k) |
69
+ | `tf_efficientnet_b1_in1k` | [`kerasformers/tf_efficientnet_b1_in1k`](https://huggingface.co/kerasformers/tf_efficientnet_b1_in1k) |
70
+ | `tf_efficientnet_b1_ns_jft_in1k` | [`kerasformers/tf_efficientnet_b1_ns_jft_in1k`](https://huggingface.co/kerasformers/tf_efficientnet_b1_ns_jft_in1k) |
71
+ | `tf_efficientnet_b2_aa_in1k` | [`kerasformers/tf_efficientnet_b2_aa_in1k`](https://huggingface.co/kerasformers/tf_efficientnet_b2_aa_in1k) |
72
+ | `tf_efficientnet_b2_ap_in1k` | [`kerasformers/tf_efficientnet_b2_ap_in1k`](https://huggingface.co/kerasformers/tf_efficientnet_b2_ap_in1k) |
73
+ | `tf_efficientnet_b2_in1k` | [`kerasformers/tf_efficientnet_b2_in1k`](https://huggingface.co/kerasformers/tf_efficientnet_b2_in1k) |
74
+ | `tf_efficientnet_b2_ns_jft_in1k` | [`kerasformers/tf_efficientnet_b2_ns_jft_in1k`](https://huggingface.co/kerasformers/tf_efficientnet_b2_ns_jft_in1k) |
75
+ | `tf_efficientnet_b3_aa_in1k` | [`kerasformers/tf_efficientnet_b3_aa_in1k`](https://huggingface.co/kerasformers/tf_efficientnet_b3_aa_in1k) |
76
+ | `tf_efficientnet_b3_ap_in1k` | [`kerasformers/tf_efficientnet_b3_ap_in1k`](https://huggingface.co/kerasformers/tf_efficientnet_b3_ap_in1k) |
77
+ | `tf_efficientnet_b3_in1k` | [`kerasformers/tf_efficientnet_b3_in1k`](https://huggingface.co/kerasformers/tf_efficientnet_b3_in1k) |
78
+ | `tf_efficientnet_b3_ns_jft_in1k` | [`kerasformers/tf_efficientnet_b3_ns_jft_in1k`](https://huggingface.co/kerasformers/tf_efficientnet_b3_ns_jft_in1k) |
79
+ | `tf_efficientnet_b4_aa_in1k` | [`kerasformers/tf_efficientnet_b4_aa_in1k`](https://huggingface.co/kerasformers/tf_efficientnet_b4_aa_in1k) |
80
+ | `tf_efficientnet_b4_ap_in1k` | [`kerasformers/tf_efficientnet_b4_ap_in1k`](https://huggingface.co/kerasformers/tf_efficientnet_b4_ap_in1k) |
81
+ | `tf_efficientnet_b4_in1k` | [`kerasformers/tf_efficientnet_b4_in1k`](https://huggingface.co/kerasformers/tf_efficientnet_b4_in1k) |
82
+ | `tf_efficientnet_b4_ns_jft_in1k` | [`kerasformers/tf_efficientnet_b4_ns_jft_in1k`](https://huggingface.co/kerasformers/tf_efficientnet_b4_ns_jft_in1k) |
83
+ | `tf_efficientnet_b5_aa_in1k` | [`kerasformers/tf_efficientnet_b5_aa_in1k`](https://huggingface.co/kerasformers/tf_efficientnet_b5_aa_in1k) |
84
+ | `tf_efficientnet_b5_ap_in1k` | [`kerasformers/tf_efficientnet_b5_ap_in1k`](https://huggingface.co/kerasformers/tf_efficientnet_b5_ap_in1k) |
85
+ | `tf_efficientnet_b5_in1k` | [`kerasformers/tf_efficientnet_b5_in1k`](https://huggingface.co/kerasformers/tf_efficientnet_b5_in1k) |
86
+ | `tf_efficientnet_b5_ns_jft_in1k` | [`kerasformers/tf_efficientnet_b5_ns_jft_in1k`](https://huggingface.co/kerasformers/tf_efficientnet_b5_ns_jft_in1k) |
87
+ | `tf_efficientnet_b6_aa_in1k` | [`kerasformers/tf_efficientnet_b6_aa_in1k`](https://huggingface.co/kerasformers/tf_efficientnet_b6_aa_in1k) |
88
+ | `tf_efficientnet_b6_ap_in1k` | [`kerasformers/tf_efficientnet_b6_ap_in1k`](https://huggingface.co/kerasformers/tf_efficientnet_b6_ap_in1k) |
89
+ | `tf_efficientnet_b6_ns_jft_in1k` | [`kerasformers/tf_efficientnet_b6_ns_jft_in1k`](https://huggingface.co/kerasformers/tf_efficientnet_b6_ns_jft_in1k) |
90
+ | `tf_efficientnet_b7_aa_in1k` | [`kerasformers/tf_efficientnet_b7_aa_in1k`](https://huggingface.co/kerasformers/tf_efficientnet_b7_aa_in1k) |
91
+ | `tf_efficientnet_b7_ap_in1k` | [`kerasformers/tf_efficientnet_b7_ap_in1k`](https://huggingface.co/kerasformers/tf_efficientnet_b7_ap_in1k) |
92
+ | `tf_efficientnet_b7_ns_jft_in1k` | [`kerasformers/tf_efficientnet_b7_ns_jft_in1k`](https://huggingface.co/kerasformers/tf_efficientnet_b7_ns_jft_in1k) |
93
+ | `tf_efficientnet_b8_ap_in1k` | [`kerasformers/tf_efficientnet_b8_ap_in1k`](https://huggingface.co/kerasformers/tf_efficientnet_b8_ap_in1k) |
94
+ | `tf_efficientnet_l2_ns_jft_in1k` | [`kerasformers/tf_efficientnet_l2_ns_jft_in1k`](https://huggingface.co/kerasformers/tf_efficientnet_l2_ns_jft_in1k) |
95
+ | `tf_efficientnet_l2_ns_jft_in1k_475` | [`kerasformers/tf_efficientnet_l2_ns_jft_in1k_475`](https://huggingface.co/kerasformers/tf_efficientnet_l2_ns_jft_in1k_475) |
96
+
97
+ ## Tips
98
+
99
+ - Set `KERAS_BACKEND` **before** importing Keras / kerasformers.
100
+ - `EfficientNetImageClassify` returns class logits; `EfficientNetModel` returns features (`as_backbone=True` for multi-scale stages).
101
+ - See [docs](https://imvision12.github.io/KerasFormers/classification_backbones/) and [Loading Weights](https://imvision12.github.io/KerasFormers/loading_weights/).
102
+ - Upstream / timm checkpoints: `EfficientNetImageClassify.from_weights("hf:timm/tf_efficientnet_b5.in1k")`.
103
+
104
+ ## Special Thanks
105
+
106
+ A huge thank you to the EfficientNet authors and the timm / Hub communities for creating and releasing these models.
107
+
108
+ License: see YAML `license` (usually matches the upstream checkpoint).