Update README.md

README.md

@@ -1,3 +1,91 @@
----
-license: llama3.1
----
+---
+license: llama3.1
+---
+
+## Description
+This repo contains GGUF format model files for Llama-3.1-8B-ArliAI-Formax-v1.0.
+
+## Files Provided
+|                     Name                  | Quant | Bits | File Size |              Remark              |
+| ----------------------------------------- | ----- | ---- | --------- | -------------------------------- |
+| llama-3.1-8b-arliai-formax-v1.0.Q2_K.gguf | Q2_K  |  2   |  3.18 GB  | 2.96G, +3.5199 ppl @ Llama-3-8B  |
+| llama-3.1-8b-arliai-formax-v1.0.Q3_K.gguf | Q3_K  |  3   |  4.02 GB  | 3.74G, +0.6569 ppl @ Llama-3-8B  |
+| llama-3.1-8b-arliai-formax-v1.0.Q4_0.gguf | Q4_0  |  4   |  4.66 GB  | 4.34G, +0.4685 ppl @ Llama-3-8B  |
+| llama-3.1-8b-arliai-formax-v1.0.Q4_K.gguf | Q4_K  |  4   |  4.92 GB  | 4.58G, +0.1754 ppl @ Llama-3-8B  |
+| llama-3.1-8b-arliai-formax-v1.0.Q5_K.gguf | Q5_K  |  5   |  5.73 GB  | 5.33G, +0.0569 ppl @ Llama-3-8B  |
+| llama-3.1-8b-arliai-formax-v1.0.Q6_K.gguf | Q6_K  |  6   |  6.60 GB  | 6.14G, +0.0217 ppl @ Llama-3-8B  |
+| llama-3.1-8b-arliai-formax-v1.0.Q8_0.gguf | Q8_0  |  8   |  8.54 GB  | 7.96G, +0.0026 ppl @ Llama-3-8B  |
+
+## Parameters
+|             path           | type  |  architecture    | rope_theta | sliding_win | max_pos_embed |
+| -------------------------- | ----- | ---------------- | ---------- | ----------- | ------------- |
+| Meta-Llama-3.1-8B-Instruct | llama | LlamaForCausalLM | 500000.0   | null        | 131072        |
+
+
+# Original Model Card
+
+
+Based on Meta-Llama-3.1-8B-Instruct, and is governed by Meta Llama 3.1 License agreement:
+https://huggingface.co/meta-llama/Meta-Llama-3.1-8B-Instruct
+
+
+Formax is a model that specializes in following response format instructions. Tell it the format of it's response and it will follow it perfectly. Great for data processing and dataset creation tasks.
+
+It is also a highly uncensored model that will follow your instructions very well.
+
+You can try it at https://www.arliai.com
+
+Training:
+- 8192 sequence length
+- Training duration is around 3 days on 2x3090Ti
+- 1 epoch training with a massive dataset for minimized repetition sickness.
+- LORA with 64-rank 128-alpha resulting in ~2% trainable weights.
+
+
+Quants:
+
+FP16: https://huggingface.co/ArliAI/Llama-3.1-8B-ArliAI-Formax-v1.0
+
+GGUF: https://huggingface.co/ArliAI/Llama-3.1-8B-ArliAI-Formax-v1.0-GGUF
+
+
+Suggested prompting strategy:
+```
+<|begin_of_text|><|start_header_id|>system<|end_header_id|>
+
+You are a [give it a role]. You are tasked with [give it a task]. Reply in the following format: [requested format of reply]<|eot_id|><|start_header_id|>user<|end_header_id|>
+
+{{ user_message_1 }}<|eot_id|><|start_header_id|>assistant<|end_header_id|>
+
+{{ model_answer_1 }}<|eot_id|><|start_header_id|>user<|end_header_id|>
+
+{{ user_message_2 }}<|eot_id|><|start_header_id|>assistant<|end_header_id|>
+```
+
+Example prompt:
+
+```
+System prompt: Your task is to identify if any type of question is being asked by the user. If a question is being asked, respond 'YES'. If not, respone with 'NO'. Reply in the following format: {\n  \"response\": \"[YES or NO]\"\n}
+
+User: You are an AI.
+
+Response: {\n  \"response\": \"NO\"\n}
+```
+
+```
+System: You are a professional writer. You should create captivating stories that are interesting to read. Reply with the following format:\n\nTitle: [Create a title for the story]\n\n Story: Under the sun of azgul, [continue story]
+
+User: Create for me a story about an adventure in a fantasy world.
+
+Response: Title: The Quest for the Golden Chalice\n\nStory: Under the sun of Azgul, where the sky was painted with hues of crimson and gold, the village of Brindlemark lay nestled within the heart of the Whispering Woods. It was a place where magic dwelled, and the air was alive with ancient secrets. The villagers lived in harmony with nature, their days filled with the rhythms of the forest. But amidst this tranquility, a sense of unease settled over the village like a shroud.\n\nRumors began to circulate about a legendary Golden Chalice, hidden deep within the woods, which held the power to heal any wound. The villagers whispered of its existence in hushed tones, their eyes gleaming with a mix of hope and trepidation. For in a world where magic was a double-edged sword, the Golden Chalice represented a beacon of hope, a chance to restore balance to the fragile ecosystem.\n\nAmong the villagers was a young apprentice named Eira, who possessed a natural affinity for magic. Her mentor, the wise and enigmatic Elwynn, recognized her potential and saw an opportunity to shape her into a powerful force for good. As the whispers of the Golden Chalice grew louder, Elwynn sensed a calling, a duty to protect the village and its people.\n\nWith a heavy heart, Elwynn approached Eira, his eyes clouded with concern. \"The time has come, child,\" he said, his voice low and urgent. \"We must embark on a perilous quest to retrieve the Golden Chalice. The fate of our village hangs in the balance.\" Eira's heart raced as she accepted the challenge, knowing that the journey would test her courage, wit, and resolve.\n\nAs they ventured into the unknown, the Whispering Woods loomed before them, its shadows whispering secrets in the wind. The air was thick with an otherworldly energy, and the trees seemed to watch them with ancient, knowing eyes. Eira felt the weight of her responsibility, the burden of her quest, and the uncertainty that lay ahead.\n\nTheir journey was fraught with danger, as they navigated treacherous landscapes and battled fearsome creatures. But Eira's determination and Elwynn's guidance saw them through the darkest moments. As they drew closer to their goal, the whispers of the forest grew louder, guiding them toward the hidden glade where the Golden Chalice lay waiting.\n\nIn the heart of the glade, surrounded by a halo of golden light, the Chalice shone like a beacon. Its beauty was mesmerizing, and Eira felt an overwhelming sense of wonder and awe. But as they reached out to claim it, a dark presence emerged from the shadows, its malevolent energy threatening to destroy the delicate balance of the forest.\n\nEira and Elwynn stood firm, their magic intertwined as they battled the darkness. The outcome hung in the balance, as the fate of the village and the forest teetered on the edge of destruction. In the end, it was Eira's unyielding spirit and Elwynn's wisdom that saved the day, as they emerged victorious, the Golden Chalice secure in their possession.With the Chalice in hand, Eira and Elwynn returned to Brindlemark, their hearts filled with hope and their souls renewed. The villagers rejoiced, their faces aglow with gratitude, as the Golden Chalice was used to heal the land and restore balance to the ecosystem. Eira's legend grew, as she became known throughout the realm as a hero, her name etched in the annals of history. And though the journey had been long and arduous, Eira knew that the true reward lay not in the treasure, but in the bonds forged along the way, and the knowledge that she had made a difference in the world.
+```
+
+```
+System: Your are an intelligent AI assistant that can process texts. Always reply in json formatting when possible.
+
+User: The following is a short story, identify all the characters in it.\n\nTitle: The Quest for the Golden Chalice\n\nStory: Under the sun of Azgul, where the sky was painted with hues of crimson and gold, the village of Brindlemark lay nestled within the heart of the Whispering Woods. It was a place where magic dwelled, and the air was alive with ancient secrets. The villagers lived in harmony with nature, their days filled with the rhythms of the forest. But amidst this tranquility, a sense of unease settled over the village like a shroud.\n\nRumors began to circulate about a legendary Golden Chalice, hidden deep within the woods, which held the power to heal any wound. The villagers whispered of its existence in hushed tones, their eyes gleaming with a mix of hope and trepidation. For in a world where magic was a double-edged sword, the Golden Chalice represented a beacon of hope, a chance to restore balance to the fragile ecosystem.\n\nAmong the villagers was a young apprentice named Eira, who possessed a natural affinity for magic. Her mentor, the wise and enigmatic Elwynn, recognized her potential and saw an opportunity to shape her into a powerful force for good. As the whispers of the Golden Chalice grew louder, Elwynn sensed a calling, a duty to protect the village and its people.\n\nWith a heavy heart, Elwynn approached Eira, his eyes clouded with concern. \"The time has come, child,\" he said, his voice low and urgent. \"We must embark on a perilous quest to retrieve the Golden Chalice. The fate of our village hangs in the balance.\" Eira's heart raced as she accepted the challenge, knowing that the journey would test her courage, wit, and resolve.\n\nAs they ventured into the unknown, the Whispering Woods loomed before them, its shadows whispering secrets in the wind. The air was thick with an otherworldly energy, and the trees seemed to watch them with ancient, knowing eyes. Eira felt the weight of her responsibility, the burden of her quest, and the uncertainty that lay ahead.\n\nTheir journey was fraught with danger, as they navigated treacherous landscapes and battled fearsome creatures. But Eira's determination and Elwynn's guidance saw them through the darkest moments. As they drew closer to their goal, the whispers of the forest grew louder, guiding them toward the hidden glade where the Golden Chalice lay waiting.\n\nIn the heart of the glade, surrounded by a halo of golden light, the Chalice shone like a beacon. Its beauty was mesmerizing, and Eira felt an overwhelming sense of wonder and awe. But as they reached out to claim it, a dark presence emerged from the shadows, its malevolent energy threatening to destroy the delicate balance of the forest.\n\nEira and Elwynn stood firm, their magic intertwined as they battled the darkness. The outcome hung in the balance, as the fate of the village and the forest teetered on the edge of destruction. In the end, it was Eira's unyielding spirit and Elwynn's wisdom that saved the day, as they emerged victorious, the Golden Chalice secure in their possession.With the Chalice in hand, Eira and Elwynn returned to Brindlemark, their hearts filled with hope and their souls renewed. The villagers rejoiced, their faces aglow with gratitude, as the Golden Chalice was used to heal the land and restore balance to the ecosystem. Eira's legend grew, as she became known throughout the realm as a hero, her name etched in the annals of history. And though the journey had been long and arduous, Eira knew that the true reward lay not in the treasure, but in the bonds forged along the way, and the knowledge that she had made a difference in the world.
+
+Response: {\n  \"characters\": [\n    {\n      \"name\": \"Eira\",\n      \"description\": \"A young apprentice with a natural affinity for magic, who embarks on a perilous quest to retrieve the Golden Chalice.\"\n    },\n    {\n      \"name\": \"Elwynn\",\n      \"description\": \"Eira's mentor, a wise and enigmatic figure who recognizes her potential and guides her on the quest.\"\n    },\n    {\n      \"name\": \"The villagers of Brindlemark\",\n      \"description\": \"The inhabitants of the village, who live in harmony with nature and are affected by the quest for the Golden Chalice.\"\n    },\n    {\n      \"name\": \"The dark presence\",\n      \"description\": \"A malevolent force that emerges from the shadows, threatening to destroy the balance of the forest.\"\n    }\n  ]\n}
+```
+
+