Update README.md

README.md

@@ -1,22 +1,77 @@
 ---
-base_model: unsloth/Phi-3-mini-4k-instruct-v0-bnb-4bit
 language:
-- en
+- it
 license: apache-2.0
+library_name: transformers
 tags:
 - text-generation-inference
-- transformers
 - unsloth
 - mistral
-- gguf
+- trl
+- word-game
+- rebus
+- italian
+- word-puzzle
+- crossword
+datasets:
+- gsarti/eureka-rebus
+base_model: unsloth/Phi-3-mini-4k-instruct-v0-bnb-4bit
+
+model-index:
+- name: gsarti/phi3-mini-rebus-solver-fp16
+  results:
+  - task:
+      type: verbalized-rebus-solving
+      name: Verbalized Rebus Solving
+    dataset:
+      type: gsarti/eureka-rebus
+      name: EurekaRebus
+      config: llm_sft
+      split: test
+      revision: 0f24ebc3b66cd2f8968077a5eb058be1d5af2f05
+    metrics:
+      - type: exact_match
+        value: 0.56
+        name: First Pass Exact Match
+      - type: exact_match
+        value: 0.51
+        name: Solution Exact Match
 ---
 
-# Uploaded  model
+# Phi-3 Mini 4K Verbalized Rebus Solver 🇮🇹
+
+This model is a parameter-efficient fine-tuned version of Phi-3 Mini 4K trained for verbalized rebus solving in Italian, as part of the [release](https://huggingface.co/collections/gsarti/verbalized-rebus-clic-it-2024-66ab8f11cb04e68bdf4fb028) for our paper [Non Verbis, Sed Rebus: Large Language Models are Weak Solvers of Italian Rebuses](TBD). The task of verbalized rebus solving consists of converting an encrypted sequence of letters and crossword definitions into a solution phrase matching the word lengths specified in the solution key. An example is provided below.
+
+The model was trained in 4-bit precision for 5070 steps on the verbalized subset of the [EurekaRebus](https://huggingface.co/datasets/gsarti/eureka-rebus) using QLora via [Unsloth](https://github.com/unslothai/unsloth) and [TRL](https://github.com/huggingface/trl). This repository contains the GGUF exported checkpoint of the model in `Q8_0` format, and the `Modelfile` for usage with [Ollama](https://ollama.com/) (see below).
+
+We also provide [adapter checkpoints through training](https://huggingface.co/gsarti/phi3-mini-rebus-solver-adapters) and [FP16 merged](https://huggingface.co/gsarti/gsarti/phi3-mini-rebus-solver-fp16) versions of this model for analysis and local execution. 
+
+## Local usage with Ollama
+
+A ready-to-use local version of this model is hosted on the [Ollama Hub](https://ollama.com/gsarti/phi3-mini-rebus-solver) and can be used as follows:
+
+```shell
+ollama run gsarti/phi3-mini-rebus-solver "Rebus: [Materiale espulso dai vulcani] R O [Strumento del calzolaio] [Si trovano ai lati del bacino] C I [Si ingrassano con la polenta] E I N [Contiene scorte di cibi] B [Isola in francese]\nChiave risolutiva: 1 ' 5 6 5 3 3 1 14"
+```
+
+## Limitations
+
+**Lexical overfitting**: As remarked in the related publication, the model overfitted the set of definitions/answers for first pass words. As a result, words that were [explicitly witheld](https://huggingface.co/datasets/gsarti/eureka-rebus/blob/main/ood_words.txt) from the training set cause significant performance degradation when used as solutions for verbalized rebuses' definitions. You can compare model performances between [in-domain](https://huggingface.co/datasets/gsarti/eureka-rebus/blob/main/id_test.jsonl) and [out-of-domain](https://huggingface.co/datasets/gsarti/eureka-rebus/blob/main/ood_test.jsonl) test examples to verify this limitation.
+
+## Model curators
+
+For problems or updates on this model, please contact [[email protected]](mailto:[email protected]).
+
+### Citation Information
+
+If you use this model in your work, please cite our paper as follows:
+
+```bibtex
+TBD
+```
 
-- **Developed by:** gsarti
-- **License:** apache-2.0
-- **Finetuned from model :** unsloth/Phi-3-mini-4k-instruct-v0-bnb-4bit
+## Acknowledgements
 
-This mistral model was trained 2x faster with [Unsloth](https://github.com/unslothai/unsloth) and Huggingface's TRL library.
+We are grateful to the [Associazione Culturale "Biblioteca Enigmistica Italiana - G. Panini"](http://www.enignet.it/home) for making its rebus collection freely accessible on the [Eureka5 platform](http://www.eureka5.it).
 
-[<img src="https://raw.githubusercontent.com/unslothai/unsloth/main/images/unsloth%20made%20with%20love.png" width="200"/>](https://github.com/unslothai/unsloth)
+[<img src="https://raw.githubusercontent.com/unslothai/unsloth/main/images/unsloth%20made%20with%20love.png" width="200"/>](https://github.com/unslothai/unsloth)