Gen2B
/

HyGPT-10b

@@ -1,199 +1,156 @@
 ---
 library_name: transformers
-tags: []
 ---
-# Model Card for Model ID
-<!-- Provide a quick summary of what the model is/does. -->
 ## Model Details
 ### Model Description
-<!-- Provide a longer summary of what this model is. -->
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
-### Model Sources [optional]
-<!-- Provide the basic links for the model. -->
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
 ## Uses
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
 ### Direct Use
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-[More Information Needed]
-### Downstream Use [optional]
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-[More Information Needed]
-### Out-of-Scope Use
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-[More Information Needed]
 ## Bias, Risks, and Limitations
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-[More Information Needed]
-### Recommendations
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
-## How to Get Started with the Model
-Use the code below to get started with the model.
-[More Information Needed]
 ## Training Details
 ### Training Data
-<!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
-[More Information Needed]
-### Training Procedure
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-#### Preprocessing [optional]
-[More Information Needed]
-#### Training Hyperparameters
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-#### Speeds, Sizes, Times [optional]
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-[More Information Needed]
-## Evaluation
-<!-- This section describes the evaluation protocols and provides the results. -->
-### Testing Data, Factors & Metrics
-#### Testing Data
-<!-- This should link to a Dataset Card if possible. -->
-[More Information Needed]
-#### Factors
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-[More Information Needed]
-#### Metrics
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-[More Information Needed]
 ### Results
-[More Information Needed]
 #### Summary
-## Model Examination [optional]
-<!-- Relevant interpretability work for the model goes here -->
-[More Information Needed]
-## Environmental Impact
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
-## Technical Specifications [optional]
-### Model Architecture and Objective
-[More Information Needed]
-### Compute Infrastructure
-[More Information Needed]
-#### Hardware
-[More Information Needed]
-#### Software
-[More Information Needed]
-## Citation [optional]
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-**BibTeX:**
-[More Information Needed]
-**APA:**
-[More Information Needed]
-## Glossary [optional]
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-[More Information Needed]
-## More Information [optional]
-[More Information Needed]
-## Model Card Authors [optional]
-[More Information Needed]
-## Model Card Contact
-[More Information Needed]

 ---
+license: gemma
 library_name: transformers
+pipeline_tag: text-generation
+tags:
+- armenian
+- llm
+- pretrained
+language:
+- hy
+- ru
+- en
 ---
+# HayGPT-10b
+HayGPT-10b is the first Armenian large language model that has been pretrained on corpus of Armenian text data. This model is designed to understand and generate Armenian text, making it a pioneering high-quality language model specifically created for the Armenian language.
 ## Model Details
 ### Model Description
+HayGPT-10b is a decoder-only language model based on Google's Gemma-2-9b architecture that has been further pretrained on 10B tokens of Armenian text.
+A key technical modification in this model is the decoupling of the embedding and LM head layers, allowing the output layer to be trained independently, which can improve the model's ability to generate accurate Armenian text.
+- **Developed by:** [Gen2B](https://gen2b.ai/) & [NCCAIT](http://arm.ican24.net/)
+- **Model type:** Decoder-only language model
+- **Language(s) (NLP):** Armenian, English, Russian
+- **License:** [gemma](https://ai.google.dev/gemma/terms)
 ## Uses
+First, install the Transformers library with:
+```sh
+pip install -U transformers
+```
+Then, run this example:
+```python
+from transformers import AutoModelForCausalLM, AutoTokenizer, GenerationConfig
+import torch
+model_path = "IrbisAI/HayGPT-10b"
+tokenizer = AutoTokenizer.from_pretrained(model_path)
+model = AutoModelForCausalLM.from_pretrained(
+    model_path,
+    torch_dtype=torch.float16,
+    device_map="auto",
+)
+PROMPT = 'Ինչու է խոտը Կանաչ:'
+inputs = tokenizer(
+    PROMPT,
+    return_tensors="pt",
+)
+print("Generating...")
+generation_output = model.generate(
+    input_ids=inputs["input_ids"].cuda(),
+    generation_config=GenerationConfig(
+        temperature=0.0001,
+        repetition_penalty=1.1,
+        do_sample=True
+    ),
+    return_dict_in_generate=True,
+    output_scores=True,
+    max_new_tokens=256,
+)
+for s in generation_output.sequences:
+    print(tokenizer.decode(s))
+# Կանաչ գույնի առկայությունը բուսականության մեջ պայմանավորված է կլորավուն քլորոֆիլային մոլեկուլների առկայությամբ, որոնք հանդիսանում են լույսի անդրադարձման և տարածման միակ աղբյուրները։ Առողջ բույսերում այդպիսի մոլեկուլներ շատ են, ուստի դրանցից արտացոլվող լույսի երանգը համապատասխանում է կանաչին։ Եթե մոլեկուլների թիվը նվազում է, օրինակ՝ սովի կամ վիրուսային վարակի դեպքում, ապա բույսերի գույնը փոխվում է. Դեղին-շագանակագույն, կարմիր, կապույտ, սև։
+```
 ### Direct Use
+HayGPT-10b can be used directly for:
+- Armenian text generation
+- Question answering in Armenian
+- Text completion for Armenian content
+- Understanding Armenian language queries
 ## Bias, Risks, and Limitations
+- The model may reflect biases present in the Armenian language training data
+- Accuracy may vary across different Armenian dialects and regional variations
+- The model may not have up-to-date knowledge beyond its training data
+- Like all language models, it may occasionally generate incorrect or nonsensical responses
+- The model's understanding of specialized Armenian terminology may be limited in certain domains
 ## Training Details
 ### Training Data
+The model was pretrained on a diverse corpus of Armenian text data comprising approximately 10 billion tokens. The dataset includes:
+- Armenian web content
+- Armenian literature and publications
+- Armenian news articles
+- Armenian Wikipedia
+- Other publicly available Armenian text sources
+The data was collected with a focus on representing Armenian language usage across various domains and topics.
+### Preprocessing
+The Armenian text data underwent several preprocessing steps:
+- Cleaning and normalization of Armenian text
+- Removal of duplicate content
+- Tokenization using the base Gemma tokenizer
+### Training Procedure
+The model was further pretrained from the google/gemma-2-9b base model using a pretraining approach. A key modification was decoupling the embedding and LM head layers, allowing the output layer to be trained independently. This approach was adopted based on a series of short experiments followed by evaluation on three publicly available Armenian language datasets. The results demonstrated that training the embedding and output layers separately yields higher accuracy according to metrics, compared to both the standard synchronized training of embedding and output layers, as well as configurations with frozen embedding layer, frozen output layer, or both layers frozen. The table below shows the evaluation results across different configurations:
+| | **train emb / train lm** | *train sync(emb/lm)* | *train emb / freeze lm* | *freeze emb / train lm* | *freeze emb / freeze lm* |
+|---|---|---|---|---|---|
+| [facebook/belebele](https://huggingface.co/datasets/facebook/belebele) | **56.8** | *54.6* | *51.8* | *56.2* | *56.6* |
+| [gayaneghazaryan/SynDARn](https://huggingface.co/datasets/gayaneghazaryan/SynDARn) | **73.0** | *71.3* | *71.1* | *72.5* | *72.0* |
+| [CohenForAI/mGlue-base-44](https://huggingface.co/datasets/CohenForAI/mGlue-base-44) | **34.2** | *33.9* | *33.3* | *34.1* | *34.0* |
+| avg | **54.7** | *53.3* | *52.1* | *54.3* | *54.2* |
 ### Results
+The model demonstrates strong performance on Armenian language tasks, showing significant improvements over models without Armenian-specific pretraining. Detailed benchmark results will be published in the future.
 #### Summary
+HayGPT-10b shows promising capabilities for Armenian language understanding and generation, making it a valuable resource for Armenian NLP applications. Additionally, the model serves as an excellent foundation model for further fine-tuning on specific data and domains, allowing developers to adapt it to specialized Armenian language tasks and industry-specific applications.
+---
+## License and Terms of Use
+This model is based on Gemma and is distributed according to the [Gemma Terms of Use](https://ai.google.dev/gemma/terms).
+**Notice**: Gemma is provided under and subject to the Gemma Terms of Use found at [ai.google.dev/gemma/terms](https://ai.google.dev/gemma/terms).
+### Modifications Notice
+This model is a modified version of the original Gemma-2-9b model. The modifications include:
+1. Further pretraining on 10 billion tokens of Armenian text data
+2. Decoupling of the embedding and LM head layers to allow independent training of the output layer
+### Use Restrictions
+According to the Gemma Terms of Use, the model should not be used:
+1. For purposes outlined in the [Gemma Prohibited Use Policy](https://ai.google.dev/gemma/prohibited_use_policy)
+2. In violation of applicable laws and regulations
+## Disclaimer of Warranty
+UNLESS REQUIRED BY APPLICABLE LAW, THE GEMMA SERVICES, AND OUTPUTS, ARE PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE. YOU ARE SOLELY RESPONSIBLE FOR DETERMINING THE APPROPRIATENESS OF USING, REPRODUCING, MODIFYING, PERFORMING, DISPLAYING OR DISTRIBUTING ANY OF THE GEMMA SERVICES OR OUTPUTS AND ASSUME ANY AND ALL RISKS ASSOCIATED WITH YOUR USE OR DISTRIBUTION OF ANY OF THE GEMMA SERVICES OR OUTPUTS AND YOUR EXERCISE OF RIGHTS AND PERMISSIONS UNDER THIS AGREEMENT.