Solshine commited on
Commit
e4a216a
1 Parent(s): 8e1d998

Upload README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +253 -0
README.md ADDED
@@ -0,0 +1,253 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ base_model: meta-llama/Llama-3.2-3B-Instruct
3
+ language:
4
+ - en
5
+ - de
6
+ - fr
7
+ - it
8
+ - pt
9
+ - hi
10
+ - es
11
+ - th
12
+ library_name: transformers
13
+ license: llama3.2
14
+ pipeline_tag: text-generation
15
+ tags:
16
+ - facebook
17
+ - meta
18
+ - pytorch
19
+ - llama
20
+ - llama-3
21
+ - llama-cpp
22
+ - gguf-my-repo
23
+ extra_gated_prompt: "### LLAMA 3.2 COMMUNITY LICENSE AGREEMENT\n\nLlama 3.2 Version\
24
+ \ Release Date: September 25, 2024\n\n“Agreement” means the terms and conditions\
25
+ \ for use, reproduction, distribution and modification of the Llama Materials set\
26
+ \ forth herein.\n\n“Documentation” means the specifications, manuals and documentation\
27
+ \ accompanying Llama 3.2 distributed by Meta at https://llama.meta.com/doc/overview.\n\
28
+ \n“Licensee” or “you” means you, or your employer or any other person or entity\
29
+ \ (if you are entering into this Agreement on such person or entity’s behalf),\
30
+ \ of the age required under applicable laws, rules or regulations to provide legal\
31
+ \ consent and that has legal authority to bind your employer or such other person\
32
+ \ or entity if you are entering in this Agreement on their behalf.\n\n“Llama 3.2”\
33
+ \ means the foundational large language models and software and algorithms, including\
34
+ \ machine-learning model code, trained model weights, inference-enabling code, training-enabling\
35
+ \ code, fine-tuning enabling code and other elements of the foregoing distributed\
36
+ \ by Meta at https://www.llama.com/llama-downloads.\n\n“Llama Materials” means,\
37
+ \ collectively, Meta’s proprietary Llama 3.2 and Documentation (and any portion\
38
+ \ thereof) made available under this Agreement.\n\n“Meta” or “we” means Meta Platforms\
39
+ \ Ireland Limited (if you are located in or, if you are an entity, your principal\
40
+ \ place of business is in the EEA or Switzerland) and Meta Platforms, Inc. (if\
41
+ \ you are located outside of the EEA or Switzerland). \n\nBy clicking “I Accept”\
42
+ \ below or by using or distributing any portion or element of the Llama Materials,\
43
+ \ you agree to be bound by this Agreement.\n\n1. License Rights and Redistribution.\n\
44
+ a. Grant of Rights. You are granted a non-exclusive, worldwide, non-transferable\
45
+ \ and royalty-free limited license under Meta’s intellectual property or other rights\
46
+ \ owned by Meta embodied in the Llama Materials to use, reproduce, distribute,\
47
+ \ copy, create derivative works of, and make modifications to the Llama Materials.\
48
+ \ \nb. Redistribution and Use. \ni. If you distribute or make available the Llama\
49
+ \ Materials (or any derivative works thereof), or a product or service (including\
50
+ \ another AI model) that contains any of them, you shall (A) provide a copy of this\
51
+ \ Agreement with any such Llama Materials; and (B) prominently display “Built with\
52
+ \ Llama” on a related website, user interface, blogpost, about page, or product\
53
+ \ documentation. If you use the Llama Materials or any outputs or results of the\
54
+ \ Llama Materials to create, train, fine tune, or otherwise improve an AI model,\
55
+ \ which is distributed or made available, you shall also include “Llama” at the\
56
+ \ beginning of any such AI model name.\nii. If you receive Llama Materials, or any\
57
+ \ derivative works thereof, from a Licensee as part of an integrated end user product,\
58
+ \ then Section 2 of this Agreement will not apply to you. \niii. You must retain\
59
+ \ in all copies of the Llama Materials that you distribute the following attribution\
60
+ \ notice within a “Notice” text file distributed as a part of such copies: “Llama\
61
+ \ 3.2 is licensed under the Llama 3.2 Community License, Copyright © Meta Platforms,\
62
+ \ Inc. All Rights Reserved.”\niv. Your use of the Llama Materials must comply with\
63
+ \ applicable laws and regulations (including trade compliance laws and regulations)\
64
+ \ and adhere to the Acceptable Use Policy for the Llama Materials (available at\
65
+ \ https://www.llama.com/llama3_2/use-policy), which is hereby incorporated by reference\
66
+ \ into this Agreement.\n \n2. Additional Commercial Terms. If, on the Llama 3.2\
67
+ \ version release date, the monthly active users of the products or services made\
68
+ \ available by or for Licensee, or Licensee’s affiliates, is greater than 700 million\
69
+ \ monthly active users in the preceding calendar month, you must request a license\
70
+ \ from Meta, which Meta may grant to you in its sole discretion, and you are not\
71
+ \ authorized to exercise any of the rights under this Agreement unless or until\
72
+ \ Meta otherwise expressly grants you such rights.\n3. Disclaimer of Warranty. UNLESS\
73
+ \ REQUIRED BY APPLICABLE LAW, THE LLAMA MATERIALS AND ANY OUTPUT AND RESULTS THEREFROM\
74
+ \ ARE PROVIDED ON AN “AS IS” BASIS, WITHOUT WARRANTIES OF ANY KIND, AND META DISCLAIMS\
75
+ \ ALL WARRANTIES OF ANY KIND, BOTH EXPRESS AND IMPLIED, INCLUDING, WITHOUT LIMITATION,\
76
+ \ ANY WARRANTIES OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR\
77
+ \ PURPOSE. YOU ARE SOLELY RESPONSIBLE FOR DETERMINING THE APPROPRIATENESS OF USING\
78
+ \ OR REDISTRIBUTING THE LLAMA MATERIALS AND ASSUME ANY RISKS ASSOCIATED WITH YOUR\
79
+ \ USE OF THE LLAMA MATERIALS AND ANY OUTPUT AND RESULTS.\n4. Limitation of Liability.\
80
+ \ IN NO EVENT WILL META OR ITS AFFILIATES BE LIABLE UNDER ANY THEORY OF LIABILITY,\
81
+ \ WHETHER IN CONTRACT, TORT, NEGLIGENCE, PRODUCTS LIABILITY, OR OTHERWISE, ARISING\
82
+ \ OUT OF THIS AGREEMENT, FOR ANY LOST PROFITS OR ANY INDIRECT, SPECIAL, CONSEQUENTIAL,\
83
+ \ INCIDENTAL, EXEMPLARY OR PUNITIVE DAMAGES, EVEN IF META OR ITS AFFILIATES HAVE\
84
+ \ BEEN ADVISED OF THE POSSIBILITY OF ANY OF THE FOREGOING.\n5. Intellectual Property.\n\
85
+ a. No trademark licenses are granted under this Agreement, and in connection with\
86
+ \ the Llama Materials, neither Meta nor Licensee may use any name or mark owned\
87
+ \ by or associated with the other or any of its affiliates, except as required\
88
+ \ for reasonable and customary use in describing and redistributing the Llama Materials\
89
+ \ or as set forth in this Section 5(a). Meta hereby grants you a license to use\
90
+ \ “Llama” (the “Mark”) solely as required to comply with the last sentence of Section\
91
+ \ 1.b.i. You will comply with Meta’s brand guidelines (currently accessible at\
92
+ \ https://about.meta.com/brand/resources/meta/company-brand/). All goodwill arising\
93
+ \ out of your use of the Mark will inure to the benefit of Meta.\nb. Subject to\
94
+ \ Meta’s ownership of Llama Materials and derivatives made by or for Meta, with\
95
+ \ respect to any derivative works and modifications of the Llama Materials that\
96
+ \ are made by you, as between you and Meta, you are and will be the owner of such\
97
+ \ derivative works and modifications.\nc. If you institute litigation or other proceedings\
98
+ \ against Meta or any entity (including a cross-claim or counterclaim in a lawsuit)\
99
+ \ alleging that the Llama Materials or Llama 3.2 outputs or results, or any portion\
100
+ \ of any of the foregoing, constitutes infringement of intellectual property or\
101
+ \ other rights owned or licensable by you, then any licenses granted to you under\
102
+ \ this Agreement shall terminate as of the date such litigation or claim is filed\
103
+ \ or instituted. You will indemnify and hold harmless Meta from and against any\
104
+ \ claim by any third party arising out of or related to your use or distribution\
105
+ \ of the Llama Materials.\n6. Term and Termination. The term of this Agreement will\
106
+ \ commence upon your acceptance of this Agreement or access to the Llama Materials\
107
+ \ and will continue in full force and effect until terminated in accordance with\
108
+ \ the terms and conditions herein. Meta may terminate this Agreement if you are\
109
+ \ in breach of any term or condition of this Agreement. Upon termination of this\
110
+ \ Agreement, you shall delete and cease use of the Llama Materials. Sections 3,\
111
+ \ 4 and 7 shall survive the termination of this Agreement. \n7. Governing Law and\
112
+ \ Jurisdiction. This Agreement will be governed and construed under the laws of\
113
+ \ the State of California without regard to choice of law principles, and the UN\
114
+ \ Convention on Contracts for the International Sale of Goods does not apply to\
115
+ \ this Agreement. The courts of California shall have exclusive jurisdiction of\
116
+ \ any dispute arising out of this Agreement. \n### Llama 3.2 Acceptable Use Policy\n\
117
+ Meta is committed to promoting safe and fair use of its tools and features, including\
118
+ \ Llama 3.2. If you access or use Llama 3.2, you agree to this Acceptable Use Policy\
119
+ \ (“**Policy**”). The most recent copy of this policy can be found at [https://www.llama.com/llama3_2/use-policy](https://www.llama.com/llama3_2/use-policy).\n\
120
+ #### Prohibited Uses\nWe want everyone to use Llama 3.2 safely and responsibly.\
121
+ \ You agree you will not use, or allow others to use, Llama 3.2 to:\n1. Violate\
122
+ \ the law or others’ rights, including to:\n 1. Engage in, promote, generate,\
123
+ \ contribute to, encourage, plan, incite, or further illegal or unlawful activity\
124
+ \ or content, such as:\n 1. Violence or terrorism\n 2. Exploitation\
125
+ \ or harm to children, including the solicitation, creation, acquisition, or dissemination\
126
+ \ of child exploitative content or failure to report Child Sexual Abuse Material\n\
127
+ \ 3. Human trafficking, exploitation, and sexual violence\n 4. The\
128
+ \ illegal distribution of information or materials to minors, including obscene\
129
+ \ materials, or failure to employ legally required age-gating in connection with\
130
+ \ such information or materials.\n 5. Sexual solicitation\n 6. Any\
131
+ \ other criminal activity\n 1. Engage in, promote, incite, or facilitate the\
132
+ \ harassment, abuse, threatening, or bullying of individuals or groups of individuals\n\
133
+ \ 2. Engage in, promote, incite, or facilitate discrimination or other unlawful\
134
+ \ or harmful conduct in the provision of employment, employment benefits, credit,\
135
+ \ housing, other economic benefits, or other essential goods and services\n 3.\
136
+ \ Engage in the unauthorized or unlicensed practice of any profession including,\
137
+ \ but not limited to, financial, legal, medical/health, or related professional\
138
+ \ practices\n 4. Collect, process, disclose, generate, or infer private or sensitive\
139
+ \ information about individuals, including information about individuals’ identity,\
140
+ \ health, or demographic information, unless you have obtained the right to do so\
141
+ \ in accordance with applicable law\n 5. Engage in or facilitate any action or\
142
+ \ generate any content that infringes, misappropriates, or otherwise violates any\
143
+ \ third-party rights, including the outputs or results of any products or services\
144
+ \ using the Llama Materials\n 6. Create, generate, or facilitate the creation\
145
+ \ of malicious code, malware, computer viruses or do anything else that could disable,\
146
+ \ overburden, interfere with or impair the proper working, integrity, operation\
147
+ \ or appearance of a website or computer system\n 7. Engage in any action, or\
148
+ \ facilitate any action, to intentionally circumvent or remove usage restrictions\
149
+ \ or other safety measures, or to enable functionality disabled by Meta \n2. Engage\
150
+ \ in, promote, incite, facilitate, or assist in the planning or development of activities\
151
+ \ that present a risk of death or bodily harm to individuals, including use of Llama\
152
+ \ 3.2 related to the following:\n 8. Military, warfare, nuclear industries or\
153
+ \ applications, espionage, use for materials or activities that are subject to the\
154
+ \ International Traffic Arms Regulations (ITAR) maintained by the United States\
155
+ \ Department of State or to the U.S. Biological Weapons Anti-Terrorism Act of 1989\
156
+ \ or the Chemical Weapons Convention Implementation Act of 1997\n 9. Guns and\
157
+ \ illegal weapons (including weapon development)\n 10. Illegal drugs and regulated/controlled\
158
+ \ substances\n 11. Operation of critical infrastructure, transportation technologies,\
159
+ \ or heavy machinery\n 12. Self-harm or harm to others, including suicide, cutting,\
160
+ \ and eating disorders\n 13. Any content intended to incite or promote violence,\
161
+ \ abuse, or any infliction of bodily harm to an individual\n3. Intentionally deceive\
162
+ \ or mislead others, including use of Llama 3.2 related to the following:\n 14.\
163
+ \ Generating, promoting, or furthering fraud or the creation or promotion of disinformation\n\
164
+ \ 15. Generating, promoting, or furthering defamatory content, including the\
165
+ \ creation of defamatory statements, images, or other content\n 16. Generating,\
166
+ \ promoting, or further distributing spam\n 17. Impersonating another individual\
167
+ \ without consent, authorization, or legal right\n 18. Representing that the\
168
+ \ use of Llama 3.2 or outputs are human-generated\n 19. Generating or facilitating\
169
+ \ false online engagement, including fake reviews and other means of fake online\
170
+ \ engagement \n4. Fail to appropriately disclose to end users any known dangers\
171
+ \ of your AI system 5. Interact with third party tools, models, or software designed\
172
+ \ to generate unlawful content or engage in unlawful or harmful conduct and/or represent\
173
+ \ that the outputs of such tools, models, or software are associated with Meta or\
174
+ \ Llama 3.2\n\nWith respect to any multimodal models included in Llama 3.2, the\
175
+ \ rights granted under Section 1(a) of the Llama 3.2 Community License Agreement\
176
+ \ are not being granted to you if you are an individual domiciled in, or a company\
177
+ \ with a principal place of business in, the European Union. This restriction does\
178
+ \ not apply to end users of a product or service that incorporates any such multimodal\
179
+ \ models.\n\nPlease report any violation of this Policy, software “bug,” or other\
180
+ \ problems that could lead to a violation of this Policy through one of the following\
181
+ \ means:\n\n* Reporting issues with the model: [https://github.com/meta-llama/llama-models/issues](https://l.workplace.com/l.php?u=https%3A%2F%2Fgithub.com%2Fmeta-llama%2Fllama-models%2Fissues&h=AT0qV8W9BFT6NwihiOHRuKYQM_UnkzN_NmHMy91OT55gkLpgi4kQupHUl0ssR4dQsIQ8n3tfd0vtkobvsEvt1l4Ic6GXI2EeuHV8N08OG2WnbAmm0FL4ObkazC6G_256vN0lN9DsykCvCqGZ)\n\
182
+ * Reporting risky content generated by the model: [developers.facebook.com/llama_output_feedback](http://developers.facebook.com/llama_output_feedback)\n\
183
+ * Reporting bugs and security concerns: [facebook.com/whitehat/info](http://facebook.com/whitehat/info)\n\
184
+ * Reporting violations of the Acceptable Use Policy or unlicensed uses of Llama\
185
+ \ 3.2: LlamaUseReport@meta.com"
186
+ extra_gated_fields:
187
+ First Name: text
188
+ Last Name: text
189
+ Date of birth: date_picker
190
+ Country: country
191
+ Affiliation: text
192
+ Job title:
193
+ type: select
194
+ options:
195
+ - Student
196
+ - Research Graduate
197
+ - AI researcher
198
+ - AI developer/engineer
199
+ - Reporter
200
+ - Other
201
+ geo: ip_location
202
+ ? By clicking Submit below I accept the terms of the license and acknowledge that
203
+ the information I provide will be collected stored processed and shared in accordance
204
+ with the Meta Privacy Policy
205
+ : checkbox
206
+ extra_gated_description: The information you provide will be collected, stored, processed
207
+ and shared in accordance with the [Meta Privacy Policy](https://www.facebook.com/privacy/policy/).
208
+ extra_gated_button_content: Submit
209
+ ---
210
+
211
+ # Solshine/Llama-3.2-3B-Instruct-Q8_0-GGUF
212
+ This model was converted to GGUF format from [`meta-llama/Llama-3.2-3B-Instruct`](https://huggingface.co/meta-llama/Llama-3.2-3B-Instruct) using llama.cpp via the ggml.ai's [GGUF-my-repo](https://huggingface.co/spaces/ggml-org/gguf-my-repo) space.
213
+ Refer to the [original model card](https://huggingface.co/meta-llama/Llama-3.2-3B-Instruct) for more details on the model.
214
+
215
+ ## Use with llama.cpp
216
+ Install llama.cpp through brew (works on Mac and Linux)
217
+
218
+ ```bash
219
+ brew install llama.cpp
220
+
221
+ ```
222
+ Invoke the llama.cpp server or the CLI.
223
+
224
+ ### CLI:
225
+ ```bash
226
+ llama-cli --hf-repo Solshine/Llama-3.2-3B-Instruct-Q8_0-GGUF --hf-file llama-3.2-3b-instruct-q8_0.gguf -p "The meaning to life and the universe is"
227
+ ```
228
+
229
+ ### Server:
230
+ ```bash
231
+ llama-server --hf-repo Solshine/Llama-3.2-3B-Instruct-Q8_0-GGUF --hf-file llama-3.2-3b-instruct-q8_0.gguf -c 2048
232
+ ```
233
+
234
+ Note: You can also use this checkpoint directly through the [usage steps](https://github.com/ggerganov/llama.cpp?tab=readme-ov-file#usage) listed in the Llama.cpp repo as well.
235
+
236
+ Step 1: Clone llama.cpp from GitHub.
237
+ ```
238
+ git clone https://github.com/ggerganov/llama.cpp
239
+ ```
240
+
241
+ Step 2: Move into the llama.cpp folder and build it with `LLAMA_CURL=1` flag along with other hardware-specific flags (for ex: LLAMA_CUDA=1 for Nvidia GPUs on Linux).
242
+ ```
243
+ cd llama.cpp && LLAMA_CURL=1 make
244
+ ```
245
+
246
+ Step 3: Run inference through the main binary.
247
+ ```
248
+ ./llama-cli --hf-repo Solshine/Llama-3.2-3B-Instruct-Q8_0-GGUF --hf-file llama-3.2-3b-instruct-q8_0.gguf -p "The meaning to life and the universe is"
249
+ ```
250
+ or
251
+ ```
252
+ ./llama-server --hf-repo Solshine/Llama-3.2-3B-Instruct-Q8_0-GGUF --hf-file llama-3.2-3b-instruct-q8_0.gguf -c 2048
253
+ ```