Update README.md

README.md

@@ -3,4 +3,105 @@ language:
 - en
 base_model:
 - Writer/Palmyra-X-004
----
+---
+<div align="center">
+  <h1>Palmyra-4-Creative, a powerful LLM designed for creative writing</h1>
+
+</div>
+
+### Model Description
+
+- **Developed by:** Writer
+- **Language(s) (NLP):** English
+- **License:** [Writer open model](https://writer.com/legal/acceptable-use/)
+- **Finetuned from model:** Palmyra-X-004
+- **Context window:** 131,072 tokens
+- **Parameters:** 122 billion
+
+## Model Details
+
+## Model Details
+
+Palmyra-4-Creative, developed by Writer, is a model designed to assist with creative writing and content generation tasks. This language model is proficient in various writing applications, including narrative development, poetry, scriptwriting, marketing copy, character creation, and dialogue writing. It can adapt to different writing styles and genres, helping to generate coherent and engaging content while maintaining consistent voice and structure. Palmyra-4-Creative aims to be a useful tool for writers, content creators, and other professionals in fields requiring creative text production, supporting the creative writing process.
+
+### Resources and Technical Documentation:
+
+
+
+#### Specialized for Creative Applications
+
+
+## Intended Use
+
+
+
+### 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-4-creative"
+
+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 a highly creative and imaginative AI assistant, skilled in various forms of creative writing and ideation.",
+    },
+    {
+        "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, tokenizer.convert_tokens_to_ids("<|eot_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)
+```
+
+### Evaluation Results
+
+
+
+### Citation and Related Information
+
+
+To cite this model:
+```
+@misc{Palmyra-4-Creative-70B,
+  author = {Writer Engineering team},
+  title = {{Palmyra-4-Creative: A powerful LLM designed for creative writing}},
+  howpublished = {\url{https://dev.writer.com}},
+  year = 2024,
+  month = Oct 
+}
+```
+Contact Hello@writer.com
+
+
+