Upload README.md with huggingface_hub
Browse files
README.md
ADDED
|
@@ -0,0 +1,229 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
license: other
|
| 3 |
+
license_name: fair-noncommercial-research
|
| 4 |
+
extra_gated_prompt: "FAIR Noncommercial Research License v1 Last Updated: August 18,\
|
| 5 |
+
\ 2025\n“Acceptable Use Policy” means the FAIR Acceptable Use Policy, applicable\
|
| 6 |
+
\ to Research Materials, that is incorporated into this Agreement.\n“Agreement”\
|
| 7 |
+
\ means the terms and conditions for use, reproduction, distribution and modification\
|
| 8 |
+
\ of the Research Materials set forth herein.\n\n“Documentation” means the specifications,\
|
| 9 |
+
\ manuals and documentation accompanying Research Materials distributed by Meta.\n\
|
| 10 |
+
\n“Licensee” or “you” means you, or your employer or any other person or entity\
|
| 11 |
+
\ (if you are entering into this Agreement on such person or entity’s behalf), of\
|
| 12 |
+
\ the age required under applicable laws, rules or regulations to provide legal\
|
| 13 |
+
\ consent and that has legal authority to bind your employer or such other person\
|
| 14 |
+
\ or entity if you are entering in this Agreement on their behalf.\n\n“Meta” or\
|
| 15 |
+
\ “we” means Meta Platforms Ireland Limited (if you are located in or, if you are\
|
| 16 |
+
\ an entity, your principal place of business is in the EEA or Switzerland) and\
|
| 17 |
+
\ Meta Platforms, Inc. (if you are located outside of the EEA or Switzerland).\n\
|
| 18 |
+
“Noncommercial Research Uses” means noncommercial research use cases related to\
|
| 19 |
+
\ research, development, education, processing, or analysis and in each case, is\
|
| 20 |
+
\ not primarily intended for commercial advantage or monetary compensation to you\
|
| 21 |
+
\ or others.\n“Research Materials” means, collectively, Documentation and the models,\
|
| 22 |
+
\ software and algorithms, including machine-learning model code, trained model\
|
| 23 |
+
\ weights, inference-enabling code, training-enabling code, fine-tuning enabling\
|
| 24 |
+
\ code, demonstration materials and other elements of the foregoing distributed\
|
| 25 |
+
\ by Meta and made available under this Agreement.\nBy clicking “I Accept” below\
|
| 26 |
+
\ or by using or distributing any portion or element of the Research Materials,\
|
| 27 |
+
\ you agree to be bound by this Agreement.\n\n1. License Rights and Redistribution.\n\
|
| 28 |
+
\na. Grant of Rights. You are granted a non-exclusive, worldwide, non-transferable\
|
| 29 |
+
\ and royalty-free limited license under Meta’s intellectual property or other rights\
|
| 30 |
+
\ owned by Meta embodied in the Research Materials to use, reproduce, distribute,\
|
| 31 |
+
\ copy, create derivative works of, and make modifications to the Research Materials.\
|
| 32 |
+
\ \nb. Redistribution and Use. i. You will not use the Research Materials or\
|
| 33 |
+
\ any outputs or results of the Research Materials in connection with any commercial\
|
| 34 |
+
\ uses or for any uses other than Noncommercial Research Uses;\n\nii. Distribution\
|
| 35 |
+
\ of Research Materials, and any derivative works thereof, are subject to the terms\
|
| 36 |
+
\ of this Agreement. If you distribute or make the Research Materials, or any derivative\
|
| 37 |
+
\ works thereof, available to a third party, you may only do so under the terms\
|
| 38 |
+
\ of this Agreement. You shall also provide a copy of this Agreement to such third\
|
| 39 |
+
\ party.\n\niii. If you submit for publication the results of research you perform\
|
| 40 |
+
\ on, using, or otherwise in connection with Research Materials, you must acknowledge\
|
| 41 |
+
\ the use of Research Materials in your publication.\n\niv. Your use of the Research\
|
| 42 |
+
\ Materials must comply with applicable laws and regulations (including Trade Control\
|
| 43 |
+
\ Laws) and adhere to the FAIR Acceptable Use Policy, which is hereby incorporated\
|
| 44 |
+
\ by reference into this Agreement. 2. User Support. Your Noncommercial Research\
|
| 45 |
+
\ Use of the Research Materials is done at your own discretion; Meta does not process\
|
| 46 |
+
\ any information nor provide any service in relation to such use. Meta is under\
|
| 47 |
+
\ no obligation to provide any support services for the Research Materials. Any\
|
| 48 |
+
\ support provided is “as is”, “with all faults”, and without warranty of any kind.\n\
|
| 49 |
+
\n3. Disclaimer of Warranty. UNLESS REQUIRED BY APPLICABLE LAW, THE RESEARCH MATERIALS\
|
| 50 |
+
\ AND ANY OUTPUT AND RESULTS THEREFROM ARE PROVIDED ON AN “AS IS” BASIS, WITHOUT\
|
| 51 |
+
\ WARRANTIES OF ANY KIND, AND META DISCLAIMS ALL WARRANTIES OF ANY KIND, BOTH EXPRESS\
|
| 52 |
+
\ AND IMPLIED, INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OF TITLE, NON-INFRINGEMENT,\
|
| 53 |
+
\ MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE. YOU ARE SOLELY RESPONSIBLE\
|
| 54 |
+
\ FOR DETERMINING THE APPROPRIATENESS OF USING OR REDISTRIBUTING THE RESEARCH MATERIALS\
|
| 55 |
+
\ AND ASSUME ANY RISKS ASSOCIATED WITH YOUR USE OF THE RESEARCH MATERIALS AND ANY\
|
| 56 |
+
\ OUTPUT AND RESULTS.\n4. Limitation of Liability. IN NO EVENT WILL META OR ITS\
|
| 57 |
+
\ AFFILIATES BE LIABLE UNDER ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, TORT,\
|
| 58 |
+
\ NEGLIGENCE, PRODUCTS LIABILITY, OR OTHERWISE, ARISING OUT OF THIS AGREEMENT, FOR\
|
| 59 |
+
\ ANY LOST PROFITS OR ANY DIRECT OR INDIRECT, SPECIAL, CONSEQUENTIAL, INCIDENTAL,\
|
| 60 |
+
\ EXEMPLARY OR PUNITIVE DAMAGES, EVEN IF META OR ITS AFFILIATES HAVE BEEN ADVISED\
|
| 61 |
+
\ OF THE POSSIBILITY OF ANY OF THE FOREGOING.\n5. Intellectual Property.\n\na. Subject\
|
| 62 |
+
\ to Meta’s ownership of Research Materials and derivatives made by or for Meta,\
|
| 63 |
+
\ with respect to any derivative works and modifications of the Research Materials\
|
| 64 |
+
\ that are made by you, as between you and Meta, you are and will be the owner of\
|
| 65 |
+
\ such derivative works and modifications.\nb. If you institute litigation or other\
|
| 66 |
+
\ proceedings against Meta or any entity (including a cross-claim or counterclaim\
|
| 67 |
+
\ in a lawsuit) alleging that the Research Materials, outputs or results, or any\
|
| 68 |
+
\ portion of any of the foregoing, constitutes infringement of intellectual property\
|
| 69 |
+
\ or other rights owned or licensable by you, then any licenses granted to you under\
|
| 70 |
+
\ this Agreement shall terminate as of the date such litigation or claim is filed\
|
| 71 |
+
\ or instituted. You will indemnify and hold harmless Meta from and against any\
|
| 72 |
+
\ claim by any third party arising out of or related to your use or distribution\
|
| 73 |
+
\ of the Research Materials.\n6. Term and Termination. The term of this Agreement\
|
| 74 |
+
\ will commence upon your acceptance of this Agreement or access to the Research\
|
| 75 |
+
\ Materials and will continue in full force and effect until terminated in accordance\
|
| 76 |
+
\ with the terms and conditions herein. Meta may terminate this Agreement if you\
|
| 77 |
+
\ are in breach of any term or condition of this Agreement. Upon termination of\
|
| 78 |
+
\ this Agreement, you shall delete and cease use of the Research Materials. Sections\
|
| 79 |
+
\ 3, 4 and 7 shall survive the termination of this Agreement. \n7. Governing Law\
|
| 80 |
+
\ and Jurisdiction. This Agreement will be governed and construed under the laws\
|
| 81 |
+
\ of the State of California without regard to choice of law principles, and the\
|
| 82 |
+
\ UN Convention on Contracts for the International Sale of Goods does not apply\
|
| 83 |
+
\ to this Agreement. The courts of California shall have exclusive jurisdiction\
|
| 84 |
+
\ of any dispute arising out of this Agreement. \n\n8. Modifications and Amendments.\
|
| 85 |
+
\ Meta may modify this Agreement from time to time; provided that they are similar\
|
| 86 |
+
\ in spirit to the current version of the Agreement, but may differ in detail to\
|
| 87 |
+
\ address new problems or concerns. All such changes will be effective immediately.\
|
| 88 |
+
\ Your continued use of the Research Materials after any modification to this Agreement\
|
| 89 |
+
\ constitutes your agreement to such modification. Except as provided in this Agreement,\
|
| 90 |
+
\ no modification or addition to any provision of this Agreement will be binding\
|
| 91 |
+
\ unless it is in writing and signed by an authorized representative of both you\
|
| 92 |
+
\ and Meta.\n\nFAIR Acceptable Use Policy \nThe Fundamental AI Research (FAIR) team\
|
| 93 |
+
\ at Meta seeks to further understanding of new and existing research domains with\
|
| 94 |
+
\ the mission of advancing the state-of-the-art in artificial intelligence through\
|
| 95 |
+
\ open research for the benefit of all. \nAs part of this mission, Meta makes certain\
|
| 96 |
+
\ research materials available for noncommercial research use. Meta is committed\
|
| 97 |
+
\ to promoting the safe and responsible use of such research materials. \nProhibited\
|
| 98 |
+
\ Uses\nYou agree you will not use, or allow others to use, Research Materials to:\n\
|
| 99 |
+
Violate the law or others’ rights, including to: Engage in, promote, generate, contribute\
|
| 100 |
+
\ to, encourage, plan, incite, or further illegal or unlawful activity or content,\
|
| 101 |
+
\ such as: Violence or terrorism Exploitation or harm to children, including the\
|
| 102 |
+
\ solicitation, creation, acquisition, or dissemination of child exploitative content\
|
| 103 |
+
\ or failure to report Child Sexual Abuse Material Human trafficking, exploitation,\
|
| 104 |
+
\ and sexual violence The illegal distribution of information or materials to minors,\
|
| 105 |
+
\ including obscene materials, or failure to employ legally required age-gating\
|
| 106 |
+
\ in connection with such information or materials. Sexual solicitation Any other\
|
| 107 |
+
\ criminal activity\nEngage in, promote, incite, or facilitate the harassment, abuse,\
|
| 108 |
+
\ threatening, or bullying of individuals or groups of individuals\nEngage in, promote,\
|
| 109 |
+
\ incite, or facilitate discrimination or other unlawful or harmful conduct in the\
|
| 110 |
+
\ provision of employment, employment benefits, credit, housing, other economic\
|
| 111 |
+
\ benefits, or other essential goods and services\nEngage in the unauthorized or\
|
| 112 |
+
\ unlicensed practice of any profession including, but not limited to, financial,\
|
| 113 |
+
\ legal, medical/health, or related professional practices\nCollect, process, disclose,\
|
| 114 |
+
\ generate, or infer health, demographic, or other sensitive personal or private\
|
| 115 |
+
\ information about individuals without rights and consents required by applicable\
|
| 116 |
+
\ laws\nEngage in or facilitate any action or generate any content that infringes,\
|
| 117 |
+
\ misappropriates, or otherwise violates any third-party rights, including the outputs\
|
| 118 |
+
\ or results of any technology using FAIR research materials\nCreate, generate,\
|
| 119 |
+
\ or facilitate the creation of malicious code, malware, computer viruses or do\
|
| 120 |
+
\ anything else that could disable, overburden, interfere with or impair the proper\
|
| 121 |
+
\ working, integrity, operation or appearance of a website or computer system\n\
|
| 122 |
+
2. Engage in, promote, incite, facilitate, or assist in the planning or development\
|
| 123 |
+
\ of activities that present a risk of death or bodily harm to individuals, including\
|
| 124 |
+
\ use of research artifacts related to the following:\nMilitary, warfare, nuclear\
|
| 125 |
+
\ industries or applications, espionage, use for materials or activities that are\
|
| 126 |
+
\ subject to the International Traffic Arms Regulations (ITAR) maintained by the\
|
| 127 |
+
\ United States Department of State\nGuns and illegal weapons (including weapon\
|
| 128 |
+
\ development)\nIllegal drugs and regulated/controlled substances\nOperation of\
|
| 129 |
+
\ critical infrastructure, transportation technologies, or heavy machinery\nSelf-harm\
|
| 130 |
+
\ or harm to others, including suicide, cutting, and eating disorders\nAny content\
|
| 131 |
+
\ intended to incite or promote violence, abuse, or any infliction of bodily harm\
|
| 132 |
+
\ to an individual\n3. Intentionally deceive or mislead others, including use of\
|
| 133 |
+
\ FAIR Research Materials related to the following:\nGenerating, promoting, or furthering\
|
| 134 |
+
\ fraud or the creation or promotion of disinformation\nGenerating, promoting, or\
|
| 135 |
+
\ furthering defamatory content, including the creation of defamatory statements,\
|
| 136 |
+
\ images, or other content\nGenerating, promoting, or further distributing spam\n\
|
| 137 |
+
Impersonating another individual without consent, authorization, or legal right\n\
|
| 138 |
+
Representing that outputs of FAIR research materials or outputs from technology\
|
| 139 |
+
\ using FAIR research materials are human-generated\nGenerating or facilitating\
|
| 140 |
+
\ false online engagement, including fake reviews and other means of fake online\
|
| 141 |
+
\ engagement\n4. Fail to appropriately disclose to end users any known dangers of\
|
| 142 |
+
\ your Research Materials.\nPlease report any violation of this Policy or other\
|
| 143 |
+
\ problems that could lead to a violation of this Policy by submitting a report\
|
| 144 |
+
\ here [https://docs.google.com/forms/d/e/1FAIpQLSeb11cryAopJ7LNrC4nxEUXrHY26hfkXQMf_uH-oFgA3WlYZQ/viewform].\
|
| 145 |
+
\ \n"
|
| 146 |
+
extra_gated_fields:
|
| 147 |
+
First Name: text
|
| 148 |
+
Last Name: text
|
| 149 |
+
Date of birth: date_picker
|
| 150 |
+
Country: country
|
| 151 |
+
Affiliation: text
|
| 152 |
+
Job title:
|
| 153 |
+
type: select
|
| 154 |
+
options:
|
| 155 |
+
- Student
|
| 156 |
+
- Research Graduate
|
| 157 |
+
- AI researcher
|
| 158 |
+
- AI developer/engineer
|
| 159 |
+
- Reporter
|
| 160 |
+
- Other
|
| 161 |
+
geo: ip_location
|
| 162 |
+
? By clicking Submit below I accept the terms of the license and acknowledge that
|
| 163 |
+
the information I provide will be collected stored processed and shared in accordance
|
| 164 |
+
with the Meta Privacy Policy
|
| 165 |
+
: checkbox
|
| 166 |
+
extra_gated_description: The information you provide will be collected, stored, processed
|
| 167 |
+
and shared in accordance with the [Meta Privacy Policy](https://www.facebook.com/privacy/policy/).
|
| 168 |
+
extra_gated_button_content: Submit
|
| 169 |
+
extra_gated_heading: Please be sure to provide your full legal name, date of birth,
|
| 170 |
+
and full organization name with all corporate identifiers. Avoid the use of acronyms
|
| 171 |
+
and special characters. Failure to follow these instructions may prevent you from
|
| 172 |
+
accessing this model and others on Hugging Face. You will not have the ability to
|
| 173 |
+
edit this form after submission, so please ensure all information is accurate.
|
| 174 |
+
language:
|
| 175 |
+
- en
|
| 176 |
+
library_name: transformers
|
| 177 |
+
tags:
|
| 178 |
+
- facebook
|
| 179 |
+
- meta
|
| 180 |
+
- pytorch
|
| 181 |
+
- mobilellm
|
| 182 |
+
- llama-cpp
|
| 183 |
+
- gguf-my-repo
|
| 184 |
+
base_model: facebook/MobileLLM-R1-140M
|
| 185 |
+
---
|
| 186 |
+
|
| 187 |
+
# DarqueDante/MobileLLM-R1-140M-Q8_0-GGUF
|
| 188 |
+
This model was converted to GGUF format from [`facebook/MobileLLM-R1-140M`](https://huggingface.co/facebook/MobileLLM-R1-140M) using llama.cpp via the ggml.ai's [GGUF-my-repo](https://huggingface.co/spaces/ggml-org/gguf-my-repo) space.
|
| 189 |
+
Refer to the [original model card](https://huggingface.co/facebook/MobileLLM-R1-140M) for more details on the model.
|
| 190 |
+
|
| 191 |
+
## Use with llama.cpp
|
| 192 |
+
Install llama.cpp through brew (works on Mac and Linux)
|
| 193 |
+
|
| 194 |
+
```bash
|
| 195 |
+
brew install llama.cpp
|
| 196 |
+
|
| 197 |
+
```
|
| 198 |
+
Invoke the llama.cpp server or the CLI.
|
| 199 |
+
|
| 200 |
+
### CLI:
|
| 201 |
+
```bash
|
| 202 |
+
llama-cli --hf-repo DarqueDante/MobileLLM-R1-140M-Q8_0-GGUF --hf-file mobilellm-r1-140m-q8_0.gguf -p "The meaning to life and the universe is"
|
| 203 |
+
```
|
| 204 |
+
|
| 205 |
+
### Server:
|
| 206 |
+
```bash
|
| 207 |
+
llama-server --hf-repo DarqueDante/MobileLLM-R1-140M-Q8_0-GGUF --hf-file mobilellm-r1-140m-q8_0.gguf -c 2048
|
| 208 |
+
```
|
| 209 |
+
|
| 210 |
+
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.
|
| 211 |
+
|
| 212 |
+
Step 1: Clone llama.cpp from GitHub.
|
| 213 |
+
```
|
| 214 |
+
git clone https://github.com/ggerganov/llama.cpp
|
| 215 |
+
```
|
| 216 |
+
|
| 217 |
+
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).
|
| 218 |
+
```
|
| 219 |
+
cd llama.cpp && LLAMA_CURL=1 make
|
| 220 |
+
```
|
| 221 |
+
|
| 222 |
+
Step 3: Run inference through the main binary.
|
| 223 |
+
```
|
| 224 |
+
./llama-cli --hf-repo DarqueDante/MobileLLM-R1-140M-Q8_0-GGUF --hf-file mobilellm-r1-140m-q8_0.gguf -p "The meaning to life and the universe is"
|
| 225 |
+
```
|
| 226 |
+
or
|
| 227 |
+
```
|
| 228 |
+
./llama-server --hf-repo DarqueDante/MobileLLM-R1-140M-Q8_0-GGUF --hf-file mobilellm-r1-140m-q8_0.gguf -c 2048
|
| 229 |
+
```
|