├── LICENSE ├── NOTICE.txt ├── README.md ├── schema.json └── schema.png /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /NOTICE.txt: -------------------------------------------------------------------------------- 1 | MLExperimentsSchema 2 | Copyright 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. 3 | 4 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # ml-experiments-schema 2 | A json-based schema for storing declarative descriptions of machine learning experiments. 3 | 4 | ![Schema](schema.png "Schema") -------------------------------------------------------------------------------- /schema.json: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"). You may not 5 | * use this file except in compliance with the License. A copy of the License 6 | * is located at http://aws.amazon.com/apache2.0/ or in the "license" file 7 | * accompanying this file. This file is distributed on an "AS IS" BASIS, 8 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 9 | * See the License for the specific language governing permissions and 10 | * limitations under the License. 11 | * 12 | */ 13 | 14 | { 15 | "Parameter": { 16 | "title": "Parameter", 17 | "properties": { 18 | "trackedByUser": { 19 | "default": "false", 20 | "type": "boolean", 21 | "description": "denotes whether the user explicitly tracked this parameter." 22 | }, 23 | "nonDefault": { 24 | "default": "false", 25 | "type": "boolean", 26 | "description": "denotes whether the user explicitly changed this parameter from its default value." 27 | }, 28 | "value": { 29 | "minLength": 1, 30 | "type": "string", 31 | "description": "value of the parameter." 32 | }, 33 | "typing": { 34 | "$ref": "#/TypeHint", 35 | "description": "type of the parameter." 36 | }, 37 | "name": { 38 | "minLength": 1, 39 | "type": "string", 40 | "description": "name of the parameter." 41 | } 42 | }, 43 | "required": [ 44 | "name", 45 | "typing", 46 | "value" 47 | ], 48 | "description": "parameter of the feature transformation.", 49 | "type": "object" 50 | }, 51 | "Tag": { 52 | "title": "Tag", 53 | "properties": { 54 | "value": { 55 | "minLength": 1, 56 | "type": "string", 57 | "description": "value of the tag." 58 | }, 59 | "name": { 60 | "minLength": 1, 61 | "type": "string", 62 | "description": "name of the tag." 63 | } 64 | }, 65 | "required": [ 66 | "name", 67 | "value" 68 | ], 69 | "description": "describes tags for the data used for evaluation.", 70 | "type": "object" 71 | }, 72 | "ConfusionMatrix": { 73 | "properties": { 74 | "values": { 75 | "items": { 76 | "format": "int32", 77 | "type": "integer" 78 | }, 79 | "type": "array", 80 | "description": "values of the confusion matrix in column-major order." 81 | }, 82 | "classLabels": { 83 | "items": { 84 | "type": "string" 85 | }, 86 | "type": "array", 87 | "description": "labels for the classes represented in the confusion matrix." 88 | }, 89 | "numberOfClasses": { 90 | "minimum": 1, 91 | "format": "int32", 92 | "type": "integer", 93 | "description": "number of classes represented in the confusion matrix." 94 | } 95 | }, 96 | "required": [ 97 | "numberOfClasses", 98 | "values" 99 | ], 100 | "description": "a confusion matrix to be stored with evaluation data.", 101 | "type": "object" 102 | }, 103 | "Score": { 104 | "properties": { 105 | "value": { 106 | "minLength": 1, 107 | "type": "string", 108 | "description": "value of the score." 109 | }, 110 | "typing": { 111 | "$ref": "#/TypeHint", 112 | "description": "type of the value." 113 | }, 114 | "metric": { 115 | "minLength": 1, 116 | "type": "string", 117 | "description": "metric for the score." 118 | } 119 | }, 120 | "required": [ 121 | "metric", 122 | "typing", 123 | "value" 124 | ], 125 | "description": "a statistic to be stored with evaluation data.", 126 | "type": "object" 127 | }, 128 | "ScoreAtTime": { 129 | "properties": { 130 | "epoch": { 131 | "format": "int32", 132 | "type": "integer", 133 | "description": "a discrete time unit (e.g. an iteration) to which this score refers to." 134 | }, 135 | "score": { 136 | "$ref": "#/Score", 137 | "description": "the actual score." 138 | }, 139 | "timestamp": { 140 | "minimum": 0, 141 | "format": "int64", 142 | "type": "integer", 143 | "description": "time (milliseconds since 1970-01-01)." 144 | } 145 | }, 146 | "required": [ 147 | "timestamp", 148 | "score" 149 | ], 150 | "description": "a statistic over time to be stored with training metadata.", 151 | "type": "object" 152 | }, 153 | "Evaluation": { 154 | "title": "Evaluation", 155 | "properties": { 156 | "forPredictionId": { 157 | "minLength": 1, 158 | "type": "string", 159 | "description": "identifier of the metadata entry for the predictions on which this evaluation was computed." 160 | }, 161 | "name": { 162 | "minLength": 1, 163 | "type": "string", 164 | "description": "name of this evaluation." 165 | }, 166 | "id": { 167 | "minLength": 1, 168 | "type": "string", 169 | "description": "Unique identifier for this metadata entry." 170 | }, 171 | "comments": { 172 | "minLength": 1, 173 | "type": "string", 174 | "description": "comments for this evaluation entry." 175 | }, 176 | "annotations": { 177 | "additionalProperties": { 178 | "type": "string" 179 | }, 180 | "type": "object" 181 | }, 182 | "tags": { 183 | "items": { 184 | "$ref": "#/Tag" 185 | }, 186 | "description": "tags to describe the evaluation data.", 187 | "type": "array" 188 | }, 189 | "confusionMatrix": { 190 | "$ref": "#/ConfusionMatrix", 191 | "description": "an optional confusion matrix to store with the evaluation." 192 | }, 193 | "scores": { 194 | "items": { 195 | "$ref": "#/Score" 196 | }, 197 | "description": "scores for different metrics.", 198 | "type": "array" 199 | }, 200 | "computedByModelId": { 201 | "minLength": 1, 202 | "type": "string", 203 | "description": "identifier of the model that was used to compute this evaluation." 204 | }, 205 | "computedOnDatasetId": { 206 | "minLength": 1, 207 | "type": "string", 208 | "description": "identifier of the dataset for which this evaluation have been computed." 209 | }, 210 | "creationTime": { 211 | "minimum": 0, 212 | "format": "int64", 213 | "type": "integer", 214 | "description": "Creation time (milliseconds since 1970-01-01)." 215 | }, 216 | "creatorTeam": { 217 | "minLength": 1, 218 | "type": "string", 219 | "description": "team of the user who created this evaluation." 220 | }, 221 | "creator": { 222 | "minLength": 1, 223 | "type": "string", 224 | "description": "name of the user who created this evaluation." 225 | } 226 | }, 227 | "required": [ 228 | "creationTime", 229 | "computedOnDatasetId", 230 | "computedByModelId" 231 | ], 232 | "description": "evaluation of predictions of a model on a dataset.", 233 | "type": "object" 234 | }, 235 | "DatasetMetadata": { 236 | "title": "DatasetMetadata", 237 | "properties": { 238 | "id": { 239 | "minLength": 1, 240 | "type": "string", 241 | "description": "Unique identifier for this metadata entry." 242 | }, 243 | "derivedFromDatasetId": { 244 | "minLength": 1, 245 | "type": "string", 246 | "description": "identified of the metadata of the dataset from which this dataset was derived, if exists." 247 | }, 248 | "comments": { 249 | "minLength": 1, 250 | "type": "string", 251 | "description": "comments for this dataset metadata entry." 252 | }, 253 | "annotations": { 254 | "additionalProperties": { 255 | "type": "string" 256 | }, 257 | "type": "object", 258 | "description": "custom key-value data to store with this dataset metadata entry" 259 | }, 260 | "creator": { 261 | "minLength": 1, 262 | "type": "string", 263 | "description": "name of the user who created this dataset." 264 | }, 265 | "histograms": { 266 | "items": { 267 | "$ref": "#/Histogram" 268 | }, 269 | "type": "array", 270 | "description": "histograms related to this dataset." 271 | }, 272 | "dataStatistics": { 273 | "items": { 274 | "$ref": "#/DataStatistic" 275 | }, 276 | "type": "array", 277 | "description": "statistics related to this dataset." 278 | }, 279 | "schema": { 280 | "minItems": 1, 281 | "items": { 282 | "$ref": "#/TypedColumn" 283 | }, 284 | "type": "array", 285 | "description": "a description of the names and types of the attributes of the referenced dataset." 286 | }, 287 | "version": { 288 | "minLength": 1, 289 | "type": "string", 290 | "description": "version of the dataset." 291 | }, 292 | "location": { 293 | "minLength": 1, 294 | "type": "string", 295 | "description": "a pointer to the location where users can read the contents of the dataset." 296 | }, 297 | "name": { 298 | "minLength": 1, 299 | "type": "string", 300 | "description": "name of this dataset." 301 | }, 302 | "creationTime": { 303 | "minimum": 0, 304 | "format": "int64", 305 | "type": "integer", 306 | "description": "Creation time (milliseconds since 1970-01-01)." 307 | }, 308 | "creatorTeam": { 309 | "minLength": 1, 310 | "type": "string", 311 | "description": "team of the user who created this dataset." 312 | } 313 | }, 314 | "required": [ 315 | "name", 316 | "location" 317 | ], 318 | "description": "Metadata describing input datasets.", 319 | "type": "object" 320 | }, 321 | "Histogram": { 322 | "properties": { 323 | "bucketValues": { 324 | "items": { 325 | "type": "string" 326 | }, 327 | "type": "array", 328 | "description": "list of values for the buckets of the histogram." 329 | }, 330 | "bucketLabels": { 331 | "items": { 332 | "type": "string" 333 | }, 334 | "type": "array", 335 | "description": "optional list of labels for the buckets of the histogram." 336 | }, 337 | "typing": { 338 | "$ref": "#/TypeHint", 339 | "description": "type of the bucket values." 340 | }, 341 | "name": { 342 | "minLength": 1, 343 | "type": "string", 344 | "description": "optional name for the histogram." 345 | }, 346 | "column": { 347 | "minLength": 1, 348 | "type": "string", 349 | "description": "name of the column to which this histogram refers." 350 | } 351 | }, 352 | "required": [ 353 | "column", 354 | "typing", 355 | "bucketValues" 356 | ], 357 | "description": "a histogram for a column of a dataset.", 358 | "type": "object" 359 | }, 360 | "Transform": { 361 | "title": "FeatureTransform", 362 | "properties": { 363 | "name": { 364 | "minLength": 1, 365 | "type": "string", 366 | "description": "name of the feature transformation." 367 | }, 368 | "id": { 369 | "minLength": 1, 370 | "type": "string", 371 | "description": "Unique identifier for this metadata entry." 372 | }, 373 | "fromFramework": { 374 | "minLength": 1, 375 | "type": "string", 376 | "description": "framework used to train the model." 377 | }, 378 | "version": { 379 | "minLength": 1, 380 | "type": "string", 381 | "description": "version of the model." 382 | }, 383 | "state": { 384 | "minLength": 1, 385 | "type": "string", 386 | "description": "encoded internal state of the feature transformation (optional)" 387 | }, 388 | "fromFrameworkVersion": { 389 | "minLength": 1, 390 | "type": "string", 391 | "description": "version of the framework used to train the model." 392 | }, 393 | "input": { 394 | "items": { 395 | "$ref": "#/TypedColumn" 396 | }, 397 | "description": "required input columns for the feature transformation.", 398 | "type": "array" 399 | }, 400 | "inputTransforms": { 401 | "items": { 402 | "type": "string" 403 | }, 404 | "description": "ids of Transforms that produce the input for this Transform in the transformation DAG.", 405 | "type": "array" 406 | }, 407 | "parameters": { 408 | "items": { 409 | "$ref": "#/Parameter" 410 | }, 411 | "description": "parameters of the feature transformation.", 412 | "type": "array" 413 | }, 414 | "output": { 415 | "items": { 416 | "$ref": "#/TypedColumn" 417 | }, 418 | "description": "output columns of the feature transformation.", 419 | "type": "array" 420 | } 421 | }, 422 | "required": [ 423 | "id", 424 | "name" 425 | ], 426 | "description": "a transformation applied to the input dataset.", 427 | "type": "object" 428 | }, 429 | "DataStatistic": { 430 | "properties": { 431 | "value": { 432 | "minLength": 1, 433 | "type": "string", 434 | "description": "value of the statistic." 435 | }, 436 | "typing": { 437 | "$ref": "#/TypeHint", 438 | "description": "type of the value." 439 | }, 440 | "columns": { 441 | "items": { 442 | "type": "string" 443 | }, 444 | "type": "array", 445 | "description": "columns to which this statistic corresponds. leave this empty for statistics corresponding the whole dataset." 446 | }, 447 | "name": { 448 | "minLength": 1, 449 | "type": "string", 450 | "description": "name of the data statistic." 451 | } 452 | }, 453 | "required": [ 454 | "name", 455 | "typing", 456 | "value" 457 | ], 458 | "description": "a statistic about a dataset (or columns of it).", 459 | "type": "object" 460 | }, 461 | "TrainingRun": { 462 | "properties": { 463 | "creator": { 464 | "minLength": 1, 465 | "type": "string", 466 | "description": "name of the user who created this model." 467 | }, 468 | "id": { 469 | "minLength": 1, 470 | "type": "string", 471 | "description": "Unique identifier for this metadata entry." 472 | }, 473 | "environment": { 474 | "additionalProperties": { 475 | "type": "string" 476 | }, 477 | "type": "object", 478 | "description": "custom key-value data to store with this training run entry" 479 | }, 480 | "scoresOverTime": { 481 | "items": { 482 | "$ref": "#/ScoreAtTime" 483 | }, 484 | "description": "scores collected during the training run.", 485 | "type": "array" 486 | }, 487 | "hyperparameters": { 488 | "items": { 489 | "$ref": "#/Parameter" 490 | }, 491 | "description": "hyperparameters used when training the model.", 492 | "type": "array" 493 | }, 494 | "transforms": { 495 | "items": { 496 | "$ref": "#/Transform" 497 | }, 498 | "description": "the transformations applied to the input data.", 499 | "type": "array" 500 | }, 501 | "endTime": { 502 | "minimum": 0, 503 | "format": "int64", 504 | "type": "integer", 505 | "description": "end time (milliseconds since 1970-01-01)." 506 | }, 507 | "startTime": { 508 | "minimum": 0, 509 | "format": "int64", 510 | "type": "integer", 511 | "description": "start time (milliseconds since 1970-01-01)." 512 | }, 513 | "forModelId": { 514 | "minLength": 1, 515 | "description": "id of the corresponding model metadata entry.", 516 | "type": "string" 517 | }, 518 | "name": { 519 | "minLength": 1, 520 | "type": "string", 521 | "description": "name of this training run entry." 522 | }, 523 | "creationTime": { 524 | "minimum": 0, 525 | "format": "int64", 526 | "type": "integer", 527 | "description": "Creation time (milliseconds since 1970-01-01)." 528 | }, 529 | "creatorTeam": { 530 | "minLength": 1, 531 | "type": "string", 532 | "description": "team of the user who created this model." 533 | }, 534 | "annotations": { 535 | "additionalProperties": { 536 | "type": "string" 537 | }, 538 | "type": "object", 539 | "description": "custom key-value data to store with this training run entry" 540 | }, 541 | "comments": { 542 | "minLength": 1, 543 | "type": "string", 544 | "description": "comments for this model training run entry." 545 | } 546 | }, 547 | "required": [ 548 | "id", 549 | "creationTime", 550 | "forModelId" 551 | ], 552 | "description": "training run of a model.", 553 | "type": "object" 554 | }, 555 | "TypeHint": { 556 | "enum": [ 557 | "UNKNOWN", 558 | "BOOLEAN", 559 | "LONG", 560 | "FLOAT", 561 | "STRING", 562 | "STRING_ARRAY", 563 | "INT", 564 | "INT_ARRAY", 565 | "DOUBLE", 566 | "DOUBLE_ARRAY", 567 | "VECTOR", 568 | "STRUCT_ARRAY" 569 | ], 570 | "title": "TypeHint", 571 | "description": "describes the type of data items.", 572 | "type": "string" 573 | }, 574 | "TypedColumn": { 575 | "title": "TypedColumn", 576 | "properties": { 577 | "typing": { 578 | "$ref": "#/TypeHint", 579 | "description": "type of the column." 580 | }, 581 | "name": { 582 | "minLength": 1, 583 | "type": "string", 584 | "description": "name of the column." 585 | } 586 | }, 587 | "required": [ 588 | "name", 589 | "typing" 590 | ], 591 | "description": "a column with its type.", 592 | "type": "object" 593 | }, 594 | "PredictionMetadata": { 595 | "title": "PredictionMetadata", 596 | "properties": { 597 | "computedOnDatasetId": { 598 | "minLength": 1, 599 | "type": "string", 600 | "description": "identifier of the dataset for which these predictions have been computed." 601 | }, 602 | "computedByModelId": { 603 | "minLength": 1, 604 | "type": "string", 605 | "description": "identifier of the model that was used to compute these predictions." 606 | }, 607 | "location": { 608 | "minLength": 1, 609 | "type": "string", 610 | "description": "a pointer to the actual prediction data described by the metadata entry." 611 | }, 612 | "comments": { 613 | "minLength": 1, 614 | "type": "string", 615 | "description": "comments for this prediction metadata entry." 616 | }, 617 | "annotations": { 618 | "additionalProperties": { 619 | "type": "string" 620 | }, 621 | "type": "object", 622 | "description": "custom key-value data to store with this prediction metadata entry" 623 | }, 624 | "schema": { 625 | "items": { 626 | "$ref": "#/TypedColumn" 627 | }, 628 | "description": "schema for the computed predictions.", 629 | "type": "array" 630 | }, 631 | "creatorTeam": { 632 | "minLength": 1, 633 | "type": "string", 634 | "description": "team of the user who created this prediction." 635 | }, 636 | "creationTime": { 637 | "minimum": 0, 638 | "format": "int64", 639 | "type": "integer", 640 | "description": "Creation time (milliseconds since 1970-01-01)." 641 | }, 642 | "creator": { 643 | "minLength": 1, 644 | "type": "string", 645 | "description": "name of the user who created this prediction." 646 | }, 647 | "name": { 648 | "minLength": 1, 649 | "type": "string", 650 | "description": "name of this prediction." 651 | }, 652 | "id": { 653 | "minLength": 1, 654 | "type": "string", 655 | "description": "Unique identifier for this metadata entry." 656 | } 657 | }, 658 | "required": [ 659 | "creationTime", 660 | "computedOnDatasetId", 661 | "computedByModelId" 662 | ], 663 | "description": "metadata for predictions computed by a model on a dataset.", 664 | "type": "object" 665 | }, 666 | "ModelMetadata": { 667 | "title": "ModelMetadata", 668 | "properties": { 669 | "comments": { 670 | "minLength": 1, 671 | "type": "string", 672 | "description": "comments for this model metadata entry." 673 | }, 674 | "fromFrameworkVersion": { 675 | "minLength": 1, 676 | "type": "string", 677 | "description": "version of the framework used to train the model." 678 | }, 679 | "fromFramework": { 680 | "minLength": 1, 681 | "type": "string", 682 | "description": "framework used to train the model." 683 | }, 684 | "version": { 685 | "minLength": 1, 686 | "type": "string", 687 | "description": "version of the model." 688 | }, 689 | "learningAlgorithm": { 690 | "minLength": 1, 691 | "type": "string", 692 | "description": "name of the learning algorithm that was used to train the model." 693 | }, 694 | "trainedOnDatasetId": { 695 | "minLength": 1, 696 | "type": "string", 697 | "description": "identifier of the dataset on which this model has been trained." 698 | }, 699 | "name": { 700 | "minLength": 1, 701 | "type": "string", 702 | "description": "name of this model metadata entry." 703 | }, 704 | "annotations": { 705 | "additionalProperties": { 706 | "type": "string" 707 | }, 708 | "type": "object", 709 | "description": "custom key-value data to store with this model metadata entry" 710 | }, 711 | "creator": { 712 | "minLength": 1, 713 | "type": "string", 714 | "description": "name of the user who created this model." 715 | }, 716 | "creatorTeam": { 717 | "minLength": 1, 718 | "type": "string", 719 | "description": "team of the user who created this model." 720 | }, 721 | "creationTime": { 722 | "minimum": 0, 723 | "format": "int64", 724 | "type": "integer", 725 | "description": "Creation time (milliseconds since 1970-01-01)." 726 | }, 727 | "id": { 728 | "minLength": 1, 729 | "type": "string", 730 | "description": "Unique identifier for this metadata entry." 731 | }, 732 | "hyperparameters": { 733 | "items": { 734 | "$ref": "#/Parameter" 735 | }, 736 | "description": "hyperparameters used when training the model.", 737 | "type": "array" 738 | }, 739 | "location": { 740 | "minLength": 1, 741 | "type": "string", 742 | "description": "a pointer to a location where users can read the contents of the model." 743 | }, 744 | "transforms": { 745 | "items": { 746 | "$ref": "#/Transform" 747 | }, 748 | "description": "the transformations applied to the input data.", 749 | "type": "array" 750 | }, 751 | "input": { 752 | "items": { 753 | "$ref": "#/TypedColumn" 754 | }, 755 | "description": "the input columns which this model consumes from the transformed data.", 756 | "type": "array" 757 | } 758 | }, 759 | "required": [ 760 | "creationTime", 761 | "name", 762 | "trainedOnDatasetId", 763 | "learningAlgorithm" 764 | ], 765 | "description": "Metadata for models trained on an input dataset.", 766 | "type": "object" 767 | }, 768 | "TrainingState": { 769 | "enum": [ 770 | "TRAINING", 771 | "FINISHED", 772 | "FAILED" 773 | ], 774 | "title": "TrainingState", 775 | "description": "describes the state of a model during training.", 776 | "type": "string" 777 | } 778 | } 779 | -------------------------------------------------------------------------------- /schema.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/awslabs/ml-experiments-schema/a93877b9d50fe509fb644e02a29b465a5452c75b/schema.png --------------------------------------------------------------------------------