prithivMLmods commited on
Commit
2e8055a
1 Parent(s): 0721ee7

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +110 -1
README.md CHANGED
@@ -26,4 +26,113 @@ language:
26
  - vi
27
  base_model:
28
  - CohereForAI/aya-expanse-8b
29
- ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
26
  - vi
27
  base_model:
28
  - CohereForAI/aya-expanse-8b
29
+ ---
30
+
31
+ # Uploaded model
32
+
33
+ - **Developed by:** prithivMLmods
34
+ - **License:** apache-2.0
35
+ - **Quants from model :** CohereForAI/aya-expanse-8b
36
+
37
+ Here's a well-structured README.md documentation for running models with Ollama:
38
+
39
+ # Run with Ollama 🦙
40
+
41
+ > [!WARNING]
42
+ > **Note:** The model name mentioned in the README.md may or may not be same.
43
+
44
+ ## Overview
45
+
46
+ 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.
47
+
48
+ ## Table of Contents
49
+
50
+ | Section | Description |
51
+ |------------------------------|----------------------------------|
52
+ | [Download and Install Ollama](#download-and-install-ollama) | Instructions for downloading and installing Ollama. |
53
+ | [Steps to Run GGUF Models](#steps-to-run-gguf-models) | Guidelines for running GGUF models. |
54
+ | 1. [Create the Model File](#1-create-the-model-file) | Steps to create the model file. |
55
+ | 2. [Add the Template Command](#2-add-the-template-command) | Instructions for adding the template command. |
56
+ | 3. [Create and Patch the Model](#3-create-and-patch-the-model) | Process for creating and patching the model. |
57
+ | [Running the Model](#running-the-model) | How to run the model. |
58
+ | [Sample Usage](#sample-usage) | Examples of how to use the model. |
59
+
60
+ ## Download and Install Ollama
61
+
62
+ To get started, download Ollama from [https://ollama.com/download](https://ollama.com/download) and install it on your Windows or Mac system.
63
+
64
+ ## Steps to Run GGUF Models
65
+
66
+ ### 1. Create the Model File
67
+ First, create a model file and name it appropriately. For example, you can name your model file `metallama`.
68
+
69
+ ### 2. Add the Template Command
70
+ In your model file, include a `FROM` line that specifies the base model file you want to use. For instance:
71
+
72
+ ```bash
73
+ FROM Llama-3.2-1B.F16.gguf
74
+ ```
75
+
76
+ Ensure that the model file is in the same directory as your script.
77
+
78
+ ### 3. Create and Patch the Model
79
+ Open your terminal and run the following command to create and patch your model:
80
+
81
+ ```bash
82
+ ollama create metallama -f ./metallama
83
+ ```
84
+
85
+ Once the process is successful, you will see a confirmation message.
86
+
87
+ To verify that the model was created successfully, you can list all models with:
88
+
89
+ ```bash
90
+ ollama list
91
+ ```
92
+
93
+ Make sure that `metallama` appears in the list of models.
94
+
95
+ ---
96
+
97
+ ## Running the Model
98
+
99
+ To run your newly created model, use the following command in your terminal:
100
+
101
+ ```bash
102
+ ollama run metallama
103
+ ```
104
+
105
+ ### Sample Usage
106
+
107
+ In the command prompt, you can execute:
108
+
109
+ ```bash
110
+ D:\>ollama run metallama
111
+ ```
112
+
113
+ You can interact with the model like this:
114
+
115
+ ```plaintext
116
+ >>> write a mini passage about space x
117
+ Space X, the private aerospace company founded by Elon Musk, is revolutionizing the field of space exploration.
118
+ With its ambitious goals to make humanity a multi-planetary species and establish a sustainable human presence in
119
+ the cosmos, Space X has become a leading player in the industry. The company's spacecraft, like the Falcon 9, have
120
+ demonstrated remarkable capabilities, allowing for the transport of crews and cargo into space with unprecedented
121
+ efficiency. As technology continues to advance, the possibility of establishing permanent colonies on Mars becomes
122
+ increasingly feasible, thanks in part to the success of reusable rockets that can launch multiple times without
123
+ sustaining significant damage. The journey towards becoming a multi-planetary species is underway, and Space X
124
+ plays a pivotal role in pushing the boundaries of human exploration and settlement.
125
+ ```
126
+
127
+ ---
128
+
129
+ ## Conclusion
130
+
131
+ 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.
132
+
133
+
134
+ - 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.
135
+
136
+
137
+
138
+ https://huggingface.co/prithivMLmods/Llama-3.2-1B-GGUF/resolve/main/Demo/gguf.gif