tods/datasets/data-supply/schemas/problemSchema.json

{
	"about":{"type":"dict", "required":true, "allow_unknown":true, "schema": {
		"problemID":{"type":"string", "required":true, "empty":false},
		"problemName":{"type":"string", "required":true, "empty":false},
		"problemDescription":{"type":"string", "required":false},
		"problemURI":{"type":"string","required":false},
		"taskKeywords":{"type":"list", "required":true, "schema":{"type":"string"}},
		"problemVersion":{"type":"string", "required":true},
		"problemSchemaVersion":{"type":"string", "required":true}
	}},
	"inputs":{"type":"dict","required":true,"allow_unknown":true,"schema":{
		"data":{"type":"list","required":true,"schema":{"type":"dict", "required": true, "allow_unknown":true, "schema": {
			"datasetID":{"type":"string","required":true},
			"targets":{"type":"list", "required":true,"schema":{"type":"dict","required":true,"allow_unknown":true,"schema":{
				"targetIndex":{"type":"integer","required":true},
				"resID":{"type":"string","required":true},
				"colIndex":{"type":"integer", "required":true},
				"colName":{"type":"string","required":true},
				"numClusters":{"type":"integer","required":false}
			}}},
			"forecastingHorizon":{"type":"dict", "required":false, "allow_unknown":true, "schema":{
				"resID":{"type":"string","required":true},
				"colIndex":{"type":"integer", "required":true},
				"colName":{"type":"string","required":true},
				"horizonValue":{"type":"number", "required":true}
			}},
			"privilegedData":{"type":"list", "required":false,"schema":{"type":"dict","required":true,"allow_unknown":true,"schema":{
				"privilegedDataIndex":{"type":"integer","required":true},
				"resID":{"type":"string","required":true},
				"colIndex":{"type":"integer", "required":true},
				"colName":{"type":"string","required":true}
			}}}
		}}},
		"dataSplits":{"type":"dict","required":false,"allow_unknown":true,"schema":{
			"method":{"type":"string","required":false},
			"testSize":{"type":"float","required":false,"min":0.0,"max":1.0},
			"numFolds":{"type":"integer","required":false},
			"stratified":{"type":"boolean","required":false},
			"numRepeats":{"type":"integer","required":false},
			"randomSeed":{"type":"integer","required":false},
			"splitsFile":{"type":"string", "required":false},
			"splitScript":{"type":"string", "required":false},
			"datasetViewMaps":{"type":"dict","required":false,"allow_unknown":true,"schema":{
				"train":{"type":"list", "required":false, "schema":{"type":"dict", "required":true, "allow_unknown":true, "schema":{
					"from":{"type":"string", "required":true},
					"to":{"type":"string", "required":true}
				}}},
				"test":{"type":"list", "required":false, "schema":{"type":"dict", "required":true, "allow_unknown":true, "schema":{
					"from":{"type":"string", "required":true},
					"to":{"type":"string", "required":true}
				}}},
				"score":{"type":"list", "required":false, "schema":{"type":"dict", "required":true, "allow_unknown":true, "schema":{
					"from":{"type":"string", "required":true},
					"to":{"type":"string", "required":true}
				}}}
			}}
		}},
		"performanceMetrics":{"type":"list","required":true,"schema":{"type":"dict","required":true,"allow_unknown":true,"schema":{
			"metric":{"type":"string","required":true},
			"K":{"type":"integer","required":false,"dependencies": {"metric":"precisionAtTopK"}},
			"posLabel":{"type":"string","required":false, "dependencies": {"metric":["f1","precision","recall","jaccardSimilarityScore"]}}
		}}}
	}},
	"expectedOutputs":{"type":"dict","required":false,"allow_unknown":true,"schema":{
		"predictionsFile": {"type":"string", "required":false, "default":"predictions.csv"},
		"scoresFile": {"type":"string", "required":false, "default":"scores.csv"}
	}},
	"dataAugmentation":{"type":"list", "required":false,"schema":{"type":"dict","allow_unknown":true,"schema":{
		"domain":{"type":"list","required":false, "schema":{"type":"string"}},
		"keywords":{"type":"list", "required":false, "schema":{"type":"string"}}
	}}}
}