aifeifei798 commited on
Commit
9348713
1 Parent(s): ec7ab03

Upload README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +171 -0
README.md ADDED
@@ -0,0 +1,171 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ base_model: facebook/llm-compiler-7b-ftd
3
+ license: other
4
+ tags:
5
+ - llama-cpp
6
+ - gguf-my-repo
7
+ extra_gated_prompt: "**Meta Large Language Model Compiler (LLM Compiler) LICENSE AGREEMENT**\n\
8
+ Version Release Date: 27th June 2024\n“**Agreement**” means the terms and conditions\
9
+ \ for use, reproduction, distribution and modification of the LLM Compiler Materials\
10
+ \ set forth herein.\n“**Documentation**” means the specifications, manuals and documentation\
11
+ \ accompanying the LLM Compiler distributed by Meta at:\n* [https://huggingface.co/facebook/llm-compiler-7b](https://huggingface.co/facebook/llm-compiler-7b)\
12
+ \ * [https://huggingface.co/facebook/llm-compiler-7b-ftd](https://huggingface.co/facebook/llm-compiler-7b-ftd)\
13
+ \ * [https://huggingface.co/facebook/llm-compiler-13b](https://huggingface.co/facebook/llm-compiler-13b)\
14
+ \ * [https://huggingface.co/facebook/llm-compiler-13b-ftd](https://huggingface.co/facebook/llm-compiler-13b-ftd)\n\
15
+ “**Licensee**” or “**you**” means you, or your employer or any other person or entity\
16
+ \ (if you are entering into this Agreement on such person or entity’s behalf), of\
17
+ \ the age required under applicable laws, rules or regulations to provide legal\
18
+ \ consent and that has legal authority to bind your employer or such other person\
19
+ \ or entity if you are entering in this Agreement on their behalf.\n“**Meta Large\
20
+ \ Language Model Compiler” and “LLM Compiler**” mean the foundational large language\
21
+ \ models and software and algorithms, including machine-learning model code, trained\
22
+ \ model weights, inference-enabling code, training-enabling code, fine-tuning enabling\
23
+ \ code and other elements of the foregoing distributed by Meta at:\n* [https://huggingface.co/facebook/llm-compiler-7b](https://huggingface.co/facebook/llm-compiler-7b)\
24
+ \ * [https://huggingface.co/facebook/llm-compiler-7b-ftd](https://huggingface.co/facebook/llm-compiler-7b-ftd)\
25
+ \ * [https://huggingface.co/facebook/llm-compiler-13b](https://huggingface.co/facebook/llm-compiler-13b)\
26
+ \ * [https://huggingface.co/facebook/llm-compiler-13b-ftd](https://huggingface.co/facebook/llm-compiler-13b-ftd)\n\
27
+ “**LLM Compiler Materials**” means, collectively, Meta’s proprietary LLM Compiler\
28
+ \ and Documentation (and any portion thereof) made available under this Agreement.\n\
29
+ “**Meta**” or “**we**” means Meta Platforms Ireland Limited (if you are located\
30
+ \ in or, if you are an entity, your principal place of business is in the EEA or\
31
+ \ Switzerland) and Meta Platforms, Inc. (if you are located outside of the EEA or\
32
+ \ Switzerland). \nBy clicking “I Accept” below or by using or distributing any portion\
33
+ \ or element of the LLM Compiler Materials, you agree to be bound by this Agreement.\n\
34
+ 1. **License Rights and Redistribution**. \\\n\n a. <span style=\"text-decoration:underline;\"\
35
+ >Grant of Rights</span>. You are granted a non-exclusive, worldwide, non-transferable\
36
+ \ and royalty-free limited license under Meta’s intellectual property or other rights\
37
+ \ owned by Meta embodied in the LLM Compiler Materials to use, reproduce, distribute,\
38
+ \ copy, create derivative works of, and make modifications to the LLM Compiler Materials.\
39
+ \ \n\n b. <span style=\"text-decoration:underline;\">Redistribution and Use</span>.\
40
+ \ \n\n i. If you distribute or make available the LLM Compiler Materials (or\
41
+ \ any derivative works thereof), or a product or service that uses any of them,\
42
+ \ including another AI model, you shall (A) provide a copy of this Agreement with\
43
+ \ any such LLM Compiler Materials; and (B) prominently display “Built with LLM Compiler”\
44
+ \ on a related website, user interface, blogpost, about page, or product documentation.\
45
+ \ If you use the LLM Compiler Materials to create, train, fine tune, or otherwise\
46
+ \ improve an AI model, which is distributed or made available, you shall also include\
47
+ \ “LLM Compiler” at the beginning of any such AI model name.\n\n ii. If you receive\
48
+ \ LLM Compiler Materials, or any derivative works thereof, from a Licensee as part\
49
+ \ of an integrated end user product, then Section 2 of this Agreement will not apply\
50
+ \ to you. \n\n iii. You must retain in all copies of the LLM Compiler Materials\
51
+ \ that you distribute the following attribution notice within a “Notice” text file\
52
+ \ distributed as a part of such copies: “LLM Compiler is licensed under the LLM\
53
+ \ Compiler License, Copyright © Meta Platforms, Inc. All Rights Reserved.”\n\n \
54
+ \ iv. Your use of the LLM Compiler Materials must comply with applicable laws\
55
+ \ and regulations (including trade compliance laws and regulations) and adhere to\
56
+ \ the Acceptable Use Policy for Llama Materials (available at https://llama.meta.com/llama3/use-policy),\
57
+ \ which is hereby incorporated by reference into this Agreement.\n\n v. You will\
58
+ \ not use the LLM Compiler Materials or any output or results of the LLM Compiler\
59
+ \ Materials to improve any other large language model. \n\n2. **Additional Commercial\
60
+ \ Terms**. If, on the LLM Compiler release date, the monthly active users of the\
61
+ \ products or services made available by or for Licensee, or Licensee’s affiliates,\
62
+ \ is greater than 700 million monthly active users in the preceding calendar month,\
63
+ \ you must request a license from Meta, which Meta may grant to you in its sole\
64
+ \ discretion, and you are not authorized to exercise any of the rights under this\
65
+ \ Agreement unless or until Meta otherwise expressly grants you such rights. \n\
66
+ 3**. Disclaimer of Warranty**. UNLESS REQUIRED BY APPLICABLE LAW, THE LLM COMPILER\
67
+ \ MATERIALS AND ANY OUTPUT AND RESULTS THEREFROM ARE PROVIDED ON AN “AS IS” BASIS,\
68
+ \ WITHOUT WARRANTIES OF ANY KIND, AND META DISCLAIMS ALL WARRANTIES OF ANY KIND,\
69
+ \ BOTH EXPRESS AND IMPLIED, INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OF TITLE,\
70
+ \ NON-INFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE. YOU ARE\
71
+ \ SOLELY RESPONSIBLE FOR DETERMINING THE APPROPRIATENESS OF USING OR REDISTRIBUTING\
72
+ \ THE LLM COMPILER MATERIALS AND ASSUME ANY RISKS ASSOCIATED WITH YOUR USE OF THE\
73
+ \ LLM COMPILER MATERIALS AND ANY OUTPUT AND RESULTS.\n4. **Limitation of Liability**.\
74
+ \ IN NO EVENT WILL META OR ITS AFFILIATES BE LIABLE UNDER ANY THEORY OF LIABILITY,\
75
+ \ WHETHER IN CONTRACT, TORT, NEGLIGENCE, PRODUCTS LIABILITY, OR OTHERWISE, ARISING\
76
+ \ OUT OF THIS AGREEMENT, FOR ANY LOST PROFITS OR ANY INDIRECT, SPECIAL, CONSEQUENTIAL,\
77
+ \ INCIDENTAL, EXEMPLARY OR PUNITIVE DAMAGES, EVEN IF META OR ITS AFFILIATES HAVE\
78
+ \ BEEN ADVISED OF THE POSSIBILITY OF ANY OF THE FOREGOING.\n5. **Intellectual Property**.\n\
79
+ \n a. No trademark licenses are granted under this Agreement, and in connection\
80
+ \ with the LLM Compiler Materials, neither Meta nor Licensee may use any name or\
81
+ \ mark owned by or associated with the other or any of its affiliates, except as\
82
+ \ required for reasonable and customary use in describing and redistributing the\
83
+ \ LLM Compiler Materials or as set forth in this Section 5(a). Meta hereby grants\
84
+ \ you a license to use LLM Compiler (the “Mark”) solely as required to comply with\
85
+ \ the last sentence of Section 1.b.i. You will comply with Meta’s brand guidelines\
86
+ \ (currently accessible at[ https://about.meta.com/brand/resources/meta/company-brand/)](https://about.meta.com/brand/resources/meta/company-brand/).\
87
+ \ All goodwill arising out of your use of the Mark will inure to the benefit of\
88
+ \ Meta. \n\n b. Subject to Meta’s ownership of LLM Compiler Materials and derivatives\
89
+ \ made by or for Meta, with respect to any derivative works and modifications of\
90
+ \ the LLM Compiler Materials that are made by you, as between you and Meta, you\
91
+ \ are and will be the owner of such derivative works and modifications.\n\n c.\
92
+ \ If you institute litigation or other proceedings against Meta or any entity (including\
93
+ \ a cross-claim or counterclaim in a lawsuit) alleging that the LLM Compiler Materials\
94
+ \ or LLM Compiler outputs or results, or any portion of any of the foregoing, constitutes\
95
+ \ infringement of intellectual property or other rights owned or licensable by you,\
96
+ \ then any licenses granted to you under this Agreement shall terminate as of the\
97
+ \ date such litigation or claim is filed or instituted. You will indemnify and hold\
98
+ \ harmless Meta from and against any claim by any third party arising out of or\
99
+ \ related to your use or distribution of the LLM Compiler Materials.\n\n6. **Term\
100
+ \ and Termination**. The term of this Agreement will commence upon your acceptance\
101
+ \ of this Agreement or access to the LLM Compiler Materials and will continue in\
102
+ \ full force and effect until terminated in accordance with the terms and conditions\
103
+ \ herein. Meta may terminate this Agreement if you are in breach of any term or\
104
+ \ condition of this Agreement. Upon termination of this Agreement, you shall delete\
105
+ \ and cease use of the LLM Compiler Materials. Sections 3, 4 and 7 shall survive\
106
+ \ the termination of this Agreement. \n7. **Governing Law and Jurisdiction**. This\
107
+ \ Agreement will be governed and construed under the laws of the State of California\
108
+ \ without regard to choice of law principles, and the UN Convention on Contracts\
109
+ \ for the International Sale of Goods does not apply to this Agreement. The courts\
110
+ \ of California shall have exclusive jurisdiction of any dispute arising out of\
111
+ \ this Agreement. "
112
+ extra_gated_fields:
113
+ First Name: text
114
+ Last Name: text
115
+ Date of birth: date_picker
116
+ Country: country
117
+ Affiliation: text
118
+ I accept the terms and conditions: checkbox
119
+ geo: ip_location
120
+ ? By clicking Submit below I accept the terms of the license and acknowledge that
121
+ the information I provide will be collected stored processed and shared in accordance
122
+ with the Meta Privacy Policy
123
+ : checkbox
124
+ extra_gated_description: The information you provide will be collected, stored, processed
125
+ and shared in accordance with the [Meta Privacy Policy](https://www.facebook.com/privacy/policy/).
126
+ extra_gated_button_content: I Accept Meta LLM Compiler License and AUP
127
+ ---
128
+
129
+ # aifeifei798/llm-compiler-7b-ftd-Q5_K_M-GGUF
130
+ This model was converted to GGUF format from [`facebook/llm-compiler-7b-ftd`](https://huggingface.co/facebook/llm-compiler-7b-ftd) using llama.cpp via the ggml.ai's [GGUF-my-repo](https://huggingface.co/spaces/ggml-org/gguf-my-repo) space.
131
+ Refer to the [original model card](https://huggingface.co/facebook/llm-compiler-7b-ftd) for more details on the model.
132
+
133
+ ## Use with llama.cpp
134
+ Install llama.cpp through brew (works on Mac and Linux)
135
+
136
+ ```bash
137
+ brew install llama.cpp
138
+
139
+ ```
140
+ Invoke the llama.cpp server or the CLI.
141
+
142
+ ### CLI:
143
+ ```bash
144
+ llama-cli --hf-repo aifeifei798/llm-compiler-7b-ftd-Q5_K_M-GGUF --hf-file llm-compiler-7b-ftd-q5_k_m.gguf -p "The meaning to life and the universe is"
145
+ ```
146
+
147
+ ### Server:
148
+ ```bash
149
+ llama-server --hf-repo aifeifei798/llm-compiler-7b-ftd-Q5_K_M-GGUF --hf-file llm-compiler-7b-ftd-q5_k_m.gguf -c 2048
150
+ ```
151
+
152
+ 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.
153
+
154
+ Step 1: Clone llama.cpp from GitHub.
155
+ ```
156
+ git clone https://github.com/ggerganov/llama.cpp
157
+ ```
158
+
159
+ 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).
160
+ ```
161
+ cd llama.cpp && LLAMA_CURL=1 make
162
+ ```
163
+
164
+ Step 3: Run inference through the main binary.
165
+ ```
166
+ ./llama-cli --hf-repo aifeifei798/llm-compiler-7b-ftd-Q5_K_M-GGUF --hf-file llm-compiler-7b-ftd-q5_k_m.gguf -p "The meaning to life and the universe is"
167
+ ```
168
+ or
169
+ ```
170
+ ./llama-server --hf-repo aifeifei798/llm-compiler-7b-ftd-Q5_K_M-GGUF --hf-file llm-compiler-7b-ftd-q5_k_m.gguf -c 2048
171
+ ```