Update README.md
Browse files
README.md
CHANGED
|
@@ -1,11 +1,17 @@
|
|
| 1 |
---
|
| 2 |
library_name: transformers
|
| 3 |
-
tags:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 4 |
---
|
| 5 |
|
| 6 |
# Model Card for Model ID
|
|
|
|
| 7 |
|
| 8 |
-
<!-- Provide a quick summary of what the model is/does. -->
|
| 9 |
|
| 10 |
|
| 11 |
|
|
@@ -17,7 +23,7 @@ tags: []
|
|
| 17 |
|
| 18 |
This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
|
| 19 |
|
| 20 |
-
- **Developed by:** [
|
| 21 |
- **Funded by [optional]:** [More Information Needed]
|
| 22 |
- **Shared by [optional]:** [More Information Needed]
|
| 23 |
- **Model type:** [More Information Needed]
|
|
@@ -35,55 +41,116 @@ This is the model card of a 🤗 transformers model that has been pushed on the
|
|
| 35 |
|
| 36 |
## Uses
|
| 37 |
|
| 38 |
-
<!--
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 39 |
|
| 40 |
### Direct Use
|
|
|
|
| 41 |
|
| 42 |
-
|
| 43 |
|
| 44 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 45 |
|
| 46 |
### Downstream Use [optional]
|
| 47 |
|
| 48 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 49 |
|
| 50 |
-
[More Information Needed]
|
| 51 |
|
| 52 |
### Out-of-Scope Use
|
| 53 |
|
| 54 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
| 55 |
|
| 56 |
-
[More Information Needed]
|
| 57 |
|
| 58 |
## Bias, Risks, and Limitations
|
| 59 |
|
| 60 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 61 |
|
| 62 |
-
[More Information Needed]
|
| 63 |
|
| 64 |
### Recommendations
|
| 65 |
|
| 66 |
-
|
| 67 |
|
| 68 |
-
|
|
|
|
|
|
|
| 69 |
|
| 70 |
## How to Get Started with the Model
|
| 71 |
|
| 72 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 73 |
|
| 74 |
-
[More Information Needed]
|
| 75 |
|
| 76 |
## Training Details
|
| 77 |
|
| 78 |
### Training Data
|
| 79 |
|
| 80 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 81 |
|
| 82 |
-
[More Information Needed]
|
| 83 |
|
| 84 |
### Training Procedure
|
| 85 |
|
| 86 |
-
<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
|
| 87 |
|
| 88 |
#### Preprocessing [optional]
|
| 89 |
|
|
@@ -92,7 +159,7 @@ Use the code below to get started with the model.
|
|
| 92 |
|
| 93 |
#### Training Hyperparameters
|
| 94 |
|
| 95 |
-
- **Training regime:**
|
| 96 |
|
| 97 |
#### Speeds, Sizes, Times [optional]
|
| 98 |
|
|
@@ -102,15 +169,13 @@ Use the code below to get started with the model.
|
|
| 102 |
|
| 103 |
## Evaluation
|
| 104 |
|
| 105 |
-
<!-- This section describes the evaluation protocols and provides the results. -->
|
| 106 |
-
|
| 107 |
### Testing Data, Factors & Metrics
|
| 108 |
|
| 109 |
#### Testing Data
|
| 110 |
|
| 111 |
-
|
|
|
|
| 112 |
|
| 113 |
-
[More Information Needed]
|
| 114 |
|
| 115 |
#### Factors
|
| 116 |
|
|
@@ -120,13 +185,15 @@ Use the code below to get started with the model.
|
|
| 120 |
|
| 121 |
#### Metrics
|
| 122 |
|
| 123 |
-
|
| 124 |
|
| 125 |
-
|
| 126 |
|
| 127 |
### Results
|
| 128 |
|
| 129 |
-
|
|
|
|
|
|
|
| 130 |
|
| 131 |
#### Summary
|
| 132 |
|
|
@@ -196,4 +263,6 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
|
|
| 196 |
|
| 197 |
## Model Card Contact
|
| 198 |
|
| 199 |
-
|
|
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
library_name: transformers
|
| 3 |
+
tags:
|
| 4 |
+
- bert
|
| 5 |
+
- youtube
|
| 6 |
+
- classification
|
| 7 |
+
license: apache-2.0
|
| 8 |
+
language:
|
| 9 |
+
- en
|
| 10 |
---
|
| 11 |
|
| 12 |
# Model Card for Model ID
|
| 13 |
+
This is a fine-tuned BERT model that classifies YouTube channels content into categories such as Education, Technology, Entertainment, and more.
|
| 14 |
|
|
|
|
| 15 |
|
| 16 |
|
| 17 |
|
|
|
|
| 23 |
|
| 24 |
This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
|
| 25 |
|
| 26 |
+
- **Developed by:** [Jayesh Mehta]
|
| 27 |
- **Funded by [optional]:** [More Information Needed]
|
| 28 |
- **Shared by [optional]:** [More Information Needed]
|
| 29 |
- **Model type:** [More Information Needed]
|
|
|
|
| 41 |
|
| 42 |
## Uses
|
| 43 |
|
| 44 |
+
<!-- This model can be directly used to classify YouTube video titles and descriptions into predefined categories: Education, Technology, Motivation, Entertainment, and Gaming.
|
| 45 |
+
|
| 46 |
+
Example use cases:
|
| 47 |
+
|
| 48 |
+
Automatically tagging videos in content moderation systems
|
| 49 |
+
|
| 50 |
+
Enabling smart filtering and recommendations
|
| 51 |
+
|
| 52 |
+
Analyzing category distribution of YouTube channels -->
|
| 53 |
|
| 54 |
### Direct Use
|
| 55 |
+
<!-- python
|
| 56 |
|
| 57 |
+
from transformers import BertTokenizer, BertForSequenceClassification
|
| 58 |
|
| 59 |
+
model = BertForSequenceClassification.from_pretrained("JaySenpai/bert-youtube-model")
|
| 60 |
+
tokenizer = BertTokenizer.from_pretrained("JaySenpai/bert-youtube-model")
|
| 61 |
+
|
| 62 |
+
inputs = tokenizer("This video is about personal productivity hacks", return_tensors="pt")
|
| 63 |
+
outputs = model(**inputs)
|
| 64 |
+
predicted = outputs.logits.argmax(dim=1).item()```
|
| 65 |
+
|
| 66 |
+
-->
|
| 67 |
|
| 68 |
### Downstream Use [optional]
|
| 69 |
|
| 70 |
+
This model can be integrated into larger systems, such as:
|
| 71 |
+
|
| 72 |
+
Content management systems
|
| 73 |
+
|
| 74 |
+
YouTube channel analytics tools
|
| 75 |
+
|
| 76 |
+
Personalized recommendation engines
|
| 77 |
|
|
|
|
| 78 |
|
| 79 |
### Out-of-Scope Use
|
| 80 |
|
| 81 |
+
The model is not suitable for long-form text or transcript-level classification.
|
| 82 |
+
|
| 83 |
+
Should not be used to classify non-YouTube content or languages other than English.
|
| 84 |
+
|
| 85 |
+
Avoid using it in sensitive decision-making scenarios (e.g., legal, medical).
|
| 86 |
|
|
|
|
| 87 |
|
| 88 |
## Bias, Risks, and Limitations
|
| 89 |
|
| 90 |
+
Like most models trained on public or scraped data:
|
| 91 |
+
|
| 92 |
+
The model may carry biases from the underlying data (e.g., overrepresentation of certain video types).
|
| 93 |
+
|
| 94 |
+
It may misclassify mixed-genre or ambiguous titles (e.g., “Top 10 Gaming Laptops for Students”).
|
| 95 |
+
|
| 96 |
+
It is sensitive to text length and clarity—very short or vague titles may reduce accuracy.
|
| 97 |
|
|
|
|
| 98 |
|
| 99 |
### Recommendations
|
| 100 |
|
| 101 |
+
Use the model as an assistive tool, not a final decision-maker.
|
| 102 |
|
| 103 |
+
Evaluate its performance on your specific data before deploying.
|
| 104 |
+
|
| 105 |
+
Consider adding user feedback or manual review in production systems.
|
| 106 |
|
| 107 |
## How to Get Started with the Model
|
| 108 |
|
| 109 |
+
from transformers import BertTokenizer, BertForSequenceClassification
|
| 110 |
+
|
| 111 |
+
model = BertForSequenceClassification.from_pretrained("JaySenpai/bert-model")
|
| 112 |
+
tokenizer = BertTokenizer.from_pretrained("JaySenpai/bert-model")
|
| 113 |
+
|
| 114 |
+
text = "10 Tips to Grow Your YouTube Channel"
|
| 115 |
+
inputs = tokenizer(text, return_tensors="pt")
|
| 116 |
+
outputs = model(**inputs)
|
| 117 |
+
prediction = outputs.logits.argmax(dim=1).item()
|
| 118 |
+
|
| 119 |
+
labels = {0: "Education", 1: "Comedy and Humour", 2: "Gaming", 3: "Technology", 4: "Motivation"}
|
| 120 |
+
print("Predicted label:", labels[prediction])
|
| 121 |
|
|
|
|
| 122 |
|
| 123 |
## Training Details
|
| 124 |
|
| 125 |
### Training Data
|
| 126 |
|
| 127 |
+
Training Data
|
| 128 |
+
The model was fine-tuned using a labeled dataset of YouTube titles and descriptions, mapped to categories:
|
| 129 |
+
|
| 130 |
+
Education
|
| 131 |
+
Travel
|
| 132 |
+
Cooking
|
| 133 |
+
Gaming
|
| 134 |
+
Music
|
| 135 |
+
Health and Fitness
|
| 136 |
+
Finance
|
| 137 |
+
Technology
|
| 138 |
+
Vlogging
|
| 139 |
+
Beauty & Fashion
|
| 140 |
+
Digital Marketing
|
| 141 |
+
Movies/Series Reviews
|
| 142 |
+
Comedy and Humour
|
| 143 |
+
Podcast
|
| 144 |
+
Youtube or Instagram Grow Tips
|
| 145 |
+
Online Income
|
| 146 |
+
ASMR
|
| 147 |
+
Business and Marketing
|
| 148 |
+
News
|
| 149 |
+
Motivation
|
| 150 |
|
|
|
|
| 151 |
|
| 152 |
### Training Procedure
|
| 153 |
|
|
|
|
| 154 |
|
| 155 |
#### Preprocessing [optional]
|
| 156 |
|
|
|
|
| 159 |
|
| 160 |
#### Training Hyperparameters
|
| 161 |
|
| 162 |
+
- **Training regime:** <!Base model: bert-base-uncased Epochs: 4 Batch size: 16 Learning rate: 2e-5 Optimizer: AdamW -->
|
| 163 |
|
| 164 |
#### Speeds, Sizes, Times [optional]
|
| 165 |
|
|
|
|
| 169 |
|
| 170 |
## Evaluation
|
| 171 |
|
|
|
|
|
|
|
| 172 |
### Testing Data, Factors & Metrics
|
| 173 |
|
| 174 |
#### Testing Data
|
| 175 |
|
| 176 |
+
The model was evaluated on a held-out validation set of manually labeled YouTube titles and descriptions.
|
| 177 |
+
|
| 178 |
|
|
|
|
| 179 |
|
| 180 |
#### Factors
|
| 181 |
|
|
|
|
| 185 |
|
| 186 |
#### Metrics
|
| 187 |
|
| 188 |
+
Accuracy: ~97%
|
| 189 |
|
| 190 |
+
F1-score (macro): ~0.95
|
| 191 |
|
| 192 |
### Results
|
| 193 |
|
| 194 |
+
The model performed well on clear-cut categories like "Gaming" and "Technology" but showed confusion between "Motivation" and "Education" in edge cases.
|
| 195 |
+
|
| 196 |
+
|
| 197 |
|
| 198 |
#### Summary
|
| 199 |
|
|
|
|
| 263 |
|
| 264 |
## Model Card Contact
|
| 265 |
|
| 266 |
+
Author: Jayesh Mehta(JaySenpai)
|
| 267 |
+
Hugging Face: @JaySenpai
|
| 268 |
+
|