prithivMLmods commited on
Commit
d3aa7b0
1 Parent(s): a0c8b44

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +173 -0
README.md CHANGED
@@ -15,4 +15,177 @@ tags:
15
  - Llama-cpp
16
  - text-generation-inference
17
  - o1-Journey
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
18
  ---
 
15
  - Llama-cpp
16
  - text-generation-inference
17
  - o1-Journey
18
+ ---
19
+ ### Acrux-500M-o1-Journey-GGUF Model Files
20
+
21
+ The **Acrux-500M-o1-Journey** is a lightweight, instruction-tuned language model fine-tuned from the **Qwen2.5-0.5B-Instruct** base model. With a size of 500 million parameters, it is designed for **cost-effective deployment** and **fast text generation** while maintaining quality performance for instruction-following tasks.
22
+
23
+ | **File Name** | **Size** | **Description** | **Upload Status** |
24
+ |-----------------------------------------|----------------|-----------------------------------------------|--------------------|
25
+ | `.gitattributes` | 2.42 kB | Specifies file tracking rules (e.g., LFS). | Uploaded |
26
+ | `Modelfile` | 1.69 kB | Metadata or additional information file. | Uploaded |
27
+ | `README.md` | 158 Bytes | Basic project description or instructions. | Updated |
28
+ | `acrux-500m-o1-journey-f16.gguf` | 994 MB | Base FP16 model file in GGUF format. | Uploaded (LFS) |
29
+ | `acrux-500m-o1-journey-q2_k.gguf` | 339 MB | Quantized model (Q2_K) for efficient usage. | Uploaded (LFS) |
30
+ | `acrux-500m-o1-journey-q3_k_l.gguf` | 369 MB | Quantized model (Q3_K_L). | Uploaded (LFS) |
31
+ | `acrux-500m-o1-journey-q3_k_m.gguf` | 355 MB | Quantized model (Q3_K_M). | Uploaded (LFS) |
32
+ | `acrux-500m-o1-journey-q3_k_s.gguf` | 338 MB | Quantized model (Q3_K_S). | Uploaded (LFS) |
33
+ | `acrux-500m-o1-journey-q4_0.gguf` | 352 MB | Quantized model (Q4_0). | Uploaded (LFS) |
34
+ | `acrux-500m-o1-journey-q4_k_m.gguf` | 398 MB | Quantized model (Q4_K_M). | Uploaded (LFS) |
35
+ | `acrux-500m-o1-journey-q4_k_s.gguf` | 385 MB | Quantized model (Q4_K_S). | Uploaded (LFS) |
36
+ | `acrux-500m-o1-journey-q5_0.gguf` | 397 MB | Quantized model (Q5_0). | Uploaded (LFS) |
37
+ | `acrux-500m-o1-journey-q5_k_m.gguf` | 420 MB | Quantized model (Q5_K_M). | Uploaded (LFS) |
38
+ | `acrux-500m-o1-journey-q5_k_s.gguf` | 413 MB | Quantized model (Q5_K_S). | Uploaded (LFS) |
39
+ | `acrux-500m-o1-journey-q6_k.gguf` | 506 MB | Quantized model (Q6_K). | Uploaded (LFS) |
40
+ | `acrux-500m-o1-journey-q8_0.gguf` | 531 MB | Quantized model (Q8_0). | Uploaded (LFS) |
41
+ | `config.json` | 29 Bytes | Basic configuration file for the model. | Uploaded |
42
+
43
+ ---
44
+ ### **Key Features:**
45
+
46
+ 1. **Compact Size with Efficient Performance:**
47
+ The smaller parameter count (500M) ensures faster inference and reduced hardware requirements.
48
+
49
+ 2. **Instruction Optimization:**
50
+ Fine-tuned to follow prompts effectively, making it suitable for interactive applications and prompt-based tasks.
51
+
52
+ 3. **Domain-Specific Training:**
53
+ Trained on the **GAIR/o1-journey** dataset, providing tailored capabilities for specific use cases.
54
+
55
+ ---
56
+
57
+ ### **Training Details:**
58
+ - **Base Model:** [Qwen2.5-0.5B-Instruct](#)
59
+ - **Dataset Used for Fine-Tuning:** [GAIR/o1-journey](#)
60
+ - A compact dataset focusing on instruction-driven generation with 1.42k samples.
61
+
62
+ ---
63
+ ### **Capabilities:**
64
+
65
+ 1. **Instruction Following:**
66
+ - Generates accurate and coherent responses to user instructions.
67
+ - Handles summarization, question-answering, and conversational tasks.
68
+
69
+ 2. **Fast Inference:**
70
+ - Ideal for real-time applications due to reduced latency from its smaller size.
71
+
72
+ 3. **Interactive AI Development:**
73
+ - Suitable for chatbots, virtual assistants, and instructional interfaces.
74
+
75
+ ---
76
+ ### **Usage Instructions:**
77
+
78
+ 1. **Setup:**
79
+ Download all model files, ensuring compatibility with the Hugging Face Transformers library.
80
+
81
+ 2. **Loading the Model:**
82
+ ```python
83
+ from transformers import AutoModelForCausalLM, AutoTokenizer
84
+
85
+ model_name = "prithivMLmods/Acrux-500M-o1-Journey"
86
+ tokenizer = AutoTokenizer.from_pretrained(model_name)
87
+ model = AutoModelForCausalLM.from_pretrained(model_name)
88
+ ```
89
+ 3. **Sample Generate Text:**
90
+ ```python
91
+ input_text = "Explain the concept of machine learning in simple terms."
92
+ inputs = tokenizer(input_text, return_tensors="pt")
93
+ outputs = model.generate(**inputs, max_length=100, temperature=0.7)
94
+ print(tokenizer.decode(outputs[0], skip_special_tokens=True))
95
+ ```
96
+ 4. **Optimize Generation:**
97
+ Adjust parameters in `generation_config.json` for better control of output, such as:
98
+ - `temperature` for randomness.
99
+ - `top_p` for sampling diversity.
100
+ - `max_length` for output size.
101
+ ---
102
+ # Run with Ollama [ Ollama Run ]
103
+
104
+ ## Overview
105
+
106
+ Ollama is a powerful tool that allows you to run machine learning models effortlessly. This guide will help you download, install, and run your own GGUF models in just a few minutes.
107
+
108
+ ## Table of Contents
109
+
110
+ - [Download and Install Ollama](#download-and-install-ollama)
111
+ - [Steps to Run GGUF Models](#steps-to-run-gguf-models)
112
+ - [1. Create the Model File](#1-create-the-model-file)
113
+ - [2. Add the Template Command](#2-add-the-template-command)
114
+ - [3. Create and Patch the Model](#3-create-and-patch-the-model)
115
+ - [Running the Model](#running-the-model)
116
+ - [Sample Usage](#sample-usage)
117
+
118
+ ## Download and Install Ollama🦙
119
+
120
+ To get started, download Ollama from [https://ollama.com/download](https://ollama.com/download) and install it on your Windows or Mac system.
121
+
122
+ ## Steps to Run GGUF Models
123
+
124
+ ### 1. Create the Model File
125
+ First, create a model file and name it appropriately. For example, you can name your model file `metallama`.
126
+
127
+ ### 2. Add the Template Command
128
+ In your model file, include a `FROM` line that specifies the base model file you want to use. For instance:
129
+
130
+ ```bash
131
+ FROM Llama-3.2-1B.F16.gguf
132
+ ```
133
+
134
+ Ensure that the model file is in the same directory as your script.
135
+
136
+ ### 3. Create and Patch the Model
137
+ Open your terminal and run the following command to create and patch your model:
138
+
139
+ ```bash
140
+ ollama create metallama -f ./metallama
141
+ ```
142
+
143
+ Once the process is successful, you will see a confirmation message.
144
+
145
+ To verify that the model was created successfully, you can list all models with:
146
+
147
+ ```bash
148
+ ollama list
149
+ ```
150
+
151
+ Make sure that `metallama` appears in the list of models.
152
+
153
+ ---
154
+
155
+ ## Running the Model
156
+
157
+ To run your newly created model, use the following command in your terminal:
158
+
159
+ ```bash
160
+ ollama run metallama
161
+ ```
162
+
163
+ ### Sample Usage / Test
164
+
165
+ In the command prompt, you can execute:
166
+
167
+ ```bash
168
+ D:\>ollama run metallama
169
+ ```
170
+
171
+ You can interact with the model like this:
172
+
173
+ ```plaintext
174
+ >>> write a mini passage about space x
175
+ Space X, the private aerospace company founded by Elon Musk, is revolutionizing the field of space exploration.
176
+ With its ambitious goals to make humanity a multi-planetary species and establish a sustainable human presence in
177
+ the cosmos, Space X has become a leading player in the industry. The company's spacecraft, like the Falcon 9, have
178
+ demonstrated remarkable capabilities, allowing for the transport of crews and cargo into space with unprecedented
179
+ efficiency. As technology continues to advance, the possibility of establishing permanent colonies on Mars becomes
180
+ increasingly feasible, thanks in part to the success of reusable rockets that can launch multiple times without
181
+ sustaining significant damage. The journey towards becoming a multi-planetary species is underway, and Space X
182
+ plays a pivotal role in pushing the boundaries of human exploration and settlement.
183
+ ```
184
+ ---
185
+ ## Conclusion
186
+
187
+ With these simple steps, you can easily download, install, and run your own models using Ollama. Whether you're exploring the capabilities of Llama or building your own custom models, Ollama makes it accessible and efficient.
188
+
189
+
190
+ - This README provides clear instructions and structured information to help users navigate the process of using Ollama effectively. Adjust any sections as needed based on your specific requirements or additional details you may want to include.
191
  ---