prithivMLmods commited on
Commit
cd5a8a8
1 Parent(s): e79c929

Update README.md

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