readme: mention disabling of inference widget

#2
by stefan-it - opened
Files changed (1) hide show
  1. README.md +13 -0
README.md CHANGED
@@ -6,6 +6,7 @@ tags:
6
  - token-classification
7
  - sequence-tagger-model
8
  base_model: hmbyt5-preliminary/byt5-small-historic-multilingual-span20-flax
 
9
  widget:
10
  - text: — Dramatiſch war der Stoff vor Sophokles von Äſchylos behandelt worden in
11
  den Θροῇσσαι , denen vielleicht in der Trilogie das Stüc>"OnJw» κοίσις vorherging
@@ -24,6 +25,18 @@ project.
24
 
25
  The following NEs were annotated: `pers`, `work`, `loc`, `object`, `date` and `scope`.
26
 
 
 
 
 
 
 
 
 
 
 
 
 
27
  # Results
28
 
29
  We performed a hyper-parameter search over the following parameters with 5 different seeds per configuration:
 
6
  - token-classification
7
  - sequence-tagger-model
8
  base_model: hmbyt5-preliminary/byt5-small-historic-multilingual-span20-flax
9
+ inference: false
10
  widget:
11
  - text: — Dramatiſch war der Stoff vor Sophokles von Äſchylos behandelt worden in
12
  den Θροῇσσαι , denen vielleicht in der Trilogie das Stüc>"OnJw» κοίσις vorherging
 
25
 
26
  The following NEs were annotated: `pers`, `work`, `loc`, `object`, `date` and `scope`.
27
 
28
+ # ⚠️ Inference Widget ⚠️
29
+
30
+ Fine-Tuning ByT5 models in Flair is currently done by implementing an own [`ByT5Embedding`][1] class.
31
+
32
+ This class needs to be present when running the model with Flair.
33
+
34
+ Thus, the inference widget is not working with hmByT5 at the moment on the Model Hub and is currently disabled.
35
+
36
+ This should be fixed in future, when ByT5 fine-tuning is supported in Flair directly.
37
+
38
+ [1]: https://github.com/stefan-it/hmBench/blob/main/byt5_embeddings.py
39
+
40
  # Results
41
 
42
  We performed a hyper-parameter search over the following parameters with 5 different seeds per configuration: