Arabic-Profanity-Checker

Model Card for Model ID

<!-- Provide a quick summary of what the model is/does. -->

Profanity/Toxic word checker with percentage telling how much a word is profane or normal

Model Details

Model trained on vast amount of data including normal humamn male/female names up to 10,000 names, and Profane/Toxic words up to 12,000 words including fuzzied words and expressions

Model Description

<!-- Provide a longer summary of what this model is. -->

Model target is to check for a given 'Single' word (exactly one token) whether this input is a Profane/Toxic (very inappropriate) word or not with output LABEL_0 for a positive word(non profane) and LABEL_1 as negative word(profane) along side with the percentage of how much this word is profane

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: Khaled Kassem -> Me
• Funded by : Google Colab Research
• Shared by : Public
• Model type: BERT Base Transformer
• License: Public Open Sourced if needed
• Finetuned from model : asafaya/bert-base-arabic

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. -->

How to use? Simple, input a word or List of words and the model to predict for each word, whether it is a profane/toxic or not outputting LABEL_0 for positive non profane and LABEL_1 for negative profane

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. -->

Model will not work well with contexts or semantics, it is used only for single word check, for sentiment analysis I recommend CAMeL-Lab/bert-base-arabic-camelbert-da-sentiment model

[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. !pip install transformers

from transformers import AutoModelForSequenceClassification, AutoTokenizer from transformers import pipeline

Load the Model

model_path = "khaled-kassem/Arabic-Profanity-Checker" model = AutoModelForSequenceClassification.from_pretrained(model_path) tokenizer = AutoTokenizer.from_pretrained(model_path)

nlp_pipeline = pipeline("text-classification", model=model, tokenizer=tokenizer)

example_text = "وغد"

profane_result = nlp_pipeline(example_text)

for word in profane_result: if (word['label'] == 'LABEL_1'): print("Negative") print(word['score']*100) else: print("Positive") print(word['score']*100)

[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 presented in Lacoste et al. (2019).

• 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]