prithivMLmods commited on
Commit
d1b082d
1 Parent(s): 20b6e9b

Update README.md

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