Commit
·
06490cd
1
Parent(s):
cfc353f
Update README.md
Browse files
README.md
CHANGED
@@ -1,3 +1,137 @@
|
|
1 |
---
|
2 |
pipeline_tag: zero-shot-classification
|
3 |
-
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
---
|
2 |
pipeline_tag: zero-shot-classification
|
3 |
+
---
|
4 |
+
|
5 |
+
## Model Name: _
|
6 |
+
|
7 |
+
**Team Name: _**
|
8 |
+
|
9 |
+
**Owner: _**
|
10 |
+
|
11 |
+
**Last Updated: _**
|
12 |
+
|
13 |
+
**Last Updated By: _**
|
14 |
+
|
15 |
+
**Model Task: _**
|
16 |
+
|
17 |
+
**Model Library: _**
|
18 |
+
|
19 |
+
**GCP Project: _**
|
20 |
+
|
21 |
+
**Model Hosting Platform: _**
|
22 |
+
|
23 |
+
## THD Partners
|
24 |
+
**Additional Contributors:** _
|
25 |
+
|
26 |
+
**Engineering Support:** _
|
27 |
+
|
28 |
+
**Product Support:** _
|
29 |
+
|
30 |
+
**VP or Initiative Owner** _
|
31 |
+
|
32 |
+
|
33 |
+
## Important Links
|
34 |
+
|
35 |
+
**Source Code** [Place Link here and in proceeding () to hyperlink](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)
|
36 |
+
|
37 |
+
**Model Running Location** [Link to Hyperlink]()
|
38 |
+
|
39 |
+
**Confluence** [Link to Confluence]()
|
40 |
+
|
41 |
+
|
42 |
+
## Overview
|
43 |
+
**Problem Statement**
|
44 |
+
|
45 |
+
This is where your models problem statement goes.
|
46 |
+
|
47 |
+
**Intended Use & Limitations**
|
48 |
+
|
49 |
+
This is where the intended use for your model and various limitations it may have goes.
|
50 |
+
|
51 |
+
**Business Value**
|
52 |
+
|
53 |
+
This is where the business value of your model goes.
|
54 |
+
|
55 |
+
**Summary of Results**
|
56 |
+
|
57 |
+
This is where the summary of the results your model produced goes.
|
58 |
+
|
59 |
+
|
60 |
+
|
61 |
+
|
62 |
+
## Training Data
|
63 |
+
**Dataset Used to Train Model**
|
64 |
+
|
65 |
+
Here, you can explain some details about the data set that you trained the model on.
|
66 |
+
|
67 |
+
Link Description: [Link to hyperlink]()
|
68 |
+
|
69 |
+
**Datasets**
|
70 |
+
|
71 |
+
Data Set Name [Link to dataset]()
|
72 |
+
|
73 |
+
Data Set Name [Link to dataset]()
|
74 |
+
|
75 |
+
Data Set Name [Link to dataset]()
|
76 |
+
|
77 |
+
|
78 |
+
## How to Run
|
79 |
+
|
80 |
+
This is where a detailed report on how to run your model goes.
|
81 |
+
|
82 |
+
[Link to start code]()
|
83 |
+
|
84 |
+
|
85 |
+
## Model Architecture
|
86 |
+
|
87 |
+
This is where the description of the model architecture goes.
|
88 |
+
|
89 |
+
Github: [Link to Github]()
|
90 |
+
|
91 |
+
|
92 |
+
## Model Metrics
|
93 |
+
**Metrics of Success**
|
94 |
+
|
95 |
+
This is where a description of the different metrics that your model is capturing goes.
|
96 |
+
|
97 |
+
| Metric | Result |
|
98 |
+
| :----: | :----: |
|
99 |
+
| Latency | # |
|
100 |
+
| Accuracy | # |
|
101 |
+
| Metric | # |
|
102 |
+
|
103 |
+
## Description of Features
|
104 |
+
|
105 |
+
- Feature 1
|
106 |
+
- Feature 2
|
107 |
+
- Feature 3
|
108 |
+
|
109 |
+
This is where a description of the features listed above goes.
|
110 |
+
|
111 |
+
## Research
|
112 |
+
|
113 |
+
This is where a detailed report of your research goes.
|
114 |
+
|
115 |
+
Research Link: [Link to Research]()
|
116 |
+
|
117 |
+
Link Description: [Link to Description]()
|
118 |
+
|
119 |
+
Name of Link: [Link]()
|
120 |
+
|
121 |
+
|
122 |
+
## Additional Fields
|
123 |
+
### Title
|
124 |
+
|
125 |
+
This is where additional information can be written.
|
126 |
+
|
127 |
+
### Title
|
128 |
+
|
129 |
+
This is where additional information can be written.
|
130 |
+
|
131 |
+
## Associated Models
|
132 |
+
**Model Name Goes Here**
|
133 |
+
**Model Name Goes Here**
|
134 |
+
|
135 |
+
|
136 |
+
|
137 |
+
|