prithivMLmods commited on
Commit
8ef961f
1 Parent(s): 0bae67e

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +142 -0
README.md CHANGED
@@ -20,6 +20,8 @@ tags:
20
 
21
  ### QwQ-LCoT-7B-Instruct Model in GGUF Format
22
 
 
 
23
  | **File Name** | **Size** | **Description** | **Upload Status** |
24
  |-------------------------------------------|---------------|--------------------------------------------------|--------------------|
25
  | `.gitattributes` | 1.79 kB | Tracks files stored with Git LFS. | Uploaded |
@@ -30,4 +32,144 @@ tags:
30
  | `README.md` | 42 Bytes | Initial commit for project documentation. | Uploaded |
31
  | `config.json` | 29 Bytes | Configuration file for model setup. | Uploaded |
32
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
33
  ---
 
20
 
21
  ### QwQ-LCoT-7B-Instruct Model in GGUF Format
22
 
23
+ The **QwQ-LCoT-7B-Instruct** is a fine-tuned language model designed for advanced reasoning and instruction-following tasks. It leverages the **Qwen2.5-7B** base model and has been fine-tuned on the **amphora/QwQ-LongCoT-130K** dataset, focusing on chain-of-thought (CoT) reasoning.
24
+
25
  | **File Name** | **Size** | **Description** | **Upload Status** |
26
  |-------------------------------------------|---------------|--------------------------------------------------|--------------------|
27
  | `.gitattributes` | 1.79 kB | Tracks files stored with Git LFS. | Uploaded |
 
32
  | `README.md` | 42 Bytes | Initial commit for project documentation. | Uploaded |
33
  | `config.json` | 29 Bytes | Configuration file for model setup. | Uploaded |
34
 
35
+ ---
36
+ ### **Sample Long CoT:**
37
+
38
+ ![Screenshot 2024-12-13 211732.png](https://cdn-uploads.huggingface.co/production/uploads/65bb837dbfb878f46c77de4c/Mgm9LmQZlFZmglKYwEDYA.png)
39
+
40
+ ---
41
+ ### **Key Features:**
42
+
43
+ 1. **Model Size:**
44
+ - **7.62B parameters** (FP16 precision).
45
+
46
+ 2. **Model Sharding:**
47
+ - The model weights are split into 4 shards (`safetensors`) for efficient storage and download:
48
+ - `model-00001-of-00004.safetensors` (4.88 GB)
49
+ - `model-00002-of-00004.safetensors` (4.93 GB)
50
+ - `model-00003-of-00004.safetensors` (4.33 GB)
51
+ - `model-00004-of-00004.safetensors` (1.09 GB)
52
+
53
+ 3. **Tokenizer:**
54
+ - Byte-pair encoding (BPE) based.
55
+ - Files included:
56
+ - `vocab.json` (2.78 MB)
57
+ - `merges.txt` (1.82 MB)
58
+ - `tokenizer.json` (11.4 MB)
59
+ - Special tokens mapped in `special_tokens_map.json` (e.g., `<pad>`, `<eos>`).
60
+
61
+ 4. **Configuration Files:**
62
+ - `config.json`: Defines model architecture and hyperparameters.
63
+ - `generation_config.json`: Settings for inference and text generation tasks.
64
+
65
+ ---
66
+
67
+ ### **Training Dataset:**
68
+ - **Dataset Name:** [amphora/QwQ-LongCoT-130K](https://huggingface.co/amphora/QwQ-LongCoT-130K)
69
+ - **Size:** 133k examples.
70
+ - **Focus:** Chain-of-Thought reasoning for complex tasks.
71
+
72
+ ---
73
+
74
+ ### **Use Cases:**
75
+ 1. **Instruction Following:**
76
+ Handle user instructions effectively, even for multi-step tasks.
77
+
78
+ 2. **Reasoning Tasks:**
79
+ Perform logical reasoning and generate detailed step-by-step solutions.
80
+
81
+ 3. **Text Generation:**
82
+ Generate coherent, context-aware responses.
83
+ ---
84
+ # Run with Ollama [ Ollama Run ]
85
+
86
+ ## Overview
87
+
88
+ 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.
89
+
90
+ ## Table of Contents
91
+
92
+ - [Download and Install Ollama](#download-and-install-ollama)
93
+ - [Steps to Run GGUF Models](#steps-to-run-gguf-models)
94
+ - [1. Create the Model File](#1-create-the-model-file)
95
+ - [2. Add the Template Command](#2-add-the-template-command)
96
+ - [3. Create and Patch the Model](#3-create-and-patch-the-model)
97
+ - [Running the Model](#running-the-model)
98
+ - [Sample Usage](#sample-usage)
99
+
100
+ ## Download and Install Ollama🦙
101
+
102
+ To get started, download Ollama from [https://ollama.com/download](https://ollama.com/download) and install it on your Windows or Mac system.
103
+
104
+ ## Steps to Run GGUF Models
105
+
106
+ ### 1. Create the Model File
107
+ First, create a model file and name it appropriately. For example, you can name your model file `metallama`.
108
+
109
+ ### 2. Add the Template Command
110
+ In your model file, include a `FROM` line that specifies the base model file you want to use. For instance:
111
+
112
+ ```bash
113
+ FROM Llama-3.2-1B.F16.gguf
114
+ ```
115
+
116
+ Ensure that the model file is in the same directory as your script.
117
+
118
+ ### 3. Create and Patch the Model
119
+ Open your terminal and run the following command to create and patch your model:
120
+
121
+ ```bash
122
+ ollama create metallama -f ./metallama
123
+ ```
124
+
125
+ Once the process is successful, you will see a confirmation message.
126
+
127
+ To verify that the model was created successfully, you can list all models with:
128
+
129
+ ```bash
130
+ ollama list
131
+ ```
132
+
133
+ Make sure that `metallama` appears in the list of models.
134
+
135
+ ---
136
+
137
+ ## Running the Model
138
+
139
+ To run your newly created model, use the following command in your terminal:
140
+
141
+ ```bash
142
+ ollama run metallama
143
+ ```
144
+
145
+ ### Sample Usage / Test
146
+
147
+ In the command prompt, you can execute:
148
+
149
+ ```bash
150
+ D:\>ollama run metallama
151
+ ```
152
+
153
+ You can interact with the model like this:
154
+
155
+ ```plaintext
156
+ >>> write a mini passage about space x
157
+ Space X, the private aerospace company founded by Elon Musk, is revolutionizing the field of space exploration.
158
+ With its ambitious goals to make humanity a multi-planetary species and establish a sustainable human presence in
159
+ the cosmos, Space X has become a leading player in the industry. The company's spacecraft, like the Falcon 9, have
160
+ demonstrated remarkable capabilities, allowing for the transport of crews and cargo into space with unprecedented
161
+ efficiency. As technology continues to advance, the possibility of establishing permanent colonies on Mars becomes
162
+ increasingly feasible, thanks in part to the success of reusable rockets that can launch multiple times without
163
+ sustaining significant damage. The journey towards becoming a multi-planetary species is underway, and Space X
164
+ plays a pivotal role in pushing the boundaries of human exploration and settlement.
165
+ ```
166
+ ---
167
+
168
+ ## Conclusion
169
+
170
+ 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.
171
+
172
+
173
+ - 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.
174
+
175
  ---