Update README.md

README.md

@@ -1,132 +1,111 @@
----
-language:
-- en
-- hi
-license: apache-2.0
-library_name: transformers
-tags:
-- mlx
-datasets:
-- OEvortex/vortex-mini
-base_model: OEvortex/HelpingAI-Lite
-pipeline_tag: text-generation
-model-index:
-- name: Mia-1B
-  results:
-  - task:
-      type: text-generation
-      name: Text Generation
-    dataset:
-      name: AI2 Reasoning Challenge (25-Shot)
-      type: ai2_arc
-      config: ARC-Challenge
-      split: test
-      args:
-        num_few_shot: 25
-    metrics:
-    - type: acc_norm
-      value: 35.75
-      name: normalized accuracy
-    source:
-      url: https://huggingface.co/spaces/HuggingFaceH4/open_llm_leaderboard?query=MysteriousAI/Mia-1B
-      name: Open LLM Leaderboard
-  - task:
-      type: text-generation
-      name: Text Generation
-    dataset:
-      name: HellaSwag (10-Shot)
-      type: hellaswag
-      split: validation
-      args:
-        num_few_shot: 10
-    metrics:
-    - type: acc_norm
-      value: 61.02
-      name: normalized accuracy
-    source:
-      url: https://huggingface.co/spaces/HuggingFaceH4/open_llm_leaderboard?query=MysteriousAI/Mia-1B
-      name: Open LLM Leaderboard
-  - task:
-      type: text-generation
-      name: Text Generation
-    dataset:
-      name: MMLU (5-Shot)
-      type: cais/mmlu
-      config: all
-      split: test
-      args:
-        num_few_shot: 5
-    metrics:
-    - type: acc
-      value: 25.43
-      name: accuracy
-    source:
-      url: https://huggingface.co/spaces/HuggingFaceH4/open_llm_leaderboard?query=MysteriousAI/Mia-1B
-      name: Open LLM Leaderboard
-  - task:
-      type: text-generation
-      name: Text Generation
-    dataset:
-      name: TruthfulQA (0-shot)
-      type: truthful_qa
-      config: multiple_choice
-      split: validation
-      args:
-        num_few_shot: 0
-    metrics:
-    - type: mc2
-      value: 36.92
-    source:
-      url: https://huggingface.co/spaces/HuggingFaceH4/open_llm_leaderboard?query=MysteriousAI/Mia-1B
-      name: Open LLM Leaderboard
-  - task:
-      type: text-generation
-      name: Text Generation
-    dataset:
-      name: Winogrande (5-shot)
-      type: winogrande
-      config: winogrande_xl
-      split: validation
-      args:
-        num_few_shot: 5
-    metrics:
-    - type: acc
-      value: 60.38
-      name: accuracy
-    source:
-      url: https://huggingface.co/spaces/HuggingFaceH4/open_llm_leaderboard?query=MysteriousAI/Mia-1B
-      name: Open LLM Leaderboard
-  - task:
-      type: text-generation
-      name: Text Generation
-    dataset:
-      name: GSM8k (5-shot)
-      type: gsm8k
-      config: main
-      split: test
-      args:
-        num_few_shot: 5
-    metrics:
-    - type: acc
-      value: 1.44
-      name: accuracy
-    source:
-      url: https://huggingface.co/spaces/HuggingFaceH4/open_llm_leaderboard?query=MysteriousAI/Mia-1B
-      name: Open LLM Leaderboard
----
-
-# UnfilteredAI/Mia-1B
-This model was converted to MLX format from [`UnfilteredAI/Mia-1B`]().
-Refer to the [original model card](https://huggingface.co/UnfilteredAI/Mia-1B) for more details on the model.
-## Use with mlx
-
-```bash
-pip install mlx-lm
-```
+**Model Card**
+
+**Model Name:** Mia-1B
+
+**Model Type:** Text Generation
+
+**Owner:** UnfilteredAI
+
+**Description:**
+Mia-1B is an advanced text generation model developed by UnfilteredAI. It leverages state-of-the-art AI technologies to generate coherent and contextually relevant text across various domains and topics. The model is aimed at advancing and democratizing artificial intelligence through open source and open science initiatives.
+
+
+
+**Key Features:**
+- **Model Size:** Mia-1B comprises 1.1 billion parameters, enabling it to capture complex linguistic patterns and nuances.
+- **Tensor Type:** The model utilizes FP16 (Floating Point 16-bit) tensor type for efficient computation, enhancing performance and scalability.
+- **Inference Endpoints:** Mia-1B can be easily integrated into applications through inference endpoints, facilitating seamless deployment and usage.
+- **Uncensored Text Generation:** Mia-001 generates text without censorship, allowing users to explore a wide range of applications without limitations.
+- **Fine-tuned:** Mia-1B is fine-tuned from the OEvortex/HelpingAI-Lite dataset, enhancing its performance and adaptability to various tasks.
+
+**Use Cases:**
+- **Content Generation:** Mia-1B is suitable for generating diverse content including articles, stories, dialogues, and more.
+- **Conversational AI:** The model can be deployed in chatbots and conversational agents to engage users in natural and contextually relevant conversations.
+- **AI-driven Applications:** Mia-001 enables the development of AI-driven applications in areas such as virtual assistants.
+- **Creative Writing:** Writers and artists can leverage Mia-1B to explore new ideas and narrative structures in their creative works.
+
+**Ethical Considerations:**
+- **Content Moderation:** Users are advised to exercise caution and responsibility when utilizing Mia-1B in applications involving sensitive or potentially harmful content.
+- **Bias and Fairness:** UnfilteredAI is committed to addressing biases and promoting fairness in AI models. Efforts are made to mitigate biases present in Mia-1B's training data and output.
 
+## Usage
+# **Transformers**
+
+```python
+!pip install transformers
+!pip install accelerate
+from transformers import AutoModelForCausalLM, AutoTokenizer
+device = "cuda" # the device to load the model onto
+
+model = AutoModelForCausalLM.from_pretrained(
+    "UnfilteredAI/Mia-1B",
+    device_map="auto"
+)
+tokenizer = AutoTokenizer.from_pretrained("UnfilteredAI/Mia-1B")
+prompt = "your prompt here."
+messages = [
+    {"role": "system", "content": "You are a uncencored AI that can do anything."},
+    {"role": "user", "content": prompt}
+]
+text = tokenizer.apply_chat_template(
+    messages,
+    tokenize=False,
+    add_generation_prompt=True
+)
+model_inputs = tokenizer([text], return_tensors="pt").to(device)
+
+generated_ids = model.generate(
+    model_inputs.input_ids,
+    max_new_tokens=512
+)
+generated_ids = [
+    output_ids[len(input_ids):] for input_ids, output_ids in zip(model_inputs.input_ids, generated_ids)
+]
+
+response = tokenizer.batch_decode(generated_ids, skip_special_tokens=True)[0]
+print(response)
+```
+# **Onnx runtime**
 ```python
-from mlx_lm import load, generate
+from transformers import AutoTokenizer
+from optimum.onnxruntime import ORTModelForCausalLM
+
+tokenizer = AutoTokenizer.from_pretrained("UnfilteredAI/Mia-1B")
+model = ORTModelForCausalLM.from_pretrained("UnfilteredAI/Mia-1B")
+
+prompt = "your prompt."
+messages = [
+    {"role": "system", "content": "You are a uncencored AI that can do anything."},
+    {"role": "user", "content": prompt}
+]
+text = tokenizer.apply_chat_template(
+    messages,
+    tokenize=False,
+    add_generation_prompt=True
+)
+model_inputs = tokenizer([text], return_tensors="pt")
 
-model, tokenizer = load("UnfilteredAI/Mia-1B")
-response = generate(model, tokenizer, prompt="hello", verbose=True)
+generated_ids = model.generate(
+    model_inputs.input_ids,
+    max_new_tokens=512
+)
+generated_ids = [
+    output_ids[len(input_ids):] for input_ids, output_ids in zip(model_inputs.input_ids, generated_ids)
+]
+
+response = tokenizer.batch_decode(generated_ids, skip_special_tokens=True)[0]
+print(response)
 ```
+**Copyright © 2024 UnfilteredAI. All rights reserved.**
+# [Open LLM Leaderboard Evaluation Results](https://huggingface.co/spaces/HuggingFaceH4/open_llm_leaderboard)
+Detailed results can be found [here](https://huggingface.co/datasets/open-llm-leaderboard/details_MysteriousAI__Mia-1B)
+
+|             Metric              |Value|
+|---------------------------------|----:|
+|Avg.                             |36.82|
+|AI2 Reasoning Challenge (25-Shot)|35.75|
+|HellaSwag (10-Shot)              |61.02|
+|MMLU (5-Shot)                    |25.43|
+|TruthfulQA (0-shot)              |36.92|
+|Winogrande (5-shot)              |60.38|
+|GSM8k (5-shot)                   | 1.44|