prithivMLmods commited on
Commit
951e4ad
1 Parent(s): 63acd1a

Update README.md

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