Shahriar
/

WebSector-Flexible

@@ -1,199 +1,102 @@
 ---
 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]

 ---
 library_name: transformers
+tags:
+- Website Classification
+license: mit
+datasets:
+- Shahriar/websector-corpus
+language:
+- en
+base_model: FacebookAI/roberta-base
+pipeline_tag: text-classification
 ---
+# WebSector-Flexible Model Card
+## Model Overview
+The WebSector-Flexible model is a transformer-based multi-sector website classification model, fine-tuned using the RoBERTa architecture with LoRA and trained on the WebSector dataset, consisting of 109,476 websites in the training set. The flexible mode is designed to maximize recall by identifying both primary and secondary sectors of websites, making it suitable for applications that require broad coverage across multiple sectors. This mode is ideal for exploratory tasks or when it's critical to capture all possible sector associations.
 ## Model Details
+- **Model type**: Transformer-based (RoBERTa + LoRA)
+- **Training dataset**: WebSector Corpus (Training set: 109,476 websites)
+- **Prediction modes**: Flexible mode
+- **Task**: Multi-sector website classification
+- **Architecture**: RoBERTa transformer fine-tuned with LexRank summarization for handling lengthy content
+- **Special Technique**: Single Positive Label (SPL) paradigm for multi-label classification with WAN loss
+## Intended Uses & Limitations
+### Use Cases
+- **Website categorization**: Classifies websites into multiple sectors for general exploration or broader categorization tasks.
+- **Research**: Suitable for research on multi-sector classification or multi-label classification tasks where label dependencies are important.
+- **Content Management**: Can be used in platforms where it's important to categorize content across multiple industries or sectors.
+### Limitations
+- **Single Positive Label**: Trained with only the primary sector observable, potentially limiting its accuracy in predicting secondary sectors.
+- **Flexible mode**: Focuses on recall, which may lead to over-predicting some sectors in websites with ambiguous content.
+- **Data Imbalance**: Some sectors are underrepresented in the dataset, which may affect model performance on certain sectors.
+## Dataset
+- **Dataset name**: WebSector Corpus
+- **Training set size**: 109,476 websites
+- **Sectors**:
+  1. Finance, Marketing & HR
+  2. Information Technology & Electronics
+  3. Consumer & Supply Chain
+  4. Civil, Mechanical & Electrical
+  5. Medical
+  6. Sports, Media & Entertainment
+  7. Education
+  8. Government, Defense & Legal
+  9. Travel, Food & Hospitality
+  10. Non-Profit
+- **Labeling**: Each website is labeled with its primary sector, derived from self-declared industry categories.
+## Evaluation Metrics
+- **Top-1 Recall**: Measures the model's ability to correctly identify the primary sector as the most likely predicted sector.
+- **Top-3 Recall**: Evaluates the model's capacity to have the true sector within the top three predicted labels.
+- **Recall**: Assesses the model's ability to predict all relevant sectors, not just the primary one.
+The flexible mode maximizes recall, making it ideal for capturing as many relevant sectors as possible, though it may compromise precision.
+## Training Process
+### Hyperparameters:
+- Number of epochs: 7
+- Batch size: 8
+- Learning rate: 5×10^-6
+- Weight decay: 0.1
+- LoRA rank: 128
+- LoRA alpha: 512
+- Dropout rate: 0.1
+### Training Setup:
+- **Hardware**: Four GPUs, including two NVIDIA RTX A5000 and two NVIDIA TITAN RTX units for parallel processing.
+- **Software**: PyTorch framework and Hugging Face Transformers library.
+- **Strategy**: Distributed training across four GPUs, with model selection based on the lowest validation loss.
+## Model Performance
+- Top-1 Recall: 68%
+- Top-3 Recall: 85%
+- Recall: 86%
+- Precision: 68%
+These metrics show that the flexible mode of the WebSector model is optimized for recall, allowing it to capture multiple relevant sectors while maintaining a solid precision score.
+## Ethical Considerations
+- **Privacy Enforcement**: This model can assist in classifying websites into sectors relevant to privacy regulations like CCPA or HIPAA.
+- **Bias**: As the model was trained on self-declared sector labels, there is potential for bias due to inaccurate or incomplete labeling.
+## Citation
+If you use this model in your research, please cite the following paper:
+```
+Shahriar Shayesteh, Mukund Srinath, Lee Matheson, Florian Schaub, C. Lee Giles, and Shomir Wilson. "WebSector: A New Insight into Multi-Sector Website Classification Using Single Positive Labels". Conference acronym 'XX, June 03–05, 2018, Woodstock, NY.
+```