Update README.md
Browse files
README.md
CHANGED
|
@@ -1,197 +1,81 @@
|
|
| 1 |
-
|
| 2 |
-
pipeline_tag: zero-shot-classification
|
| 3 |
-
---
|
| 4 |
-
# Model Card for Model ID
|
| 5 |
-
|
| 6 |
-
<!-- Provide a quick summary of what the model is/does. -->
|
| 7 |
-
|
| 8 |
-
This modelcard aims to be a base template for new models. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/modelcard_template.md?plain=1).
|
| 9 |
-
|
| 10 |
-
## Model Details
|
| 11 |
-
|
| 12 |
-
### Model Description
|
| 13 |
-
|
| 14 |
-
<!-- Provide a longer summary of what this model is. -->
|
| 15 |
-
|
| 16 |
-
|
| 17 |
-
|
| 18 |
-
- **Developed by:**
|
| 19 |
-
- **Funded by [optional]:** [More Information Needed]
|
| 20 |
-
- **Shared by [optional]:** [More Information Needed]
|
| 21 |
-
- **Model type:** [More Information Needed]
|
| 22 |
-
- **Language(s) (NLP):** [More Information Needed]
|
| 23 |
-
- **License:** [More Information Needed]
|
| 24 |
-
- **Finetuned from model [optional]:** [More Information Needed]
|
| 25 |
-
|
| 26 |
-
### Model Sources [optional]
|
| 27 |
-
|
| 28 |
-
<!-- Provide the basic links for the model. -->
|
| 29 |
-
|
| 30 |
-
- **Repository:** [More Information Needed]
|
| 31 |
-
- **Paper [optional]:** [More Information Needed]
|
| 32 |
-
- **Demo [optional]:** [More Information Needed]
|
| 33 |
-
|
| 34 |
-
## Uses
|
| 35 |
-
|
| 36 |
-
<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
|
| 37 |
-
|
| 38 |
-
### Direct Use
|
| 39 |
-
|
| 40 |
-
<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
|
| 41 |
-
|
| 42 |
-
[More Information Needed]
|
| 43 |
-
|
| 44 |
-
### Downstream Use [optional]
|
| 45 |
-
|
| 46 |
-
<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
|
| 47 |
-
|
| 48 |
-
[More Information Needed]
|
| 49 |
-
|
| 50 |
-
### Out-of-Scope Use
|
| 51 |
-
|
| 52 |
-
<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
|
| 53 |
-
|
| 54 |
-
[More Information Needed]
|
| 55 |
-
|
| 56 |
-
## Bias, Risks, and Limitations
|
| 57 |
-
|
| 58 |
-
<!-- This section is meant to convey both technical and sociotechnical limitations. -->
|
| 59 |
-
|
| 60 |
-
[More Information Needed]
|
| 61 |
-
|
| 62 |
-
### Recommendations
|
| 63 |
-
|
| 64 |
-
<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
|
| 65 |
-
|
| 66 |
-
Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
|
| 67 |
-
|
| 68 |
-
## How to Get Started with the Model
|
| 69 |
-
|
| 70 |
-
Use the code below to get started with the model.
|
| 71 |
-
|
| 72 |
-
[More Information Needed]
|
| 73 |
-
|
| 74 |
-
## Training Details
|
| 75 |
-
|
| 76 |
-
### Training Data
|
| 77 |
-
|
| 78 |
-
<!-- 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. -->
|
| 79 |
-
|
| 80 |
-
[More Information Needed]
|
| 81 |
|
| 82 |
-
|
| 83 |
|
| 84 |
-
|
| 85 |
-
|
| 86 |
-
|
| 87 |
-
|
| 88 |
-
|
| 89 |
-
|
| 90 |
-
|
| 91 |
-
|
| 92 |
-
|
| 93 |
-
-
|
| 94 |
-
|
| 95 |
-
|
| 96 |
-
|
| 97 |
-
<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
|
| 98 |
-
|
| 99 |
-
[More Information Needed]
|
| 100 |
-
|
| 101 |
-
## Evaluation
|
| 102 |
-
|
| 103 |
-
<!-- This section describes the evaluation protocols and provides the results. -->
|
| 104 |
-
|
| 105 |
-
### Testing Data, Factors & Metrics
|
| 106 |
-
|
| 107 |
-
#### Testing Data
|
| 108 |
-
|
| 109 |
-
<!-- This should link to a Dataset Card if possible. -->
|
| 110 |
-
|
| 111 |
-
[More Information Needed]
|
| 112 |
-
|
| 113 |
-
#### Factors
|
| 114 |
-
|
| 115 |
-
<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
|
| 116 |
-
|
| 117 |
-
[More Information Needed]
|
| 118 |
-
|
| 119 |
-
#### Metrics
|
| 120 |
-
|
| 121 |
-
<!-- These are the evaluation metrics being used, ideally with a description of why. -->
|
| 122 |
-
|
| 123 |
-
[More Information Needed]
|
| 124 |
-
|
| 125 |
-
### Results
|
| 126 |
-
|
| 127 |
-
[More Information Needed]
|
| 128 |
-
|
| 129 |
-
#### Summary
|
| 130 |
-
|
| 131 |
-
|
| 132 |
-
|
| 133 |
-
## Model Examination [optional]
|
| 134 |
-
|
| 135 |
-
<!-- Relevant interpretability work for the model goes here -->
|
| 136 |
-
|
| 137 |
-
[More Information Needed]
|
| 138 |
-
|
| 139 |
-
## Environmental Impact
|
| 140 |
-
|
| 141 |
-
<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
|
| 142 |
-
|
| 143 |
-
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).
|
| 144 |
-
|
| 145 |
-
- **Hardware Type:** [More Information Needed]
|
| 146 |
-
- **Hours used:** [More Information Needed]
|
| 147 |
-
- **Cloud Provider:** [More Information Needed]
|
| 148 |
-
- **Compute Region:** [More Information Needed]
|
| 149 |
-
- **Carbon Emitted:** [More Information Needed]
|
| 150 |
-
|
| 151 |
-
## Technical Specifications [optional]
|
| 152 |
|
| 153 |
-
#
|
| 154 |
|
| 155 |
-
|
| 156 |
|
| 157 |
-
##
|
| 158 |
|
| 159 |
-
|
|
|
|
|
|
|
|
|
|
| 160 |
|
| 161 |
-
##
|
| 162 |
|
| 163 |
-
|
| 164 |
|
| 165 |
-
|
|
|
|
|
|
|
| 166 |
|
| 167 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
| 168 |
|
| 169 |
-
#
|
|
|
|
| 170 |
|
| 171 |
-
|
| 172 |
|
| 173 |
-
|
| 174 |
|
| 175 |
-
|
| 176 |
|
| 177 |
-
**
|
| 178 |
|
| 179 |
-
|
| 180 |
|
| 181 |
-
|
| 182 |
|
| 183 |
-
|
| 184 |
|
| 185 |
-
|
| 186 |
|
| 187 |
-
|
|
|
|
| 188 |
|
| 189 |
-
|
|
|
|
|
|
|
|
|
|
| 190 |
|
| 191 |
-
|
| 192 |
|
| 193 |
-
|
| 194 |
|
| 195 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
| 196 |
|
| 197 |
-
|
|
|
|
| 1 |
+
### 1. Model Card Template (`README.md` for Hugging Face)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 2 |
|
| 3 |
+
Create a `README.md` file in your Hugging Face model repository and paste this:
|
| 4 |
|
| 5 |
+
```markdown
|
| 6 |
+
---
|
| 7 |
+
language:
|
| 8 |
+
- en
|
| 9 |
+
license: mit
|
| 10 |
+
tags:
|
| 11 |
+
- clip
|
| 12 |
+
- vision
|
| 13 |
+
- multimodal
|
| 14 |
+
- youtube
|
| 15 |
+
- thumbnail-analysis
|
| 16 |
+
pipeline_tag: feature-extraction
|
| 17 |
+
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 18 |
|
| 19 |
+
# Tube Clip (Fine-Tuned CLIP Large)
|
| 20 |
|
| 21 |
+
Tube Clip is a fine-tuned variant of CLIP Large (~1.7 GB) designed to analyze YouTube video thumbnails and titles to predict view performance classes.
|
| 22 |
|
| 23 |
+
## Model Overview
|
| 24 |
|
| 25 |
+
* **Architecture:** CLIP (Vision + Text Transformer) fine-tuned on YouTube thumbnail and title distributions.
|
| 26 |
+
* **Input:** Video thumbnail image + video title string.
|
| 27 |
+
* **Output:** Predicted view tier / performance classification.
|
| 28 |
+
* **Weight Size:** ~1.7 GB
|
| 29 |
|
| 30 |
+
## Usage
|
| 31 |
|
| 32 |
+
You can download the model weights directly or load them via the Hugging Face Hub:
|
| 33 |
|
| 34 |
+
```python
|
| 35 |
+
from huggingface_hub import hf_hub_download
|
| 36 |
+
import torch
|
| 37 |
|
| 38 |
+
# Download weights
|
| 39 |
+
model_path = hf_hub_download(
|
| 40 |
+
repo_id="your-username/tube-clip",
|
| 41 |
+
filename="pytorch_model.bin" # replace with your actual file name
|
| 42 |
+
)
|
| 43 |
|
| 44 |
+
# Load into your custom architecture
|
| 45 |
+
# model.load_state_dict(torch.load(model_path, map_location="cpu"))
|
| 46 |
|
| 47 |
+
```
|
| 48 |
|
| 49 |
+
## Associated Research & Analysis
|
| 50 |
|
| 51 |
+
This model was evaluated on a 100,000-video stratified evaluation pipeline. For data pipelines, reproduction scripts, and methodology, visit the main GitHub repository:
|
| 52 |
|
| 53 |
+
* **GitHub Repository:** [100k-thumbnail-analysis](https://github.com/krishnendu1233/100k-thumbnail-analysis)
|
| 54 |
|
| 55 |
+
```
|
| 56 |
|
| 57 |
+
---
|
| 58 |
|
| 59 |
+
### 2. How Users Can Download It
|
| 60 |
|
| 61 |
+
Once your weights (e.g., `pytorch_model.bin`, `model.safetensors`, or `tube_clip.pt`) are uploaded to the repo, users can download the model in three standard ways:
|
| 62 |
|
| 63 |
+
1. **Direct Web Download:**
|
| 64 |
+
Anyone can click on the **Files and versions** tab in your Hugging Face repository, click the file, and press the **download** button.
|
| 65 |
|
| 66 |
+
2. **Via Python (`huggingface_hub`):**
|
| 67 |
+
Users can fetch the weights programmatically in one line:
|
| 68 |
+
```python
|
| 69 |
+
from huggingface_hub import hf_hub_download
|
| 70 |
|
| 71 |
+
file_path = hf_hub_download(repo_id="your-username/tube-clip", filename="model.safetensors")
|
| 72 |
|
| 73 |
+
```
|
| 74 |
|
| 75 |
+
3. **Via Git LFS:**
|
| 76 |
+
Users can clone the entire repository and weights using terminal:
|
| 77 |
+
```bash
|
| 78 |
+
git lfs install
|
| 79 |
+
git clone https://huggingface.co/your-username/tube-clip
|
| 80 |
|
| 81 |
+
```
|