Update README.md

README.md

@@ -12,12 +12,73 @@ datasets:
 - Nitral-AI/Creative_Writing-ShareGPT
 ---
 
-# Uploaded finetuned  model
+# Halcyon-1B
 
-- **Developed by:** colesmcintosh
-- **License:** apache-2.0
-- **Finetuned from model :** unsloth/gemma-3-1b-it-unsloth-bnb-4bit
+**Halcyon-1B** is a creatively fine-tuned variant of the **unsloth/gemma-3-1b-it-unsloth-bnb-4bit** model, specifically tailored for imaginative and expressive creative writing tasks. This model has been fine-tuned to excel in storytelling, literary exploration, and nuanced narrative construction.
 
-This gemma3_text model was trained 2x faster with [Unsloth](https://github.com/unslothai/unsloth) and Huggingface's TRL library.
+---
+
+## Model Details
+
+- **Developed by:** [colesmcintosh](https://huggingface.co/colesmcintosh)
+- **Base Model:** [unsloth/gemma-3-1b-it-unsloth-bnb-4bit](https://huggingface.co/unsloth/gemma-3-1b-it-unsloth-bnb-4bit)
+- **Fine-tuning Methodology:** Trained 2x faster leveraging [Unsloth](https://github.com/unslothai/unsloth) and Huggingface's TRL library.
+
+---
+
+## Dataset
+
+This model was fine-tuned using the [(Nitral-AI) Creative Writing ShareGPT](https://huggingface.co/datasets/Nitral-AI/Creative_Writing-ShareGPT) dataset.
+
+---
+
+## Capabilities
+
+- **Creative Writing:** Exceptional at generating narratives, stories, poetry, and prose.
+- **Expressive Nuance:** Generates sophisticated, context-aware, and evocative literary outputs.
+- **Versatility:** Suitable for writers, creators, educators, and storytellers looking to harness AI for enhanced creative exploration.
+
+---
+
+## Intended Use
+
+- **Creative Inspiration:** Idea generation, overcoming writer’s block, and expanding narrative horizons.
+- **Educational Tools:** Supporting literature courses, workshops, and creative writing sessions.
+- **Interactive Storytelling:** Enabling interactive fiction, dynamic content creation, and innovative narrative formats.
+
+---
+
+## Usage
+
+You can quickly test Halcyon-1B using Huggingface Transformers:
+
+```python
+from unsloth import FastModel
+from transformers import TextStreamer
+
+# Load model and tokenizer
+model, tokenizer = FastModel.from_pretrained(
+    model_name = "colesmcintosh/Halcyon-1B",
+    max_seq_length = 2048,
+    load_in_4bit = True,
+)
+
+# Format prompt using Gemma-3 chat template
+messages = [{
+    "role": "user",
+    "content": [{"type" : "text", "text" : "Write a mythological tale about how the oceans came to be."}]
+}]
+
+text_ids = tokenizer.apply_chat_template(messages, add_generation_prompt=True)
+text_str = tokenizer.decode(text_ids)
 
-[<img src="https://raw.githubusercontent.com/unslothai/unsloth/main/images/unsloth%20made%20with%20love.png" width="200"/>](https://github.com/unslothai/unsloth)
+# Generate response
+outputs = model.generate(
+    **tokenizer([text_str], return_tensors="pt").to("cuda"),
+    max_new_tokens=64,
+    temperature=1.0,
+    top_p=0.95,
+    top_k=64,
+    streamer=TextStreamer(tokenizer, skip_prompt=True),
+)
+```