Update README.md

README.md

@@ -1,8 +1,62 @@
 ---
 base_model: google/functiongemma-270m-it
+library_name: transformers
+model_name: funcgemma-mobile-actions
 tags:
-- function-calling
-- mobile-actions
-- gemma
+- generated_from_trainer
+- sft
+- trl
+licence: license
 ---
-A fine-tuned model based on `google/functiongemma-270m-it`.
+
+# Model Card for funcgemma-mobile-actions
+
+This model is a fine-tuned version of [google/functiongemma-270m-it](https://huggingface.co/google/functiongemma-270m-it). It has been trained using [TRL](https://github.com/huggingface/trl).
+
+Training was done fully local on a PC with a 32GB Nvidia RTX Pro 4500 GPU (comparable to an RTX 5080) and took roughly 25 mins.  
+The script was derived from the [Google Colab example](https://github.com/google-gemini/gemma-cookbook/tree/main/FunctionGemma) and is available at [ai-bits.org's FunctionGemma repo](https://github.com/ai-bits/functiongemma).
+
+For the time being the litertlm model conversion for edge use (Andoid,..) will be available in a subdirectory here.
+
+## Quick start
+
+```python
+from transformers import pipeline
+
+question = "If you had a time machine, but could only go to the past or the future once and never return, which would you choose and why?"
+generator = pipeline("text-generation", model="None", device="cuda")
+output = generator([{"role": "user", "content": question}], max_new_tokens=128, return_full_text=False)[0]
+print(output["generated_text"])
+```
+
+## Training procedure
+
+ 
+
+
+This model was trained with SFT.
+
+### Framework versions
+
+- TRL: 0.25.1
+- Transformers: 4.57.1
+- Pytorch: 2.9.1
+- Datasets: 4.4.1
+- Tokenizers: 0.22.1
+
+## Citations
+
+
+
+Cite TRL as:
+    
+```bibtex
+@misc{vonwerra2022trl,
+	title        = {{TRL: Transformer Reinforcement Learning}},
+	author       = {Leandro von Werra and Younes Belkada and Lewis Tunstall and Edward Beeching and Tristan Thrush and Nathan Lambert and Shengyi Huang and Kashif Rasul and Quentin Gallou{\'e}dec},
+	year         = 2020,
+	journal      = {GitHub repository},
+	publisher    = {GitHub},
+	howpublished = {\url{https://github.com/huggingface/trl}}
+}
+```