Kamel
/

AraSDG_MultiClass

@@ -16,197 +16,60 @@ widget:
 ---
-# 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]

 ---
+# Multiclass SDG Detection with ArBERTv2
+This model is a multiclass classifier fine-tuned on the ArBERTv2 architecture, designed to identify specific Sustainable Development Goals (SDGs) mentioned in Arabic text. It classifies text into multiple SDG categories once it has been identified as SDG-related.
+# Prerequisite
+Before running this model, input texts must first be classified as SDG-related using the binary classifier [Kamel/AraSDG_Binary](https://huggingface.co/Kamel/AraSDG_Binary). This model only applies to articles that are confirmed to mention SDGs.
 ## Model Details
+### Intended Use
+This model is intended for use in detecting specific SDGs within Arabic text that has already been identified as SDG-related. It can be applied to large collections of articles, reports, or social media texts for content classification across multiple SDG categories.
+### How to Use
+#### Step 1: Use the Binary SDG Classifier
+Ensure that articles are first passed through the binary SDG classifier to determine if they are SDG-related. Only proceed with articles where the binary classifier predicts an SDG-related output.
+#### Step 2: Use the Multiclass Model
+Once an article is classified as SDG-related, use the following code to predict the specific SDG category.
+````python
+from transformers import AutoModelForSequenceClassification, AutoTokenizer
+import torch
+# Load the model and tokenizer
+tokenizer = AutoTokenizer.from_pretrained("Kamel/AraSDG_MultiClass")
+model = AutoModelForSequenceClassification.from_pretrained("Kamel/AraSDG_MultiClass")
+# Example text input (only use if the binary classifier predicts SDG-related)
+text = "your Arabic text here"
+# Tokenize input
+inputs = tokenizer(text, return_tensors="pt")
+# Perform inference
+with torch.no_grad():
+    outputs = model(**inputs)
+    logits = outputs.logits
+# Get the predicted class (specific SDG class)
+predicted_class = torch.argmax(logits, dim=-1).item()
+# Print the result (you can map this to specific SDG labels as needed)
+print(f"Predicted SDG class: {predicted_class}")
+````
 ### Training Data
+The model was fine-tuned on a dataset of Arabic news articles, each labeled with a specific SDG category (e.g., SDG 1, SDG 2, etc.). The training data was augmented with synthetic content to ensure balanced representation across different SDGs.
+### Performance
+The model achieves an average macro F1-score of 87%, performing well across a range of SDG categories.
+### Limitations
+* Prerequisite: This model assumes the input text has already been classified as SDG-related by a binary classifier.
+* The model is trained on Modern Standard Arabic (MSA) and may not perform as well on dialectal variations.
+* Some SDGs may have more training data than others, leading to potential bias in predictions.