prithivMLmods commited on
Commit
50a0a4d
1 Parent(s): 69bf411

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +122 -3
README.md CHANGED
@@ -1,3 +1,122 @@
1
- ---
2
- license: creativeml-openrail-m
3
- ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: creativeml-openrail-m
3
+ language:
4
+ - en
5
+ base_model:
6
+ - Qwen/Qwen2.5-Coder-7B
7
+ pipeline_tag: text-generation
8
+ library_name: transformers
9
+ tags:
10
+ - Qwen2.5
11
+ - Coder
12
+ - 7B
13
+ - F16
14
+ - 16-bit
15
+ - Q4
16
+ - Q5
17
+ - Q8
18
+ - Llama-cpp
19
+ ---
20
+ ## Qwen2.5-Coder-7B-GGUF
21
+
22
+ | File Name | Size | Description |
23
+ |-----------------------------------|---------|-------------------------------------------------------------------|
24
+ | `.gitattributes` | 1.77kB | Configuration file for Git and LFS handling. |
25
+ | `Qwen2.5-Coder-7B.F16.gguf` | 15.2GB | Full-precision (16-bit) model for coding tasks. |
26
+ | `Qwen2.5-Coder-7B.Q4_K_M.gguf` | 4.68GB | Quantized 4-bit model (medium variant) for reduced resource usage.|
27
+ | `Qwen2.5-Coder-7B.Q5_K_M.gguf` | 5.44GB | Quantized 5-bit model (medium variant) balancing size and accuracy.|
28
+ | `Qwen2.5-Coder-7B.Q8_0.gguf` | 8.1GB | Quantized 8-bit model for improved accuracy in coding tasks. |
29
+ | `README.md` | 42B | Initial README with basic information. |
30
+
31
+
32
+ # Run with Ollama 🦙
33
+
34
+ ## Overview
35
+
36
+ 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.
37
+
38
+ ## Table of Contents
39
+
40
+ - [Download and Install Ollama](#download-and-install-ollama)
41
+ - [Steps to Run GGUF Models](#steps-to-run-gguf-models)
42
+ - [1. Create the Model File](#1-create-the-model-file)
43
+ - [2. Add the Template Command](#2-add-the-template-command)
44
+ - [3. Create and Patch the Model](#3-create-and-patch-the-model)
45
+ - [Running the Model](#running-the-model)
46
+ - [Sample Usage](#sample-usage)
47
+
48
+ ## Download and Install Ollama🦙
49
+
50
+ To get started, download Ollama from [https://ollama.com/download](https://ollama.com/download) and install it on your Windows or Mac system.
51
+
52
+ ## Steps to Run GGUF Models
53
+
54
+ ### 1. Create the Model File
55
+ First, create a model file and name it appropriately. For example, you can name your model file `metallama`.
56
+
57
+ ### 2. Add the Template Command
58
+ In your model file, include a `FROM` line that specifies the base model file you want to use. For instance:
59
+
60
+ ```bash
61
+ FROM Llama-3.2-1B.F16.gguf
62
+ ```
63
+
64
+ Ensure that the model file is in the same directory as your script.
65
+
66
+ ### 3. Create and Patch the Model
67
+ Open your terminal and run the following command to create and patch your model:
68
+
69
+ ```bash
70
+ ollama create metallama -f ./metallama
71
+ ```
72
+
73
+ Once the process is successful, you will see a confirmation message.
74
+
75
+ To verify that the model was created successfully, you can list all models with:
76
+
77
+ ```bash
78
+ ollama list
79
+ ```
80
+
81
+ Make sure that `metallama` appears in the list of models.
82
+
83
+ ---
84
+
85
+ ## Running the Model
86
+
87
+ To run your newly created model, use the following command in your terminal:
88
+
89
+ ```bash
90
+ ollama run metallama
91
+ ```
92
+
93
+ ### Sample Usage
94
+
95
+ In the command prompt, you can execute:
96
+
97
+ ```bash
98
+ D:\>ollama run metallama
99
+ ```
100
+
101
+ You can interact with the model like this:
102
+
103
+ ```plaintext
104
+ >>> write a mini passage about space x
105
+ Space X, the private aerospace company founded by Elon Musk, is revolutionizing the field of space exploration.
106
+ With its ambitious goals to make humanity a multi-planetary species and establish a sustainable human presence in
107
+ the cosmos, Space X has become a leading player in the industry. The company's spacecraft, like the Falcon 9, have
108
+ demonstrated remarkable capabilities, allowing for the transport of crews and cargo into space with unprecedented
109
+ efficiency. As technology continues to advance, the possibility of establishing permanent colonies on Mars becomes
110
+ increasingly feasible, thanks in part to the success of reusable rockets that can launch multiple times without
111
+ sustaining significant damage. The journey towards becoming a multi-planetary species is underway, and Space X
112
+ plays a pivotal role in pushing the boundaries of human exploration and settlement.
113
+ ```
114
+
115
+ ---
116
+
117
+ ## Conclusion
118
+
119
+ 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.
120
+
121
+
122
+ - 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.