Merge pull request #336 from urchade/restructuring

Restructure the repo / update documentation

Author: Ingvarstep

bench/bench_gliner_e2e.py benchmarks/bench_gliner_e2e.pybench/bench_gliner_e2e.py renamed to benchmarks/bench_gliner_e2e.py

@@ -86,10 +86,26 @@ To use `FlashDeBERTa` with GLiNER, install it:
 pip install flashdeberta -U
 ```
 :::tip
-Before using FlashDeBERTa, please make sure that you have `transformers>=4.47.0`.
+Before using FlashDeBERTa, please make sure that you have `transformers>=4.51.3`.
 :::
 
-GLiNER will automatically detect and use `FlashDeBERTa`. If needed, you can switch to the standard `eager` attention mechanism by specifying the attention implementation:
+To enable FlashDeBERTa, set the `USE_FLASHDEBERTA` environment variable before loading the model:
+
+```bash
+export USE_FLASHDEBERTA=1
+```
+
+Or set it directly in Python:
+
+```python
+import os
+os.environ["USE_FLASHDEBERTA"] = "1"
+
+from gliner import GLiNER
+model = GLiNER.from_pretrained("urchade/gliner_mediumv2.1")
+```
+
+If needed, you can switch to the standard `eager` attention mechanism by specifying the attention implementation:
 
 ```python
 model = GLiNER.from_pretrained("urchade/gliner_mediumv2.1", _attn_implementation="eager")

bench/bench_infer_packing.py benchmarks/bench_infer_packing.pybench/bench_infer_packing.py renamed to benchmarks/bench_infer_packing.py

@@ -484,20 +484,29 @@ pip install flashdeberta -U
 ```
 
 :::tip
-Before using FlashDeBERTa, please make sure that you have `transformers>=4.47.0`.
+Before using FlashDeBERTa, please make sure that you have `transformers>=4.51.3`.
 :::
 
 ### Usage
 
-GLiNER will automatically detect and use FlashDeBERTa. If needed, you can switch to the standard `eager` attention mechanism:
+To enable FlashDeBERTa, set the `USE_FLASHDEBERTA` environment variable before loading the model:
+
+```bash
+export USE_FLASHDEBERTA=1
+```
+
+Or set it directly in Python:
 
 ```python
+import os
+os.environ["USE_FLASHDEBERTA"] = "1"
+
 from gliner import GLiNER
 
-# Use FlashDeBERTa (automatic if installed)
+# FlashDeBERTa will be used when USE_FLASHDEBERTA is set and the package is installed
 model = GLiNER.from_pretrained("urchade/gliner_medium-v2.1")
 
-# Or explicitly use eager attention
+# To explicitly use eager attention instead
 model = GLiNER.from_pretrained(
     "urchade/gliner_medium-v2.1",
     _attn_implementation="eager"