Harsha901 commited on
Commit
42c98c2
·
verified ·
1 Parent(s): c3b7606

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +89 -171
README.md CHANGED
@@ -1,199 +1,117 @@
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
 
12
  ## Model Details
13
 
14
- ### Model Description
15
-
16
- <!-- Provide a longer summary of what this model is. -->
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:** [More Information Needed]
21
- - **Funded by [optional]:** [More Information Needed]
22
- - **Shared by [optional]:** [More Information Needed]
23
- - **Model type:** [More Information Needed]
24
- - **Language(s) (NLP):** [More Information Needed]
25
- - **License:** [More Information Needed]
26
- - **Finetuned from model [optional]:** [More Information Needed]
27
 
28
- ### Model Sources [optional]
29
-
30
- <!-- Provide the basic links for the model. -->
31
 
32
- - **Repository:** [More Information Needed]
33
- - **Paper [optional]:** [More Information Needed]
34
- - **Demo [optional]:** [More Information Needed]
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
35
 
36
- ## Uses
37
 
38
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
39
 
40
  ### Direct Use
 
 
41
 
42
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
43
-
44
- [More Information Needed]
45
-
46
- ### Downstream Use [optional]
47
-
48
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
49
-
50
- [More Information Needed]
51
-
52
- ### Out-of-Scope Use
53
-
54
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
55
-
56
- [More Information Needed]
57
-
58
- ## Bias, Risks, and Limitations
59
-
60
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
61
-
62
- [More Information Needed]
63
-
64
- ### Recommendations
65
-
66
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
67
-
68
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
69
-
70
- ## How to Get Started with the Model
71
-
72
- Use the code below to get started with the model.
73
-
74
- [More Information Needed]
75
-
76
- ## Training Details
77
-
78
- ### Training Data
79
-
80
- <!-- 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. -->
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
-
90
- [More Information Needed]
91
-
92
-
93
- #### Training Hyperparameters
94
-
95
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
96
-
97
- #### Speeds, Sizes, Times [optional]
98
-
99
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
100
-
101
- [More Information Needed]
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
- <!-- This should link to a Dataset Card if possible. -->
112
-
113
- [More Information Needed]
114
-
115
- #### Factors
116
-
117
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
118
-
119
- [More Information Needed]
120
-
121
- #### Metrics
122
-
123
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
124
-
125
- [More Information Needed]
126
-
127
- ### Results
128
-
129
- [More Information Needed]
130
-
131
- #### Summary
132
-
133
-
134
-
135
- ## Model Examination [optional]
136
-
137
- <!-- Relevant interpretability work for the model goes here -->
138
-
139
- [More Information Needed]
140
-
141
- ## Environmental Impact
142
-
143
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
144
-
145
- 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).
146
-
147
- - **Hardware Type:** [More Information Needed]
148
- - **Hours used:** [More Information Needed]
149
- - **Cloud Provider:** [More Information Needed]
150
- - **Compute Region:** [More Information Needed]
151
- - **Carbon Emitted:** [More Information Needed]
152
-
153
- ## Technical Specifications [optional]
154
-
155
- ### Model Architecture and Objective
156
-
157
- [More Information Needed]
158
-
159
- ### Compute Infrastructure
160
-
161
- [More Information Needed]
162
-
163
- #### Hardware
164
-
165
- [More Information Needed]
166
-
167
- #### Software
168
-
169
- [More Information Needed]
170
-
171
- ## Citation [optional]
172
-
173
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
174
-
175
- **BibTeX:**
176
-
177
- [More Information Needed]
178
 
179
- **APA:**
180
 
181
- [More Information Needed]
 
182
 
183
- ## Glossary [optional]
184
 
185
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
 
 
186
 
187
- [More Information Needed]
188
 
189
- ## More Information [optional]
190
 
191
- [More Information Needed]
192
 
193
- ## Model Card Authors [optional]
 
194
 
195
- [More Information Needed]
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
196
 
197
- ## Model Card Contact
 
 
198
 
199
- [More Information Needed]
 
 
 
 
 
 
1
  ---
2
  library_name: transformers
3
+ tags:
4
+ - image-classification
5
+ - vision-transformer
6
+ - computer-vision
7
+ - human-action-recognition
8
+ license: mit
9
+ language:
10
+ - en
11
+ metrics:
12
+ - accuracy
13
+ base_model:
14
+ - google/vit-base-patch16-224-in21k
15
+ pipeline_tag: image-classification
16
  ---
17
 
18
+ # ViT Human Action Recognition Model
 
 
19
 
20
+ This is a fine-tuned Vision Transformer (ViT) model for image-based multi-class human action recognition. The model predicts one of 15 common human activities such as "running", "eating", "texting", or "using a laptop" from static images.
21
 
22
+ ---
23
 
24
  ## Model Details
25
 
26
+ - **Base Model:** [google/vit-base-patch16-224-in21k](https://huggingface.co/google/vit-base-patch16-224-in21k)
27
+ - **Developed by:** Harsha Vardhan Mannem
28
+ - **Task:** Image Classification
29
+ - **Architecture:** Vision Transformer (ViT)
30
+ - **Total Classes:** 15
31
+ - **Language:** N/A (Vision Model)
32
+ - **License:** MIT
 
 
 
 
 
 
33
 
34
+ ---
 
 
35
 
36
+ ## Supported Classes
37
+
38
+ The model predicts the following 15 activities:
39
+
40
+ - `calling`
41
+ - `clapping`
42
+ - `cycling`
43
+ - `dancing`
44
+ - `drinking`
45
+ - `eating`
46
+ - `fighting`
47
+ - `hugging`
48
+ - `laughing`
49
+ - `listening_to_music`
50
+ - `running`
51
+ - `sitting`
52
+ - `sleeping`
53
+ - `texting`
54
+ - `using_laptop`
55
 
56
+ ---
57
 
58
+ ## Intended Use
59
 
60
  ### Direct Use
61
+ - Predicts human activity from a single image
62
+ - Useful for research, prototypes, computer vision pipelines involving human action detection
63
 
64
+ ### Limitations & Risks
65
+ - Not designed for multi-label scenarios (only one action per image)
66
+ - Not intended for video recognition tasks
67
+ - Accuracy may degrade with poor lighting, extreme angles, or occlusions
68
+ - Model may reflect biases present in the training data
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
69
 
70
+ ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
71
 
72
+ ## Quickstart Example
73
 
74
+ ```python
75
+ from transformers import pipeline
76
 
77
+ pipe = pipeline("image-classification", model="harsha90145/vit-human-pose-classification-model")
78
 
79
+ url = "https://images.pexels.com/photos/1755385/pexels-photo-1755385.jpeg"
80
+ output = pipe(url)
81
+ print(output)
82
 
83
+ Example Output:
84
 
85
+ [{'label': 'running', 'score': 0.92}]
86
 
 
87
 
88
+ ## Evaluation Results
89
+ Test set size: 2520 samples
90
 
91
+ Class Precision Recall F1-Score Support
92
+ calling 0.66 0.69 0.67 159
93
+ clapping 0.82 0.81 0.82 191
94
+ cycling 0.94 0.92 0.93 167
95
+ dancing 0.91 0.83 0.87 155
96
+ drinking 0.79 0.82 0.81 170
97
+ eating 0.83 0.86 0.85 169
98
+ fighting 0.85 0.89 0.87 154
99
+ hugging 0.77 0.81 0.79 149
100
+ laughing 0.80 0.77 0.78 176
101
+ listening_to_music 0.75 0.65 0.70 179
102
+ running 0.80 0.88 0.84 159
103
+ sitting 0.65 0.67 0.66 166
104
+ sleeping 0.80 0.81 0.81 167
105
+ texting 0.67 0.66 0.66 179
106
+ using_laptop 0.72 0.69 0.71 180
107
 
108
+ Overall Accuracy: 78%
109
+ Macro F1 Score: 78%
110
+ Weighted F1 Score: 78%
111
 
112
+ @misc{harsha2024humanactionvit,
113
+ title={ViT-based Human Action Recognition Model},
114
+ author={Harsha Vardhan Mannem},
115
+ howpublished={\url{https://huggingface.co/harsha90145/vit-human-pose-classification-model}},
116
+ year={2024}
117
+ }