IbnAbdeen commited on
Commit
9da6dad
1 Parent(s): 829f55b

Upload README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +177 -0
README.md ADDED
@@ -0,0 +1,177 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ datasets:
3
+ - ClusterlabAi/InstAr-500k
4
+ - CohereForAI/aya_dataset
5
+ language:
6
+ - ar
7
+ tags:
8
+ - causal-lm
9
+ - llama-cpp
10
+ - gguf-my-repo
11
+ extra_gated_prompt: "### STABILITY AI NON-COMMERCIAL RESEARCH COMMUNITY LICENSE AGREEMENT\t\
12
+ \ \n\nDated: November 20, 2024 \n\n**By clicking “I Accept” below or by using or\
13
+ \ distributing any portion or element of the Models, Software, Software Products\
14
+ \ or Derivative Works, you agree to the terms of this License. If you do not agree\
15
+ \ to this License, then you do not have any rights to use the Software Products\
16
+ \ or Derivative Works through this License, and you must immediately cease using\
17
+ \ the Software Products or Derivative Works. If you are agreeing to be bound by\
18
+ \ the terms of this License on behalf of your employer or other entity, you represent\
19
+ \ and warrant to Stability AI that you have full legal authority to bind your employer\
20
+ \ or such entity to this License. If you do not have the requisite authority, you\
21
+ \ may not accept the License or access the Software Products or Derivative Works\
22
+ \ on behalf of your employer or other entity.**\n\n “Agreement“ means this Stable\
23
+ \ Non-Commercial Research Community License Agreement.\n\n“AUP” means the Stability\
24
+ \ AI Acceptable Use Policy available at [https://stability.ai/use-policy](https://stability.ai/use-policy),\
25
+ \ as may be updated from time to time.\n\n“Derivative Work(s)” means (a) any derivative\
26
+ \ work of the Software Products as recognized by U.S. copyright laws, (b) any modifications\
27
+ \ to a Model, and (c) any other model created which is based on or derived from\
28
+ \ the Model or the Model’s output. For clarity, Derivative Works do not include\
29
+ \ the output of any Model.\n\n“Documentation” means any specifications, manuals,\
30
+ \ documentation, and other written information provided by Stability AI related\
31
+ \ to the Software.\n\n “Licensee“ or “you“ means you, or your employer or any other\
32
+ \ person or entity (if you are entering into this Agreement on such person or entity's\
33
+ \ behalf), of the age required under applicable laws, rules or regulations to provide\
34
+ \ legal consent and that has legal authority to bind your employer or such other\
35
+ \ person or entity if you are entering in this Agreement on their behalf.\n\n“Model(s)“\
36
+ \ means, collectively, Stability AI’s proprietary models and algorithms, including\
37
+ \ machine-learning models, trained model weights and other elements of the foregoing,\
38
+ \ made available under this Agreement.\n\n“Non-Commercial Uses” means exercising\
39
+ \ any of the rights granted herein for the purpose of research or non-commercial\
40
+ \ purposes. Non-Commercial Uses does not include any production use of the Software\
41
+ \ Products or any Derivative Works. \n\n“Stability AI“ or “we“ means Stability AI\
42
+ \ Ltd and its affiliates.\n\n“Software“ means Stability AI’s proprietary software\
43
+ \ made available under this Agreement. \n\n“Software Products” means the Models,\
44
+ \ Software and Documentation, individually or in any combination. \n\n**1. License\
45
+ \ Rights and Redistribution.** \na. Subject to your compliance with this Agreement,\
46
+ \ the AUP (which is hereby incorporated herein by reference), and the Documentation,\
47
+ \ Stability AI grants you a non-exclusive, worldwide, non-transferable, non-sublicensable,\
48
+ \ revocable, royalty free and limited license under Stability AI’s intellectual\
49
+ \ property or other rights owned or controlled by Stability AI embodied in the Software\
50
+ \ Products to use, reproduce, distribute, and create Derivative Works of, the Software\
51
+ \ Products, in each case for Non-Commercial Uses only. \n\nb. You may not use the\
52
+ \ Software Products or Derivative Works to enable third parties to use the Software\
53
+ \ Products or Derivative Works as part of your hosted service or via your APIs,\
54
+ \ whether you are adding substantial additional functionality thereto or not. Merely\
55
+ \ distributing the Software Products or Derivative Works for download online without\
56
+ \ offering any related service (ex. by distributing the Models on HuggingFace) is\
57
+ \ not a violation of this subsection. If you wish to use the Software Products or\
58
+ \ any Derivative Works for commercial or production use or you wish to make the\
59
+ \ Software Products or any Derivative Works available to third parties via your\
60
+ \ hosted service or your APIs, contact Stability AI at [https://stability.ai/contact](https://stability.ai/contact).\
61
+ \    \n\nc. If you distribute or make the Software Products, or any Derivative Works\
62
+ \ thereof, available to a third party, the Software Products, Derivative Works,\
63
+ \ or any portion thereof, respectively, will remain subject to this Agreement and\
64
+ \ you must (i) provide a copy of this Agreement to such third party, and (ii) retain\
65
+ \ the following attribution notice within a “Notice“ text file distributed as a\
66
+ \ part of such copies: “This Stability AI Model is licensed under the Stability\
67
+ \ AI Non-Commercial Research Community License, Copyright (c) Stability AI Ltd.\
68
+ \ All Rights Reserved.“ If you create a Derivative Work of a Software Product, you\
69
+ \ may add your own attribution notices to the Notice file included with the Software\
70
+ \ Product, provided that you clearly indicate which attributions apply to the Software\
71
+ \ Product and you must state in the NOTICE file that you changed the Software Product\
72
+ \ and how it was modified.\n\n**2. Disclaimer of Warranty**. UNLESS REQUIRED BY\
73
+ \ APPLICABLE LAW, THE SOFTWARE PRODUCTS  AND ANY OUTPUT AND RESULTS THEREFROM ARE\
74
+ \ PROVIDED ON AN “AS IS“ BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR\
75
+ \ IMPLIED, INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OF TITLE, NON-INFRINGEMENT,\
76
+ \ MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE. YOU ARE SOLELY RESPONSIBLE\
77
+ \ FOR DETERMINING THE APPROPRIATENESS OF USING OR REDISTRIBUTING THE SOFTWARE PRODUCTS,\
78
+ \ DERIVATIVE WORKS OR ANY OUTPUT OR RESULTS AND ASSUME ANY RISKS ASSOCIATED WITH\
79
+ \ YOUR USE OF THE SOFTWARE PRODUCTS, DERIVATIVE WORKS AND ANY OUTPUT AND RESULTS. \n\
80
+ \n**3. Limitation of Liability.** IN NO EVENT WILL STABILITY AI OR ITS AFFILIATES\
81
+ \ BE LIABLE UNDER ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, TORT, NEGLIGENCE,\
82
+ \ PRODUCTS LIABILITY, OR OTHERWISE, ARISING OUT OF THIS AGREEMENT, FOR ANY LOST\
83
+ \ PROFITS OR ANY DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL, INCIDENTAL, EXEMPLARY\
84
+ \ OR PUNITIVE DAMAGES, EVEN IF STABILITY AI OR ITS AFFILIATES HAVE BEEN ADVISED\
85
+ \ OF THE POSSIBILITY OF ANY OF THE FOREGOING. \n\n**4. Intellectual Property.**\n\
86
+ a. No trademark licenses are granted under this Agreement, and in connection with\
87
+ \ the Software Products or Derivative Works, neither Stability AI nor Licensee may\
88
+ \ use any name or mark owned by or associated with the other or any of its affiliates,\
89
+ \ except as required for reasonable and customary use in describing and redistributing\
90
+ \ the Software Products or Derivative Works. \n\nb. Subject to Stability AI’s ownership\
91
+ \ of the Software Products and Derivative Works made by or for Stability AI, with\
92
+ \ respect to any Derivative Works that are made by you, as between you and Stability\
93
+ \ AI, you are and will be the owner of such Derivative Works. \n\nc. If you institute\
94
+ \ litigation or other proceedings against Stability AI (including a cross-claim\
95
+ \ or counterclaim in a lawsuit) alleging that the Software Products, Derivative\
96
+ \ Works or associated outputs or results, or any portion of any of the foregoing,\
97
+ \ constitutes infringement of intellectual property or other rights owned or licensable\
98
+ \ by you, then any licenses granted to you under this Agreement shall terminate\
99
+ \ as of the date such litigation or claim is filed or instituted. You will indemnify\
100
+ \ and hold harmless Stability AI from and against any claim by any third party arising\
101
+ \ out of or related to your use or distribution of the Software Products or Derivative\
102
+ \ Works in violation of this Agreement. \n\n**5. Term and Termination**. The term\
103
+ \ of this Agreement will commence upon your acceptance of this Agreement or access\
104
+ \ to the Software Products and will continue in full force and effect until terminated\
105
+ \ in accordance with the terms and conditions herein. Stability AI may terminate\
106
+ \ this Agreement if you are in breach of any term or condition of this Agreement.\
107
+ \ Upon termination of this Agreement, you shall delete and cease use of any Software\
108
+ \ Products or Derivative Works. Sections 2-4 shall survive the termination of this\
109
+ \ Agreement. \n\n**6. Governing Law.** This Agreement will be governed by and construed\
110
+ \ in accordance with the laws of the United States and the State of California without\
111
+ \ regard to choice of law principles. \n\n [Please learn more about our self-hosted\
112
+ \ Membership options here](https://stability.ai/license)."
113
+ extra_gated_fields:
114
+ Name: text
115
+ Email: text
116
+ Country: text
117
+ Organization or Affiliation: text
118
+ I ALLOW Stability AI to email me about new model releases: checkbox
119
+ ? By clicking here, you accept the License agreement, and will use the Software
120
+ Products and Derivative Works for non-commercial or research purposes only A commercial
121
+ license is required to self-host the Software Products for commercial purposes,
122
+ (Please learn more about our self-hosted Membership options on our website linked
123
+ above)
124
+ : checkbox
125
+ ? By clicking here, you agree to sharing with Stability AI the information contained
126
+ within this form and that Stability AI can contact you for the purposes of marketing
127
+ our products and services Yes, I consent to receiving Stability AI marketing communications
128
+ : checkbox
129
+ extra_gated_button_content: Submit
130
+ license:
131
+ - other
132
+ base_model: stabilityai/ar-stablelm-2-chat
133
+ ---
134
+
135
+ # IbnAbdeen/ar-stablelm-2-chat-Q4_K_M-GGUF
136
+ This model was converted to GGUF format from [`stabilityai/ar-stablelm-2-chat`](https://huggingface.co/stabilityai/ar-stablelm-2-chat) using llama.cpp via the ggml.ai's [GGUF-my-repo](https://huggingface.co/spaces/ggml-org/gguf-my-repo) space.
137
+ Refer to the [original model card](https://huggingface.co/stabilityai/ar-stablelm-2-chat) for more details on the model.
138
+
139
+ ## Use with llama.cpp
140
+ Install llama.cpp through brew (works on Mac and Linux)
141
+
142
+ ```bash
143
+ brew install llama.cpp
144
+
145
+ ```
146
+ Invoke the llama.cpp server or the CLI.
147
+
148
+ ### CLI:
149
+ ```bash
150
+ llama-cli --hf-repo IbnAbdeen/ar-stablelm-2-chat-Q4_K_M-GGUF --hf-file ar-stablelm-2-chat-q4_k_m.gguf -p "The meaning to life and the universe is"
151
+ ```
152
+
153
+ ### Server:
154
+ ```bash
155
+ llama-server --hf-repo IbnAbdeen/ar-stablelm-2-chat-Q4_K_M-GGUF --hf-file ar-stablelm-2-chat-q4_k_m.gguf -c 2048
156
+ ```
157
+
158
+ 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.
159
+
160
+ Step 1: Clone llama.cpp from GitHub.
161
+ ```
162
+ git clone https://github.com/ggerganov/llama.cpp
163
+ ```
164
+
165
+ 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).
166
+ ```
167
+ cd llama.cpp && LLAMA_CURL=1 make
168
+ ```
169
+
170
+ Step 3: Run inference through the main binary.
171
+ ```
172
+ ./llama-cli --hf-repo IbnAbdeen/ar-stablelm-2-chat-Q4_K_M-GGUF --hf-file ar-stablelm-2-chat-q4_k_m.gguf -p "The meaning to life and the universe is"
173
+ ```
174
+ or
175
+ ```
176
+ ./llama-server --hf-repo IbnAbdeen/ar-stablelm-2-chat-Q4_K_M-GGUF --hf-file ar-stablelm-2-chat-q4_k_m.gguf -c 2048
177
+ ```