Hamma-16
/

HammaLoRAMarBERT-v2

@@ -1,202 +1,55 @@
 ---
-base_model: UBC-NLP/MARBERT
 library_name: peft
 ---
-# 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. -->
-- **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]
-### Framework versions
-- PEFT 0.15.2

 ---
+language: ar
+license: apache-2.0
 library_name: peft
+base_model: UBC-NLP/MARBERT
+tags:
+- arabic
+- dialect-classification
+- lora
 ---
+# HammaLoRAMarBert
+Advanced Arabic Dialect Classification Model with Complete Training Metrics
+![Training Metrics](training_metrics.png)
+## Full Training History
+|   epoch |   train_loss |   eval_loss |   train_accuracy |   eval_accuracy |       f1 |   precision |   recall |
+|--------:|-------------:|------------:|-----------------:|----------------:|---------:|------------:|---------:|
+|       1 |     1.51721  |    1.50726  |         0.670392 |        0.685955 | 0.647908 |    0.695828 | 0.670392 |
+|       2 |     0.827407 |    0.804686 |         0.779283 |        0.790449 | 0.779526 |    0.787574 | 0.779283 |
+|       3 |     0.624589 |    0.617633 |         0.815747 |        0.823596 | 0.815815 |    0.818754 | 0.815747 |
+|       4 |     0.577044 |    0.593563 |         0.822927 |        0.821348 | 0.824907 |    0.835161 | 0.822927 |
+|       5 |     0.504094 |    0.535676 |         0.839036 |        0.834831 | 0.839583 |    0.842469 | 0.839036 |
+|       6 |     0.46799  |    0.520281 |         0.849213 |        0.835955 | 0.850536 |    0.855303 | 0.849213 |
+|       7 |     0.445317 |    0.510596 |         0.854708 |        0.840449 | 0.855552 |    0.858046 | 0.854708 |
+|       8 |     0.428012 |    0.501261 |         0.858142 |        0.842135 | 0.859003 |    0.862191 | 0.858142 |
+|       9 |     0.412287 |    0.491676 |         0.864635 |        0.848315 | 0.865268 |    0.868648 | 0.864635 |
+|      10 |     0.400929 |    0.497091 |         0.868194 |        0.847753 | 0.8693   |    0.872337 | 0.868194 |
+|      11 |     0.395328 |    0.506237 |         0.868319 |        0.840449 | 0.870433 |    0.87781  | 0.868319 |
+|      12 |     0.378038 |    0.483877 |         0.874813 |        0.847191 | 0.875232 |    0.877259 | 0.874813 |
+|      13 |     0.3727   |    0.488525 |         0.874313 |        0.841573 | 0.875207 |    0.878724 | 0.874313 |
+|      14 |     0.366197 |    0.482607 |         0.878059 |        0.85     | 0.878635 |    0.880364 | 0.878059 |
+|      15 |     0.365844 |    0.485294 |         0.878247 |        0.851124 | 0.879    |    0.88123  | 0.878247 |
+## Label Mapping:
+{0: 'Egypt', 1: 'Iraq', 2: 'Lebanon', 3: 'Morocco', 4: 'Saudi_Arabia', 5: 'Sudan', 6: 'Tunisia'}
+## USAGE Example:
+```python
+from transformers import pipeline
+classifier = pipeline(
+    "text-classification",
+    model="Hamma-16/HammaLoRAMarBert",
+    device="cuda" if torch.cuda.is_available() else "cpu"
+)
+sample_text = "شلونك اليوم؟"
+result = classifier(sample_text)
+print(f"Text: {sample_text}")
+print(f"Predicted: {result[0]['label']} (confidence: {result[0]['score']:.1%})")