Safetensors
Arabic
stablelm_epoch
causal-lm
custom_code
ar-stablelm-2-chat / README.md
Zaid's picture
add citation
da8a245 verified
metadata
datasets:
  - ClusterlabAi/InstAr-500k
  - CohereForAI/aya_dataset
language:
  - ar
tags:
  - causal-lm
extra_gated_prompt: "### STABILITY AI NON-COMMERCIAL RESEARCH COMMUNITY LICENSE AGREEMENT\t  \n\nDated: November 20, 2024 \n\n**By clicking “I Accept” below or by using or distributing any portion or element of the Models, Software, Software Products or Derivative Works, you agree to the terms of this License. If you do not agree to this License, then you do not have any rights to use the Software Products or Derivative Works through this License, and you must immediately cease using the Software Products or Derivative Works. If you are agreeing to be bound by the terms of this License on behalf of your employer or other entity, you represent and warrant to Stability AI that you have full legal authority to bind your employer or such entity to this License. If you do not have the requisite authority, you may not accept the License or access the Software Products or Derivative Works on behalf of your employer or other entity.**\n\n “Agreement“ means this Stable Non-Commercial Research Community License Agreement.\n\n“AUP” means the Stability AI Acceptable Use Policy available at [https://stability.ai/use-policy](https://stability.ai/use-policy), as may be updated from time to time.\n\n“Derivative Work(s)” means (a) any derivative work of the Software Products as recognized by U.S. copyright laws, (b) any modifications to a Model, and (c) any other model created which is based on or derived from the Model or the Model’s output. For clarity, Derivative Works do not include the output of any Model.\n\n“Documentation” means any specifications, manuals, documentation, and other written information provided by Stability AI related to the Software.\n\n “Licensee“ or “you“ means you, or your employer or any other person or entity (if you are entering into this Agreement on such person or entity's behalf), of the age required under applicable laws, rules or regulations to provide legal consent and that has legal authority to bind your employer or such other person or entity if you are entering in this Agreement on their behalf.\n\n“Model(s)“ means, collectively, Stability AI’s proprietary models and algorithms, including machine-learning models, trained model weights and other elements of the foregoing, made available under this Agreement.\n\n“Non-Commercial Uses” means exercising any of the rights granted herein for the purpose of research or non-commercial purposes. Non-Commercial Uses does not include any production use of the Software Products or any Derivative Works. \n\n“Stability AI“ or “we“ means Stability AI Ltd\_and its affiliates.\n\n“Software“ means Stability AI’s proprietary software made available under this Agreement. \n\n“Software Products” means the Models, Software and Documentation, individually or in any combination.\_\n\n**1. License Rights and Redistribution.**\_\na. Subject to your compliance with this Agreement, the AUP (which is hereby incorporated herein by reference), and the Documentation, Stability AI grants you a non-exclusive, worldwide, non-transferable, non-sublicensable, revocable, royalty free and limited license under Stability AI’s intellectual property or other rights owned or controlled by Stability AI embodied in the Software Products to use, reproduce, distribute, and create Derivative Works of, the Software Products, in each case for Non-Commercial Uses only. \n\nb. You may not use the Software Products or Derivative Works to enable third parties to use the Software Products or Derivative Works as part of your hosted service or via your APIs, whether you are adding substantial additional functionality thereto or not. Merely distributing the Software Products or Derivative Works for download online without offering any related service (ex. by distributing the Models on HuggingFace) is not a violation of this subsection. If you wish to use the Software Products or any Derivative Works for commercial or production use or you wish to make the Software Products or any Derivative Works available to third parties via your hosted service or your APIs, contact Stability AI at [https://stability.ai/contact](https://stability.ai/contact). \_\_\_\n\nc. If you distribute or make the Software Products, or any Derivative Works thereof, available to a third party, the Software Products, Derivative Works, or any portion thereof, respectively, will remain subject to this Agreement and you must (i) provide a copy of this Agreement to such third party, and (ii) retain the following attribution notice within a “Notice“ text file distributed as a part of such copies: “This Stability AI Model is licensed under the Stability AI Non-Commercial Research Community License, Copyright (c) Stability AI Ltd. All Rights Reserved.“ If you create a Derivative Work of a Software Product, you may add your own attribution notices to the Notice file included with the Software Product, provided that you clearly indicate which attributions apply to the Software Product and you must state in the NOTICE file that you changed the Software Product and how it was modified.\n\n**2. Disclaimer of Warranty**. UNLESS REQUIRED BY APPLICABLE LAW, THE SOFTWARE PRODUCTS\_ AND ANY OUTPUT AND RESULTS THEREFROM ARE PROVIDED ON AN “AS IS“ BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE. YOU ARE SOLELY RESPONSIBLE FOR DETERMINING THE APPROPRIATENESS OF USING OR REDISTRIBUTING THE SOFTWARE PRODUCTS, DERIVATIVE WORKS OR ANY OUTPUT OR RESULTS AND ASSUME ANY RISKS ASSOCIATED WITH YOUR USE OF THE SOFTWARE PRODUCTS, DERIVATIVE WORKS AND ANY OUTPUT AND RESULTS.\_\n\n**3. Limitation of Liability.** IN NO EVENT WILL STABILITY AI OR ITS AFFILIATES BE LIABLE UNDER ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, TORT, NEGLIGENCE, PRODUCTS LIABILITY, OR OTHERWISE, ARISING OUT OF THIS AGREEMENT, FOR ANY LOST PROFITS OR ANY DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL, INCIDENTAL, EXEMPLARY OR PUNITIVE DAMAGES, EVEN IF STABILITY AI OR ITS AFFILIATES HAVE BEEN ADVISED OF THE POSSIBILITY OF ANY OF THE FOREGOING.\_\n\n**4. Intellectual Property.**\na. No trademark licenses are granted under this Agreement, and in connection with the Software Products or Derivative Works, neither Stability AI nor Licensee may use any name or mark owned by or associated with the other or any of its affiliates, except as required for reasonable and customary use in describing and redistributing the Software Products or Derivative Works.\_\n\nb. Subject to Stability AI’s ownership of the Software Products and Derivative Works made by or for Stability AI, with respect to any Derivative Works that are made by you, as between you and Stability AI, you are and will be the owner of such Derivative Works.\_\n\nc. If you institute litigation or other proceedings against Stability AI (including a cross-claim or counterclaim in a lawsuit) alleging that the Software Products, Derivative Works or associated outputs or results, or any portion of any of the foregoing, constitutes infringement of intellectual property or other rights owned or licensable by you, then any licenses granted to you under this Agreement shall terminate as of the date such litigation or claim is filed or instituted. You will indemnify and hold harmless Stability AI from and against any claim by any third party arising out of or related to your use or distribution of the Software Products or Derivative Works in violation of this Agreement.\_\n\n**5. Term and Termination**. The term of this Agreement will commence upon your acceptance of this Agreement or access to the Software Products and will continue in full force and effect until terminated in accordance with the terms and conditions herein. Stability AI may terminate this Agreement if you are in breach of any term or condition of this Agreement. Upon termination of this Agreement, you shall delete and cease use of any Software Products or Derivative Works. Sections 2-4 shall survive the termination of this Agreement.\_\n\n**6. Governing Law.** This Agreement will be governed by and construed in accordance with the laws of the United States and the State of California without regard to choice of law principles. \n\n [Please learn more about our self-hosted Membership options here](https://stability.ai/license)."
extra_gated_fields:
  Name: text
  Email: text
  Country: text
  Organization or Affiliation: text
  I ALLOW Stability AI to email me about new model releases: checkbox
  By clicking here, you accept the License agreement, and will use the Software Products and Derivative Works for non-commercial or research purposes only A commercial license is required to self-host the Software Products for commercial purposes, (Please learn more about our self-hosted Membership options on our website linked above): checkbox
  By clicking here, you agree to sharing with Stability AI the information contained within this form and that Stability AI can contact you for the purposes of marketing our products and services Yes, I consent to receiving Stability AI marketing communications: checkbox
extra_gated_button_content: Submit
license:
  - other

Arabic StableLM 2 Chat 1.6B

Model Description

Arabic Stable LM 2 Chat 1.6B is a 1.6 billion parameter instruction tuned language model from the ar-stablelm-base. The model is trained on a mix of publicly available datasets and synthetic datasets.

Usage

StableLM 2 1.6B Chat uses the following ChatML format:

from transformers import AutoModelForCausalLM, AutoTokenizer

tokenizer = AutoTokenizer.from_pretrained('stabilityai/ar-stablelm-2-chat')
model = AutoModelForCausalLM.from_pretrained(
    'stabilityai/ar-stablelm-2-chat',
    device_map="auto",
)

prompt = [{'role': 'user', 'content': 'ماهو إعراب الجملة: ذهبت إلى السوق'}]
inputs = tokenizer.apply_chat_template(
    prompt,
    add_generation_prompt=True,
    return_tensors='pt'
)

tokens = model.generate(
    inputs.to(model.device),
    max_new_tokens=100,
    temperature=0.7,
    do_sample=True
)
output = tokenizer.decode(tokens[:, inputs.shape[-1]:][0], skip_special_tokens=False)

print(output)

Model Details

Training Dataset

The dataset is comprised of a mixture of open datasets large-scale datasets available on the HuggingFace Hub:

Evaluation

We use the following datasets for evaluation :

Below we list the a comparison of our models against 28 models

Model Params CIDAR-MCQ ArabicMMLU ACVA AlGhafa Average
AraGPT2-base 135M 39.0 31.7 51.7 37.9 40.1
AraT5v2-base-1024 220M 38.0 28.3 37.3 36.8 35.1
AraGPT2-medium 370M 39.0 32.2 44.5 38.3 38.5
jais-family-590m 590M 33.0 35.7 51.2 38.8 39.7
jais-family-590m-chat 590M 28.0 31.4 51.8 36.8 37.0
AraGPT2-large 792M 37.0 32.6 46.2 37.9 38.4
AraGPT2-mega 1.46B 40.0 33.3 51.0 38.4 40.7
jais-family-1p3b 1.3B 41.0 37.5 51.3 39.6 42.3
jais-family-1p3b-chat 1.3B 30.0 34.6 56.0 44.7 41.3
Qwen2-1.5B 1.5B 30.0 30.5 61.1 38.7 40.1
Qwen2-1.5B-Instruct 1.5B 28.0 30.8 63.9 38.9 40.4
bloom-1b7 1.72B 37.0 33.0 52.2 39.1 40.3
bloomz-1b7 1.72B 25.0 33.5 45.3 42.1 36.5
jais-family-2p7b 2.7B 43.0 39.0 48.5 40.9 42.8
jais-family-2p7b-chat 2.7B 36.0 36.1 49.5 43.7 41.3
jais-family-6p7b 6.7B 44.0 40.7 55.8 41.3 45.4
jais-family-6p7b-chat 6.7B 38.0 38.7 64.1 39.9 45.2
AceGPT-7B 7B 46.0 40.9 63.1 40.7 47.7
AceGPT-7B-chat 7B 37.0 38.2 65.9 45.1 46.6
SILMA-9B-Instruct-v1.0 9B 27.0 30.8 56.2 42.0 39.0
AceGPT-13B 13B 41.0 40.7 65.3 38.8 46.4
AceGPT-13B-chat 13B 42.0 41.1 70.2 41.6 48.7
AceGPT-v1.5-13B 13B 40.0 40.3 66.1 39.5 46.5
AceGPT-v1.5-13B-chat 13B 36.0 40.9 69.0 39.8 46.4
jais-13b 13B 47.0 40.9 59.6 41.2 47.2
jais-13b-chat 13B 41.0 40.7 61.2 41.4 46.1
jais-family-13b 13B 45.0 41.9 58.3 40.5 46.4
jais-family-13b-chat 13B 37.0 39.9 63.2 41.4 45.4
ar-stablelm-2-base 1.64B 43.0 41.1 52.0 43.9 45.0
ar-stablelm-2-chat 1.64B 46.0 45.5 57.0 50.1 49.6

Use and Limitations

Intended Use

The model is intended to be used in chat-like applications for research only. Users should evaluate the model for safety performance in their specific use case and apply the necessary safeguards and fine-tune the model to facilitate safe performance in downstream applications. Read more about safety and limitations below.

Out-of-scope Use

Out-of-scope uses include use in any manner that violates applicable laws or regulations, Stability AI’s Acceptable Use Policy or license agreement, or use in languages outside of those explicitly supported by this model.

Limitations and Bias

As a base model, this model may exhibit unreliable or other undesirable behaviors that should be corrected through evaluation and fine-tuning prior to deployment. Given that each use case is unique, running a suite of tests may help facilitate proper performance of this model. Using this model will require guardrails around the user’s inputs and outputs to ensure that any outputs returned are not harmful. Pairing this model with an input and output classifier may help prevent harmful responses. Users should exercise caution when using these models in production systems and should not use the models if they are unsuitable for the user’s application.

How to Cite

@misc{alyafeai2024arabicstablelmadapting,
      title={Arabic Stable LM: Adapting Stable LM 2 1.6B to Arabic}, 
      author={Zaid Alyafeai and Michael Pieler and Hannah Teufel and Jonathan Tow and Marco Bellagente and Duy Phung and Nikhil Pinnaparaju and Reshinth Adithyan and Paulo Rocha and Maksym Zhuravinskyi and Carlos Riquelme},
      year={2024},
      eprint={2412.04277},
      archivePrefix={arXiv},
      primaryClass={cs.CL},
      url={https://arxiv.org/abs/2412.04277}, 
}