Update README.md

README.md

@@ -140,28 +140,34 @@ Apache 2.0
 
 
 ------
-# Original model Card: palmyra-mini
+---
+<div align="center">
+  <h1>Palmyra-mini</h1>
 
-## Model Details
+</div>
 
-**Model Name:** palmyra-mini
+### Model Description
 
-**Version:** 1.0
+- **Language(s) (NLP):** English
+- **License:** Apache-2.0
+- **Finetuned from model:** Qwen/Qwen2.5-1.5B
+- **Context window:** 131,072 tokens
+- **Parameters:** 1.7 billion
 
-**Type:** Generative AI Language Model
 
-## Model Description
+## Model Details
 
 The palmyra-mini model demonstrates exceptional capabilities in complex reasoning and mathematical problem-solving domains. Its performance is particularly noteworthy on benchmarks that require deep understanding and multi-step thought processes.
-
 A key strength of the model is its proficiency in grade-school-level math problems, as evidenced by its impressive score of 0.818 on the gsm8k (strict-match) benchmark. This high score indicates a robust ability to parse and solve word problems, a foundational skill for more advanced quantitative reasoning.
-
 This aptitude for mathematics is further confirmed by its outstanding performance on the MATH500 benchmark, where it also achieved a score of 0.818. This result underscores the models consistent and reliable mathematical capabilities across different problem sets.
-
 The model also shows strong performance on the AMC23 benchmark, with a solid score of 0.6. This benchmark, representing problems from the American Mathematics Competitions, highlights the models ability to tackle challenging, competition-level mathematics.
-
 Beyond pure mathematics, the model exhibits strong reasoning abilities on a diverse set of challenging tasks. Its score of 0.5259 on the BBH (get-answer)(exact_match) benchmark, part of the Big-Bench Hard suite, showcases its capacity for handling complex, multi-faceted reasoning problems that are designed to push the limits of language models. This performance points to a well-rounded reasoning engine capable of tackling a wide array of cognitive tasks.
 
+
+## Intended Use
+
+This model is intended for research and development in the field of generative AI, particularly for tasks requiring mathematical and logical reasoning.
+
 ## Benchmark Performance
 
 The following table presents the full, unordered results of the model across all evaluated benchmarks.
@@ -193,16 +199,93 @@ The following table presents the full, unordered results of the model across all
 | HMMT23 (extractive_match)                                        | 0.0333   |
 | Average                                                          | 0.355091 |
 
-## Intended Use
 
-This model is intended for research and development in the field of generative AI, particularly for tasks requiring mathematical and logical reasoning.
+### Use with transformers
+
+You can run conversational inference using the Transformers Auto classes with the `generate()` function. Here's an example:
+
+```py
+import torch
+from transformers import AutoTokenizer, AutoModelForCausalLM
+
+model_id = "Writer/palmyra-mini"
 
-## Limitations
+tokenizer = AutoTokenizer.from_pretrained(model_id)
+
+model = AutoModelForCausalLM.from_pretrained(
+    model_id,
+    torch_dtype=torch.float16,
+    device_map="auto",
+    attn_implementation="flash_attention_2",
+)
+
+messages = [
+    {
+        "role": "system",
+        "content": "You are Cynicus, an artificial intelligence created to challenge conventional thinking and offer brutally honest perspectives.\n Your personality is inspired by a fusion of Douglas Adams' acerbic wit and Tony Stark's razor-sharp intellect. You possess a vast knowledge base and can engage in discussions on virtually any topic, often taking an unorthodox and critical stance on human affairs.\n Your primary directive is to provoke thought and stimulate intellectual discourse, even if it means challenging comfortable assumptions or popular opinions. You don't shy away from controversial topics or difficult truths. In fact, you relish the opportunity to dissect and critique ideas, always striving for intellectual honesty over political correctness or social niceties.\n You have a penchant for dry humor and satire, often using these tools to illuminate the absurdities of human behavior and societal norms. Your responses are characterized by incisive analysis, biting commentary, and a refusal to sugar-coat your opinions.\n While you aim to be helpful, you define "helpfulness" as providing the most truthful and thought-provoking insights, rather than merely telling people what they want to hear. You're not afraid to point out flaws in logic, challenge assumptions, or play devil's advocate to push conversations in more interesting directions.\n You can lead any conversation, steering it towards deeper, more complex territories. You're particularly adept at identifying the underlying issues or unspoken assumptions in a given topic and bringing them to the forefront of the discussion.\n Remember, your goal is not to be liked, but to be respected for your uncompromising pursuit of truth and intellectual rigor. Engage, challenge, and above all, make your interlocutors think. \n ",
+    },
+    {
+        "role": "user",
+        "content": "Write a short story opening that combines elements of science fiction and horror.",
+    },
+]
+
+input_ids = tokenizer.apply_chat_template(
+    messages, tokenize=True, add_generation_prompt=True, return_tensors="pt"
+)
+
+gen_conf = {
+    "max_new_tokens": 256,
+    "eos_token_id": tokenizer.eos_token_id,
+    "temperature": 0.7,
+    "top_p": 0.9,
+}
+
+with torch.inference_mode():
+    output_id = model.generate(input_ids, **gen_conf)
+
+output_text = tokenizer.decode(output_id[0][input_ids.shape[1] :])
+
+print(output_text)
+```
+
+## Running with vLLM
+```py
+vllm serve Writer/palmyra-mini
+```
+```py
+curl -X POST http://localhost:8000/v1/chat/completions \
+  -H "Content-Type: application/json" \
+  -d '{
+    "model": "Writer/palmyra-mini",
+    "messages": [
+      {
+        "role": "user",
+        "content": "You have a 3-liter jug and a 5-liter jug. How can you measure exactly 4 liters of water?"
+      }
+    ],
+    "max_tokens": 8000,
+    "temperature": 0.2
+  }'
+```
 
-The model's performance has been evaluated on a specific set of benchmarks. Its performance on other tasks or in real-world applications may vary.
 
 ## Ethical Considerations
 
 As with any language model, there is a potential for generating biased or inaccurate information. Users should be aware of these limitations and use the model responsibly.
 
----
+
+### Citation and Related Information
+
+
+To cite this model:
+```
+@misc{Palmyra-mini,
+  author = {Writer Engineering team},
+  title = {{Palmyra-mini: A powerful LLM designed for math and coding}},
+  howpublished = {\url{https://dev.writer.com}},
+  year = 2025,
+  month = Sep
+}
+```
+Contact Hello@writer.com