Hamma-16
/

HammaLoRACAMeLBERT-v3

@@ -1,202 +1,56 @@
 ---
-base_model: CAMeL-Lab/bert-base-arabic-camelbert-mix
 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: CAMeL-Lab/bert-base-arabic-camelbert-mix
+tags:
+- arabic
+- dialect-classification
+- lora
 ---
+# HammaLoRACAMeLBert
+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.04802  |    1.05081  |         0.637238 |        0.63764  | 0.6275   |    0.63901  | 0.637238 |
+|       2 |     0.77121  |    0.781513 |         0.736139 |        0.735955 | 0.613924 |    0.630747 | 0.624063 |
+|       3 |     0.620521 |    0.659047 |         0.788899 |        0.779775 | 0.791235 |    0.799805 | 0.788899 |
+|       4 |     0.573822 |    0.644417 |         0.800762 |        0.776404 | 0.67889  |    0.688134 | 0.680569 |
+|       5 |     0.49636  |    0.587736 |         0.824675 |        0.791573 | 0.826167 |    0.833785 | 0.824675 |
+|       6 |     0.476073 |    0.589205 |         0.833292 |        0.792697 | 0.709791 |    0.724241 | 0.708417 |
+|       7 |     0.429335 |    0.547112 |         0.849525 |        0.808427 | 0.850117 |    0.853328 | 0.849525 |
+|       8 |     0.412983 |    0.544361 |         0.855519 |        0.805056 | 0.732394 |    0.747566 | 0.729645 |
+|       9 |     0.388498 |    0.551354 |         0.863511 |        0.808989 | 0.863979 |    0.869072 | 0.863511 |
+|      10 |     0.359349 |    0.52705  |         0.877185 |        0.81573  | 0.74493  |    0.757555 | 0.743194 |
+|      11 |     0.34684  |    0.538555 |         0.879683 |        0.810674 | 0.880776 |    0.884118 | 0.879683 |
+|      12 |     0.337791 |    0.538365 |         0.883304 |        0.807865 | 0.749058 |    0.760792 | 0.747378 |
+|      13 |     0.328992 |    0.53789  |         0.886301 |        0.81236  | 0.887004 |    0.889841 | 0.886301 |
+|      14 |     0.322374 |    0.536085 |         0.889423 |        0.81573  | 0.758437 |    0.767501 | 0.756868 |
+|      15 |     0.320124 |    0.53761  |         0.890485 |        0.814607 | 0.891161 |    0.89363  | 0.890485 |
+## 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/HammaLoRACAMeLBert",
+    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%})")