-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathmodel.yaml
More file actions
150 lines (134 loc) · 5.45 KB
/
model.yaml
File metadata and controls
150 lines (134 loc) · 5.45 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
# The version of the model specification.
specification: '0.3'
# Model input type. Only "file" is supported at this time.
type: file
source: bah
# The version of the model. This should correspond to the version
# of the model container image. Version numbers must be specified
# as three dot separated integers, for example '2.1.0'.
version:
# The human readable name of the model.
name:
# The author of the model.
author:
# Model detail information.
description:
# A one or two sentence summary of what this model does.
summary:
# A longer description of the model. This value supports content
# in Markdown format for including rich text, links, images, etc.
details:
# Technical details. This value
# supports content in Markdown format for including rich
# text, links, images, etc.
# Three recommended sections: Overview, Training, and Validation (Use Markdown to create the section headers)
# Overview: which model architecture was chosen and why
# Training: Where the data came from, preprocessing that was performed,
# how long the model took to train on what hardware, model hyperparameters
# Validation: what data was used for validation
technical: |-
#OVERVIEW:
#TRAINING:
#VALIDATION:
#INPUT SPECIFICATION:
The input(s) to this model must adhere to the following specifications:
| Filename | Maximum Size | Accepted Format(s) |
| -------- | ------------ | ------------------ |
Additional information describing input file(s) can go in a short paragraph here if necessary. Feel free to add an additional markdown table if many values need to be listed.
#OUTPUT DETAILS:
This model will output the following:
| Filename | Maximum Size | Format |
| -------- | ------------ | ------ |
Additional information describing the output file(s) can go in a short paragraph here. Feel free to add an additional markdown table if many values need to be listed. If you want to use an additional table, please use the following headerless format:
| | | | |
|-|-|-|-|
| Entry 1 | Entry 2 | Entry 3 | Entry 4 |
| Entry 5 | Entry 6 | Entry 7 | Entry 8 |
# Metrics that describe the model's performance (if no relevant metrics provide explanation why)
# Specify which dataset these metrics were evaluated on
performance:
# Use this format: "VERSION_NUMBER - Concise sentence describing what is new in this version of the model."
# Example: "0.0.11 - Achieves precision of 98.15%, recall of 90.61%, and F1 score of 89.72% on CoNLL-2003 validation dataset."
releaseNotes:
# Tags and filters help users find this model.
tags:
-
filters:
- type:
label:
- type:
label:
# This section contains the data science metrics for your model
# Each metric contains a human-readable label along with a
# decimal value between 0 and 1.
metrics:
- label:
type:
value:
description:
# Please indicate the names and kinds of input(s) that your model
# expects. The names and types you specify here will be used to
# validate inputs supplied by inference job requests.
inputs:
# The value of this key will be the name of the file that is
# supplied to your model for processing
input.txt:
# The expected media types of this file. For more information
# on media types, see:
# https://www.iana.org/assignments/media-types/media-types.xhtml
acceptedMediaTypes:
-
# The maximum size that this file is expected to be.
maxSize:
# A human readable description of what this file is expected to
# be. This value supports content in Markdown format for including
# rich text, links, images, etc.
description:
# Please indicate the names and kinds of output(s) that your model
# writes out.
outputs:
results.json:
# The expected media types of this file. For more information
# on media types, see:
# https://www.iana.org/assignments/media-types/media-types.xhtml
mediaType:
# The maximum size that this file is expected to be.
maxSize:
# A human readable description of what this file is expected to
# be. This value supports content in Markdown format for including
# rich text, links, images, etc.
description: |
# The resources section indicates what resources are required by your model
# in order to run efficiently. Keep in mind that there may be many instances
# of your model running at any given time so please be conservative with the
# values you specify here.
resources:
memory:
# The amount of RAM required by your model, e.g. 512M or 1G
size:
cpu:
# CPU count should be specified as the number of fractional CPUs that
# are needed. For example, 1 == one CPU core.
count:
gpu:
# GPU count must be an integer.
count:
# Please specify a timeout value that indicates a time at which
# requests to your model should be canceled. If you are using a
# webserver with built in timeouts within your container such as
# gunicorn make sure to adjust those timeouts accordingly.
timeout:
# Status timeout indicates the timeout threshhold for calls to your
# model's `/status` route, e.g. 20s
status:
# Run timeout indicates the timeout threshhold for files submitted
# to your model for processing, e.g. 20s
run:
# Please set the following flags to either true or false.
internal:
recommended:
experimental:
available:
features:
explainable:
adversarialDefense: