prithivMLmods commited on
Commit
069e79f
1 Parent(s): b65d94b

Update README.md

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