--- swagger: "2.0" info: description: "REST API for sharing, organizing and reusing machine learning datasets,\ \ code, and experiments. Follows a predictive URL scheme from endpoint https://www.openml.org/api/v1/json\ \ (or /xml). You need to add your `api_key` to every call (see your account settings),\ \ or simply log in. See https://www.openml.org/api_data_docs for the file server\ \ API." version: "1.0.0" title: "OpenML API" basePath: "/api/v1/json" schemes: - "https" produces: - "application/json" paths: /data/{id}: get: tags: - "data" summary: "Get dataset description" description: "Returns information about a dataset. The information includes\ \ the name, information about the creator, URL to download it and more.\n" parameters: - name: "id" in: "path" description: "Id of the dataset." required: true type: "number" format: "integer" - name: "api_key" in: "query" description: "Api key to authenticate the user" required: false type: "string" responses: 110: description: "Please provide data_id." 111: description: "Unknown dataset. Data set description with data_id was not\ \ found in the database." 112: description: "No access granted. This dataset is not shared with you." 200: description: "A dataset description" examples: application/json: "{\n \"data_set_description\": {\n \"id\": \"1\"\ ,\n \"name\": \"anneal\",\n \"version\": \"2\",\n \"description\"\ : \"...\",\n \"format\": \"ARFF\",\n \"upload_date\": \"2014-04-06\ \ 23:19:20\",\n \"licence\": \"Public\",\n \"url\": \"https://www.openml.org/data/download/1/dataset_1_anneal.arff\"\ ,\n \"file_id\": \"1\",\n \"default_target_attribute\": \"class\"\ ,\n \"version_label\": \"2\",\n \"tag\": [\n \"study_1\"\ ,\n \"uci\"\n ],\n \"visibility\": \"public\",\n \"original_data_url\"\ : \"https://www.openml.org/d/2\",\n \"status\": \"active\",\n \ \ \"md5_checksum\": \"d01f6ccd68c88b749b20bbe897de3713\"\n }\n}" schema: $ref: "#/definitions/Data" delete: tags: - "data" summary: "Delete dataset" description: "Deletes a dataset. Upon success, it returns the ID of the deleted\ \ dataset.\n" parameters: - name: "id" in: "path" description: "Id of the dataset." required: true type: "number" format: "integer" - name: "api_key" in: "query" description: "Api key to authenticate the user" required: true type: "string" responses: 200: description: "ID of the deleted dataset" examples: application/json: "{\n \"data_delete\": {\n \"id\": \"4328\"\n }\n\ }" schema: type: "object" properties: data_delete: $ref: "#/definitions/inline_response_200_data_delete" 350: description: "Please provide API key. In order to remove your content, please\ \ authenticate." 351: description: "Authentication failed. The API key was not valid. Please try\ \ to login again, or contact api administrators." 352: description: "Dataset does not exists. The data ID could not be linked to\ \ an existing dataset." 353: description: "Dataset is not owned by you. The dataset is owned by another\ \ user. Hence you cannot delete it." 354: description: "Dataset is in use by other content. Can not be deleted. The\ \ data is used in tasks or runs. Delete other content before deleting\ \ this dataset." 355: description: "Deleting dataset failed. Deleting the dataset failed. Please\ \ contact support team." /data: post: tags: - "data" summary: "Upload dataset" description: "Uploads a dataset. Upon success, it returns the data id.\n" consumes: - "multipart/form-data" parameters: - name: "description" in: "formData" description: "An XML file describing the dataset. Only name, description,\ \ and data format are required. Also see the [XSD schema](https://www.openml.org/api/v1/xsd/openml.data.upload)\ \ and an [XML example](https://www.openml.org/api/v1/xml_example/data)." required: true type: "file" - name: "dataset" in: "formData" description: "The actual dataset, being an ARFF file." required: true type: "file" - name: "api_key" in: "query" description: "Api key to authenticate the user" required: true type: "string" responses: 130: description: "Problem with file uploading. There was a problem with the\ \ file upload" 131: description: "Problem validating uploaded description file. The XML description\ \ format does not meet the standards" 132: description: "Failed to move the files. Internal server error, please contact\ \ API administrators" 133: description: "Failed to make checksum of datafile. Internal server error,\ \ please contact API administrators" 134: description: "Failed to insert record in database. Internal server error,\ \ please contact API administrators" 135: description: "Please provide description xml." 136: description: "File failed format verification. The uploaded file is not\ \ valid according to the selected file format. Please check the file format\ \ specification and try again." 137: description: "Please provide API key. In order to share content, please\ \ log in or provide your API key." 138: description: "Authentication failed. The API key was not valid. Please try\ \ to login again, or contact API administrators" 139: description: "Combination name / version already exists. Leave version out\ \ for auto increment" 140: description: "Both dataset file and dataset url provided. The system is\ \ confused since both a dataset file (post) and a dataset url (xml) are\ \ provided. Please remove one." 141: description: "Neither dataset file or dataset url are provided. Please provide\ \ either a dataset file as POST variable, or a dataset url in the description\ \ XML" 142: description: "Error in processing arff file. Can be a syntax error, or the\ \ specified target feature does not exists. For now, we only check on\ \ arff files. If a dataset is claimed to be in such a format, and it can\ \ not be parsed, this error is returned." 143: description: "Suggested target feature not legal. It is possible to suggest\ \ a default target feature (for predictive tasks). However, it should\ \ be provided in the data." 144: description: "Unable to update dataset. The dataset with id could not be\ \ found in the database. If you upload a new dataset, unset the id." 200: description: "Id of the uploaded dataset" examples: application/json: "{\n \"upload_data_set\": {\n \"id\": \"4328\"\n\ \ }\n}" schema: type: "object" properties: upload_data_set: $ref: "#/definitions/inline_response_200_1_upload_data_set" /data/qualities: post: tags: - "data" summary: "Upload dataset qualities" description: "Uploads dataset qualities. Upon success, it returns the data id.\n" consumes: - "multipart/form-data" parameters: - name: "description" in: "formData" description: "An XML file describing the dataset. Only name, description,\ \ and data format are required. Also see the [XSD schema](https://www.openml.org/api/v1/xsd/openml.data.qualities)\ \ and an [XML example](https://www.openml.org/api/v1/xml_example/data.qualities)." required: true type: "file" - name: "api_key" in: "query" description: "Api key to authenticate the user" required: true type: "string" responses: 381: description: "Something wrong with XML, please check did and evaluation_engine_id" 382: description: "Please provide description xml" 383: description: "Problem validating uploaded description file" 384: description: "Dataset not processed yet" /data/status/: post: tags: - "data" summary: "Change the status of a dataset" description: "Change the status of a dataset, either 'active' or 'deactivated'\n" consumes: - "multipart/form-data" parameters: - name: "data_id" in: "formData" description: "Id of the dataset." required: true type: "number" format: "integer" - name: "status" in: "formData" description: "The status on which to filter the results, either 'active' or\ \ 'deactivated'." required: true type: "string" - name: "api_key" in: "formData" description: "Api key to authenticate the user" required: true type: "string" responses: 691: description: "Illegal status" 692: description: "Dataset does not exists" 693: description: "Dataset is not owned by you" 694: description: "Illegal status transition" 695: description: "Status update failed" /data/features: post: tags: - "data" summary: "Upload dataset feature description" description: "Uploads dataset feature description. Upon success, it returns\ \ the data id.\n" consumes: - "multipart/form-data" parameters: - name: "description" in: "formData" description: "An XML file describing the dataset. Only name, description,\ \ and data format are required. Also see the [XSD schema](https://www.openml.org/api/v1/xsd/openml.data.features)\ \ and an [XML example](https://www.openml.org/api/v1/xml_example/data.features)." required: true type: "file" - name: "api_key" in: "query" description: "Api key to authenticate the user" required: true type: "string" responses: 431: description: "Dataset already processed" 432: description: "Please provide description xml" 433: description: "Problem validating uploaded description file" 434: description: "Could not find dataset" 436: description: "Something wrong with XML, check did and evaluation engine\ \ id" /data/features/{id}: get: tags: - "data" summary: "Get data features" description: "Returns the features of a dataset.\n" parameters: - name: "id" in: "path" description: "Id of the dataset." required: true type: "number" format: "integer" - name: "api_key" in: "query" description: "Api key to authenticate the user" required: false type: "string" responses: 200: description: "All the features of the dataset" examples: application/json: "{\n \"data_features\": {\n \"feature\": [\n \ \ {\n \"index\": \"0\",\n \"name\": \"sepallength\"\ ,\n \"data_type\": \"numeric\",\n \"is_target\": \"false\"\ ,\n \"is_ignore\": \"false\",\n \"is_row_identifier\"\ : \"false\"\n },\n {\n \"index\": \"1\",\n \"\ name\": \"sepalwidth\",\n \"data_type\": \"numeric\",\n \ \ \"is_target\": \"false\",\n \"is_ignore\": \"false\",\n \ \ \"is_row_identifier\": \"false\"\n },\n {\n \ \ \"index\": \"2\",\n \"name\": \"petallength\",\n \"\ data_type\": \"numeric\",\n \"is_target\": \"false\",\n \ \ \"is_ignore\": \"false\",\n \"is_row_identifier\": \"false\"\ \n },\n {\n \"index\": \"3\",\n \"name\": \"\ petalwidth\",\n \"data_type\": \"numeric\",\n \"is_target\"\ : \"false\",\n \"is_ignore\": \"false\",\n \"is_row_identifier\"\ : \"false\"\n },\n {\n \"index\": \"4\",\n \"\ name\": \"class\",\n \"data_type\": \"nominal\",\n \"\ is_target\": \"true\",\n \"is_ignore\": \"false\",\n \"\ is_row_identifier\": \"false\"\n }\n ]\n }\n}" schema: $ref: "#/definitions/DataFeatures" 270: description: "Please provide dataset ID." 271: description: "Unknown dataset. Data set with the given data ID was not found\ \ (or is not shared with you)." 272: description: "No features found. The dataset did not contain any features,\ \ or we could not extract them." 273: description: "Dataset not processed yet. The dataset was not processed yet,\ \ features are not yet available. Please wait for a few minutes." 274: description: "Dataset processed with error. The feature extractor has run\ \ into an error while processing the dataset. Please check whether it\ \ is a valid supported file. If so, please contact the API admins." /data/qualities/{id}: get: tags: - "data" summary: "Get data qualities" description: "Returns the qualities of a dataset.\n" parameters: - name: "id" in: "path" description: "Id of the dataset." required: true type: "number" format: "integer" - name: "api_key" in: "query" description: "Api key to authenticate the user" required: false type: "string" responses: 200: description: "All the qualities of the dataset" examples: application/json: "{\n \"data_qualities\": {\n \"quality\": [\n \ \ {\n \"name\": \"ClassCount\",\n \"value\": \"3.0\"\ \n },\n {\n \"name\": \"ClassEntropy\",\n \"\ value\": \"1.584962500721156\"\n },\n {\n \"name\"\ : \"NumberOfClasses\",\n \"value\": \"3\"\n },\n {\n\ \ \"name\": \"NumberOfFeatures\",\n \"value\": \"5\"\n\ \ },\n {\n \"name\": \"NumberOfInstances\",\n \ \ \"value\": \"150\"\n },\n {\n \"name\": \"NumberOfInstancesWithMissingValues\"\ ,\n \"value\": \"0\"\n },\n {\n \"name\": \"\ NumberOfMissingValues\",\n \"value\": \"0\"\n },\n \ \ {\n \"name\": \"NumberOfNumericFeatures\",\n \"value\"\ : \"4\"\n },\n {\n \"name\": \"NumberOfSymbolicFeatures\"\ ,\n \"value\": \"0\"\n }\n ]\n }\n}" schema: $ref: "#/definitions/DataQualities" 360: description: "Please provide data set ID" 361: description: "Unknown dataset. The data set with the given ID was not found\ \ in the database, or is not shared with you." 362: description: "No qualities found. The registered dataset did not contain\ \ any calculated qualities." 363: description: "Dataset not processed yet. The dataset was not processed yet,\ \ no qualities are available. Please wait for a few minutes." 364: description: "Dataset processed with error. The quality calculator has run\ \ into an error while processing the dataset. Please check whether it\ \ is a valid supported file. If so, contact the support team." 365: description: "Interval start or end illegal. There was a problem with the\ \ interval start or end." /data/list: get: tags: - "data" summary: "List all datasets" description: "Returns an array with all datasets in the system. Only returns\ \ the 'active' datasets, unless otherwise specified with the 'status' filter.\n" parameters: - name: "api_key" in: "query" description: "API key to authenticate the user" required: false type: "string" responses: 200: description: "A list of datasets" examples: application/json: "{\n \"data\": {\n \"dataset\": [\n {\n \ \ \"did\":\"1\",\n \"name\":\"anneal\",\n \"status\"\ :\"active\",\n \"format\":\"ARFF\",\n \"quality\":[\n\ \ {\n \"name\":\"MajorityClassSize\",\n \ \ \"value\":\"684\"\n },\n {\n \"name\"\ :\"MaxNominalAttDistinctValues\",\n \"value\":\"10.0\"\n\ \ },\n {\n \"name\":\"MinorityClassSize\"\ \n ,\"value\":\"0\"\n },\n {\n \ \ \"name\":\"NumBinaryAtts\",\n \"value\":\"14.0\"\n \ \ },\n {\n \"name\":\"NumberOfClasses\"\ ,\n \"value\":\"6\"\n },\n {\n \ \ \"name\":\"NumberOfFeatures\",\n \"value\":\"39\"\n\ \ },\n {\n \"name\":\"NumberOfInstances\"\ ,\n \"value\":\"898\"\n },\n {\n \ \ \"name\":\"NumberOfInstancesWithMissingValues\",\n \ \ \"value\":\"0\"\n },\n {\n \"name\"\ :\"NumberOfMissingValues\",\n \"value\":\"0\"\n \ \ },\n {\n \"name\":\"NumberOfNumericFeatures\"\ ,\n \"value\":\"6\"\n },\n {\n \ \ \"name\":\"NumberOfSymbolicFeatures\",\n \"value\":\"\ 32\"\n }\n ]\n }\n ]\n }\n}" schema: $ref: "#/definitions/DataList" 370: description: "No datasets available. There are no valid datasets in the\ \ system." /data/list/limit/{limit}/offset/{offset}: get: tags: - "data" summary: "List datasets within a range." description: "Returns an array with a limited number of datasets.\n" parameters: - name: "limit" in: "path" description: "Optional, although required in this interface. The maximum number\ \ of datasets to return. Without specifying an offset, it returns the first\ \ 'limit' datasets." required: true type: "number" format: "integer" - name: "offset" in: "path" description: "Optional (although required in this interface). The offset to\ \ start from. With /limit/5/offset/10, datasets 11..15 will be returned\ \ (these are indices, not IDs). Is ignored when no limit is given." required: true type: "number" format: "integer" - name: "api_key" in: "query" description: "API key to authenticate the user" required: false type: "string" responses: 200: description: "A list of datasets" examples: application/json: "{\n \"data\": {\n \"dataset\": [\n {\n \ \ \"did\":\"1\",\n \"name\":\"anneal\",\n \"status\"\ :\"active\",\n \"format\":\"ARFF\",\n \"quality\":[\n\ \ {\n \"name\":\"MajorityClassSize\",\n \ \ \"value\":\"684\"\n },\n {\n \"name\"\ :\"MaxNominalAttDistinctValues\",\n \"value\":\"10.0\"\n\ \ },\n {\n \"name\":\"MinorityClassSize\"\ \n ,\"value\":\"0\"\n },\n {\n \ \ \"name\":\"NumBinaryAtts\",\n \"value\":\"14.0\"\n \ \ },\n {\n \"name\":\"NumberOfClasses\"\ ,\n \"value\":\"6\"\n },\n {\n \ \ \"name\":\"NumberOfFeatures\",\n \"value\":\"39\"\n\ \ },\n {\n \"name\":\"NumberOfInstances\"\ ,\n \"value\":\"898\"\n },\n {\n \ \ \"name\":\"NumberOfInstancesWithMissingValues\",\n \ \ \"value\":\"0\"\n },\n {\n \"name\"\ :\"NumberOfMissingValues\",\n \"value\":\"0\"\n \ \ },\n {\n \"name\":\"NumberOfNumericFeatures\"\ ,\n \"value\":\"6\"\n },\n {\n \ \ \"name\":\"NumberOfSymbolicFeatures\",\n \"value\":\"\ 32\"\n }\n ]\n }\n ]\n }\n}" schema: $ref: "#/definitions/DataList" 372: description: "No datasets available. There are no valid datasets in the\ \ system." /data/list/tag/{tag}: get: tags: - "data" summary: "List datasets with given tag" description: "Returns an array with all datasets in the system with the given\ \ tag. Can also be combined with limit and offset.\n" parameters: - name: "tag" in: "path" description: "The tag on which to filter the results" required: true type: "string" - name: "api_key" in: "query" description: "API key to authenticate the user" required: false type: "string" responses: 200: description: "A list of datasets with the given tag" examples: application/json: "{\n \"data\": {\n \"dataset\": [\n {\n \ \ \"did\":\"1\",\n \"name\":\"anneal\",\n \"status\"\ :\"active\",\n \"format\":\"ARFF\",\n \"quality\":[\n\ \ {\n \"name\":\"MajorityClassSize\",\n \ \ \"value\":\"684\"\n },\n {\n \"name\"\ :\"MaxNominalAttDistinctValues\",\n \"value\":\"10.0\"\n\ \ },\n {\n \"name\":\"MinorityClassSize\"\ \n ,\"value\":\"0\"\n },\n {\n \ \ \"name\":\"NumBinaryAtts\",\n \"value\":\"14.0\"\n \ \ },\n {\n \"name\":\"NumberOfClasses\"\ ,\n \"value\":\"6\"\n },\n {\n \ \ \"name\":\"NumberOfFeatures\",\n \"value\":\"39\"\n\ \ },\n {\n \"name\":\"NumberOfInstances\"\ ,\n \"value\":\"898\"\n },\n {\n \ \ \"name\":\"NumberOfInstancesWithMissingValues\",\n \ \ \"value\":\"0\"\n },\n {\n \"name\"\ :\"NumberOfMissingValues\",\n \"value\":\"0\"\n \ \ },\n {\n \"name\":\"NumberOfNumericFeatures\"\ ,\n \"value\":\"6\"\n },\n {\n \ \ \"name\":\"NumberOfSymbolicFeatures\",\n \"value\":\"\ 32\"\n }\n ]\n }\n ]\n }\n}" schema: $ref: "#/definitions/DataList" 372: description: "No datasets available. There are no datasets in the system\ \ with the given tag." /data/list/data_name/{data_name}: get: tags: - "data" summary: "List datasets with the given name." description: "Returns a list with all datasets in the system with the given\ \ name. Can also be combined with all other filters.\n" parameters: - name: "data_name" in: "path" description: "The dataset name on which to filter the results" required: true type: "string" - name: "api_key" in: "query" description: "API key to authenticate the user" required: false type: "string" responses: 200: description: "A list of datasets with the given name" examples: application/json: "{\n \"data\": {\n \"dataset\": [\n {\n \ \ \"did\":\"1\",\n \"name\":\"anneal\",\n \"status\"\ :\"active\",\n \"format\":\"ARFF\",\n \"quality\":[\n\ \ {\n \"name\":\"MajorityClassSize\",\n \ \ \"value\":\"684\"\n },\n {\n \"name\"\ :\"MaxNominalAttDistinctValues\",\n \"value\":\"10.0\"\n\ \ },\n {\n \"name\":\"MinorityClassSize\"\ \n ,\"value\":\"0\"\n },\n {\n \ \ \"name\":\"NumBinaryAtts\",\n \"value\":\"14.0\"\n \ \ },\n {\n \"name\":\"NumberOfClasses\"\ ,\n \"value\":\"6\"\n },\n {\n \ \ \"name\":\"NumberOfFeatures\",\n \"value\":\"39\"\n\ \ },\n {\n \"name\":\"NumberOfInstances\"\ ,\n \"value\":\"898\"\n },\n {\n \ \ \"name\":\"NumberOfInstancesWithMissingValues\",\n \ \ \"value\":\"0\"\n },\n {\n \"name\"\ :\"NumberOfMissingValues\",\n \"value\":\"0\"\n \ \ },\n {\n \"name\":\"NumberOfNumericFeatures\"\ ,\n \"value\":\"6\"\n },\n {\n \ \ \"name\":\"NumberOfSymbolicFeatures\",\n \"value\":\"\ 32\"\n }\n ]\n }\n ]\n }\n}" schema: $ref: "#/definitions/DataList" 372: description: "No datasets available. There are no datasets in the system\ \ with the given name." /data/list/{quality}/{value}: get: tags: - "data" summary: "List datasets with the given name." description: "Returns a list with all datasets in the system with the given\ \ qualities, where the quality can be 'number_instances', 'number_features',\ \ 'number_classes', or 'number_missing_values' \n" parameters: - name: "quality" in: "path" description: "The quality name on which to filter on, either 'number_instances',\ \ 'number_features', 'number_classes', or 'number_missing_values'" required: true type: "string" - name: "value" in: "path" description: "The required value for the given quality. Can either be an exact\ \ value, e.g. '100' if you only want datasets with 100 instances, or a range\ \ '1..100' if you want all datasets with a number of instances between 1\ \ and 100." required: true type: "string" - name: "api_key" in: "query" description: "API key to authenticate the user" required: false type: "string" responses: 200: description: "A list of datasets with the given quality constraints" examples: application/json: "{\n \"data\": {\n \"dataset\": [\n {\n \ \ \"did\":\"1\",\n \"name\":\"anneal\",\n \"status\"\ :\"active\",\n \"format\":\"ARFF\",\n \"quality\":[\n\ \ {\n \"name\":\"MajorityClassSize\",\n \ \ \"value\":\"684\"\n },\n {\n \"name\"\ :\"MaxNominalAttDistinctValues\",\n \"value\":\"10.0\"\n\ \ },\n {\n \"name\":\"MinorityClassSize\"\ \n ,\"value\":\"0\"\n },\n {\n \ \ \"name\":\"NumBinaryAtts\",\n \"value\":\"14.0\"\n \ \ },\n {\n \"name\":\"NumberOfClasses\"\ ,\n \"value\":\"6\"\n },\n {\n \ \ \"name\":\"NumberOfFeatures\",\n \"value\":\"39\"\n\ \ },\n {\n \"name\":\"NumberOfInstances\"\ ,\n \"value\":\"898\"\n },\n {\n \ \ \"name\":\"NumberOfInstancesWithMissingValues\",\n \ \ \"value\":\"0\"\n },\n {\n \"name\"\ :\"NumberOfMissingValues\",\n \"value\":\"0\"\n \ \ },\n {\n \"name\":\"NumberOfNumericFeatures\"\ ,\n \"value\":\"6\"\n },\n {\n \ \ \"name\":\"NumberOfSymbolicFeatures\",\n \"value\":\"\ 32\"\n }\n ]\n }\n ]\n }\n}" schema: $ref: "#/definitions/DataList" 372: description: "No datasets available. There are no datasets in the system\ \ with the given quality constraints." /data/list/status/{status}: get: tags: - "data" summary: "List datasets with given status" description: "Returns an array with all datasets in the system with the given\ \ status, either 'active', 'deactivated', 'in_preparation', or 'all'. 'all'\ \ returns all datasets regardless of status.\n" parameters: - name: "status" in: "path" description: "The status on which to filter the results, either 'active',\ \ 'deactivated', 'in_preparation', or 'all'." required: true type: "string" - name: "api_key" in: "query" description: "API key to authenticate the user" required: false type: "string" responses: 200: description: "A list of datasets with the given status" examples: application/json: "{\n \"data\": {\n \"dataset\": [\n {\n \ \ \"did\":\"1\",\n \"name\":\"anneal\",\n \"status\"\ :\"active\",\n \"format\":\"ARFF\",\n \"quality\":[\n\ \ {\n \"name\":\"MajorityClassSize\",\n \ \ \"value\":\"684\"\n },\n {\n \"name\"\ :\"MaxNominalAttDistinctValues\",\n \"value\":\"10.0\"\n\ \ },\n {\n \"name\":\"MinorityClassSize\"\ \n ,\"value\":\"0\"\n },\n {\n \ \ \"name\":\"NumBinaryAtts\",\n \"value\":\"14.0\"\n \ \ },\n {\n \"name\":\"NumberOfClasses\"\ ,\n \"value\":\"6\"\n },\n {\n \ \ \"name\":\"NumberOfFeatures\",\n \"value\":\"39\"\n\ \ },\n {\n \"name\":\"NumberOfInstances\"\ ,\n \"value\":\"898\"\n },\n {\n \ \ \"name\":\"NumberOfInstancesWithMissingValues\",\n \ \ \"value\":\"0\"\n },\n {\n \"name\"\ :\"NumberOfMissingValues\",\n \"value\":\"0\"\n \ \ },\n {\n \"name\":\"NumberOfNumericFeatures\"\ ,\n \"value\":\"6\"\n },\n {\n \ \ \"name\":\"NumberOfSymbolicFeatures\",\n \"value\":\"\ 32\"\n }\n ]\n }\n ]\n }\n}" schema: $ref: "#/definitions/DataList" 372: description: "No datasets available. There are no datasets in the system\ \ with the given status." /data/list/{filters}: get: tags: - "data" summary: "Get datasets by properties" description: "Get tasks based on properties of the data - number_instances,\ \ number_features, number_classes or number_missing_values. Properties can\ \ be combined, and ranges can be used in the form '0..10'. Can also be combined\ \ with limits or tags. Returns an array with all datasets in the system that\ \ match the constraints.\n" parameters: - name: "filters" in: "path" description: "Any combination of filters (data_id, data_name, number_instances,\ \ number_features, number_classes, number_missing_values) and corresponding\ \ values or ranges, e.g. 'number_instances/0..50/number_features/0..10'.\ \ With or without limits, or tags." required: true type: "string" - name: "api_key" in: "query" description: "API key to authenticate the user" required: false type: "string" responses: 200: description: "A list of datasets with the given task" examples: application/json: "{\n \"data\": {\n \"dataset\": [\n {\n \ \ \"did\":\"1\",\n \"name\":\"anneal\",\n \"status\"\ :\"active\",\n \"format\":\"ARFF\",\n \"quality\":[\n\ \ {\n \"name\":\"MajorityClassSize\",\n \ \ \"value\":\"684\"\n },\n {\n \"name\"\ :\"MaxNominalAttDistinctValues\",\n \"value\":\"10.0\"\n\ \ },\n {\n \"name\":\"MinorityClassSize\"\ \n ,\"value\":\"0\"\n },\n {\n \ \ \"name\":\"NumBinaryAtts\",\n \"value\":\"14.0\"\n \ \ },\n {\n \"name\":\"NumberOfClasses\"\ ,\n \"value\":\"6\"\n },\n {\n \ \ \"name\":\"NumberOfFeatures\",\n \"value\":\"39\"\n\ \ },\n {\n \"name\":\"NumberOfInstances\"\ ,\n \"value\":\"898\"\n },\n {\n \ \ \"name\":\"NumberOfInstancesWithMissingValues\",\n \ \ \"value\":\"0\"\n },\n {\n \"name\"\ :\"NumberOfMissingValues\",\n \"value\":\"0\"\n \ \ },\n {\n \"name\":\"NumberOfNumericFeatures\"\ ,\n \"value\":\"6\"\n },\n {\n \ \ \"name\":\"NumberOfSymbolicFeatures\",\n \"value\":\"\ 32\"\n }\n ]\n }\n ]\n }\n}" schema: $ref: "#/definitions/DataList" 372: description: "No datasets available. There are no datasets in the system\ \ with the given constraints." /data/tag: post: tags: - "data" summary: "Tag a dataset" description: "Tags a dataset." consumes: - "application/x-www-form-urlencoded" parameters: - name: "data_id" in: "formData" description: "Id of the dataset." required: true type: "number" format: "integer" - name: "tag" in: "formData" description: "Tag name" required: true type: "string" - name: "api_key" in: "formData" description: "Api key to authenticate the user" required: true type: "string" responses: 200: description: "The id of the tagged dataset" examples: application/json: "{\n \"data_tag\": {\n \"id\": \"2\"\n }\n}" schema: type: "object" properties: data_tag: $ref: "#/definitions/inline_response_200_2_data_tag" 470: description: "In order to add a tag, please upload the entity id (either\ \ data_id, flow_id, run_id) and tag (the name of the tag)." 471: description: "Entity not found. The provided entity_id {data_id, flow_id,\ \ run_id} does not correspond to an existing entity." 472: description: "Entity already tagged by this tag. The entity {dataset, flow,\ \ run} already had this tag." 473: description: "Something went wrong inserting the tag. Please contact OpenML\ \ Team." 474: description: "Internal error tagging the entity. Please contact OpenML Team." /data/untag: post: tags: - "data" summary: "Untag a dataset" description: "Untags a dataset." consumes: - "application/x-www-form-urlencoded" parameters: - name: "data_id" in: "formData" description: "Id of the dataset." required: true type: "number" - name: "tag" in: "formData" description: "Tag name" required: true type: "string" - name: "api_key" in: "formData" description: "Api key to authenticate the user" required: true type: "string" responses: 200: description: "The ID of the untagged dataset" examples: application/json: "{\n \"data_untag\": {\n \"id\": \"2\"\n }\n}" schema: type: "object" properties: data_untag: $ref: "#/definitions/inline_response_200_3_data_untag" 475: description: "Please give entity_id {data_id, flow_id, run_id} and tag.\ \ In order to remove a tag, please upload the entity id (either data_id,\ \ flow_id, run_id) and tag (the name of the tag)." 476: description: "Entity {dataset, flow, run} not found. The provided entity_id\ \ {data_id, flow_id, run_id} does not correspond to an existing entity." 477: description: "Tag not found. The provided tag is not associated with the\ \ entity {dataset, flow, run}." 478: description: "Tag is not owned by you. The entity {dataset, flow, run} was\ \ tagged by another user. Hence you cannot delete it." 479: description: "Internal error removing the tag. Please contact OpenML Team." /data/unprocessed/{data_engine_id}/{order}: get: tags: - "evaluation" summary: "Get a list of unprocessed datasets" description: "This call is for people running their own dataset processing engines.\ \ It returns the details of datasets that are not yet processed by the given\ \ processing engine. It doesn't process the datasets, it just returns the\ \ dataset info.\n" parameters: - name: "data_engine_id" in: "path" description: "The ID of the data processing engine. You get this ID when you\ \ register a new data processing engine with OpenML. The ID of the main\ \ data processing engine is 1." required: true type: "string" - name: "order" in: "path" description: "When there are multiple datasets still to process, this defines\ \ which ones to return. Options are 'normal' - the oldest datasets, or 'random'." required: true type: "string" - name: "api_key" in: "query" description: "API key to authenticate the user" required: false type: "string" responses: 200: description: "A list of unprocessed datasets" examples: application/json: data_unprocessed: run: - did: "1" name: "anneal" version: "2" status: "deactivated" format: "ARFF" schema: $ref: "#/definitions/DataUnprocessed" 681: description: "No unprocessed datasets." /data/qualities/unprocessed/{data_engine_id}/{order}: post: tags: - "data" summary: "Get a list of datasets with unprocessed qualities\n" description: "This call is for people running their own dataset processing engines.\ \ It returns the details of datasets for which certain qualities are not yet\ \ processed by the given processing engine. It doesn't process the datasets,\ \ it just returns the dataset info.\n" consumes: - "application/x-www-form-urlencoded" parameters: - name: "data_engine_id" in: "path" description: "The ID of the data processing engine. You get this ID when you\ \ register a new data processing engine with OpenML. The ID of the main\ \ data processing engine is 1." required: true type: "string" - name: "order" in: "path" description: "When there are multiple datasets still to process, this defines\ \ which ones to return. Options are 'normal' - the oldest datasets, or 'random'." required: true type: "string" - name: "api_key" in: "query" description: "API key to authenticate the user" required: false type: "string" - name: "qualities" in: "formData" description: "Comma-separated list of (at least two) quality names, e.g. 'NumberOfInstances,NumberOfFeatures'." required: true type: "string" responses: 200: description: "A list of unprocessed datasets" examples: application/json: data_unprocessed: run: - did: "1" name: "anneal" version: "2" status: "deactivated" format: "ARFF" schema: $ref: "#/definitions/DataUnprocessed" 686: description: "Please specify the features the evaluation engine wants to\ \ calculate (at least 2)." 687: description: "No unprocessed datasets according to the given set of meta-features." 688: description: "Illegal qualities." /task/{id}: get: tags: - "task" summary: "Get task description" description: "Returns information about a task. The information includes the\ \ task type, input data, train/test sets, and more.\n" parameters: - name: "id" in: "path" description: "ID of the task." required: true type: "number" format: "integer" - name: "api_key" in: "query" description: "Api key to authenticate the user" required: false type: "string" responses: 150: description: "Please provide task_id." 151: description: "Unknown task. The task with the given id was not found in\ \ the database" 200: description: "A task description" examples: application/json: "{\n \"task\": {\n \"task_id\":\"1\",\n \"task_type\"\ :\"Supervised Classification\",\n \"input\":[\n {\n \"\ name\":\"source_data\",\n \"data_set\":{\n \"data_set_id\"\ :\"1\",\n \"target_feature\":\"class\"\n }\n },\n\ \ {\n \"name\":\"estimation_procedure\",\n \"estimation_procedure\"\ :{\n \"type\":\"crossvalidation\",\n \"data_splits_url\"\ :\"https://www.openml.org/api_splits/get/1/Task_1_splits.arff\",\n \ \ \"parameter\":[\n {\n \"name\":\"\ number_repeats\",\n \"value\":\"1\"\n },\n \ \ {\n \"name\":\"number_folds\",\n \ \ \"value\":\"10\"\n },\n {\n \ \ \"name\":\"percentage\"\n },\n {\n \ \ \"name\":\"stratified_sampling\",\n \"value\":\"\ true\"\n }\n ]\n }\n },\n {\n \ \ \"name\":\"cost_matrix\",\n \"cost_matrix\":[]\n \ \ },\n {\n \"name\":\"evaluation_measures\",\n \"\ evaluation_measures\":\n {\n \"evaluation_measure\"\ :\"predictive_accuracy\"\n }\n }\n ],\n \"output\"\ :{\n \"name\":\"predictions\",\n \"predictions\":{\n \ \ \"format\":\"ARFF\",\n \"feature\":[\n {\n \ \ \"name\":\"repeat\",\n \"type\":\"integer\"\n \ \ },\n {\n \"name\":\"fold\",\n \ \ \"type\":\"integer\"\n },\n {\n \"name\"\ :\"row_id\",\n \"type\":\"integer\"\n },\n \ \ {\n \"name\":\"confidence.classname\",\n \ \ \"type\":\"numeric\"\n },\n {\n \"name\"\ :\"prediction\",\n \"type\":\"string\"\n }\n \ \ ]\n }\n },\n \"tag\":[\"basic\",\"study_1\",\"under100k\"\ ,\"under1m\"]\n }\n}" schema: $ref: "#/definitions/Task" delete: tags: - "task" summary: "Delete task" description: "Deletes a task. Upon success, it returns the ID of the deleted\ \ task.\n" parameters: - name: "id" in: "path" description: "Id of the task." required: true type: "number" format: "integer" - name: "api_key" in: "query" description: "Api key to authenticate the user" required: true type: "string" responses: 200: description: "ID of the deleted task" examples: application/json: "{\n \"task_delete\": {\n \"id\": \"4328\"\n }\n\ }" schema: type: "object" properties: task_delete: $ref: "#/definitions/inline_response_200_4_task_delete" 450: description: "Please provide API key. In order to remove your content, please\ \ authenticate." 451: description: "Authentication failed. The API key was not valid. Please try\ \ to login again, or contact api administrators." 452: description: "Task does not exists. The task ID could not be linked to an\ \ existing task." 454: description: "Task is executed in some runs. Delete these first." 455: description: "Deleting the task failed. Please contact support team." /task: post: tags: - "task" summary: "Upload task" description: "Uploads a task. Upon success, it returns the task id.\n" consumes: - "multipart/form-data" parameters: - name: "description" in: "formData" description: "An XML file describing the task. Only name, description, and\ \ task format are required. Also see the [XSD schema](https://www.openml.org/api/v1/xsd/openml.task.upload)\ \ and an [XML example](https://www.openml.org/api/v1/xml_example/task)." required: true type: "file" - name: "api_key" in: "query" description: "Api key to authenticate the user" required: true type: "string" responses: 200: description: "Id of the uploaded task" examples: application/json: "{\n \"upload_task\": {\n \"id\": \"4328\"\n }\n\ }" schema: type: "object" properties: upload_task: $ref: "#/definitions/inline_response_200_5_upload_task" 530: description: "Description file not present. Please upload the task description." 531: description: "Internal error. Please contact api support team" 532: description: "Problem validating uploaded description file. The XML description\ \ format does not meet the standards" 533: description: "Task already exists." 534: description: "Error creating the task." /task/list: get: tags: - "task" summary: "List all tasks" description: "Returns an array with all tasks in the system.\n" parameters: - name: "api_key" in: "query" description: "API key to authenticate the user" required: false type: "string" responses: 200: description: "A list of tasks" examples: application/json: "{\n \"task\": {\n \"task\": [\n {\n \ \ \"task_id\":\"1\",\n \"task_type\":\"Supervised Classification\"\ ,\n \"did\":\"1\",\n \"name\":\"anneal\",\n \"\ status\":\"active\",\n \"format\":\"ARFF\",\n \"input\"\ :[\n {\n \"name\":\"estimation_procedure\",\n \ \ \"value\":\"1\"\n },\n {\n \"\ name\":\"evaluation_measures\",\n \"value\":\"predictive_accuracy\"\ \n },\n {\n \"name\":\"source_data\",\n\ \ \"value\":\"1\"\n },\n {\n \ \ \"name\":\"target_feature\",\n \"value\":\"class\"\n \ \ }\n ],\n \"quality\":[\n {\n \ \ \"name\":\"MajorityClassSize\",\n \"value\":\"684\"\ \n },\n {\n \"name\":\"MaxNominalAttDistinctValues\"\ ,\n \"value\":\"10.0\"\n },\n {\n \ \ \"name\":\"MinorityClassSize\",\n \"value\":\"0\"\ \n },\n {\n \"name\":\"NumBinaryAtts\"\ ,\n \"value\":\"14.0\"\n },\n {\n \ \ \"name\":\"NumberOfClasses\",\n \"value\":\"6\"\n\ \ },\n {\n \"name\":\"NumberOfFeatures\"\ ,\n \"value\":\"39\"\n },\n {\n \ \ \"name\":\"NumberOfInstances\",\n \"value\":\"898\"\ \n },\n {\n \"name\":\"NumberOfInstancesWithMissingValues\"\ ,\n \"value\":\"0\"\n },\n {\n \ \ \"name\":\"NumberOfMissingValues\",\n \"value\":\"0\"\ \n },\n {\n \"name\":\"NumberOfNumericFeatures\"\ ,\n \"value\":\"6\"\n },\n {\n \ \ \"name\":\"NumberOfSymbolicFeatures\",\n \"value\":\"\ 32\"\n }\n ],\n \"tag\":[\n \"basic\"\ ,\n \"study_1\",\n \"study_7\",\n \"under100k\"\ ,\n \"under1m\"\n ]\n }\n ]\n }\n}" schema: $ref: "#/definitions/TaskList" default: description: "Unexpected error" schema: $ref: "#/definitions/Error" /task/list/limit/{limit}/offset/{offset}: get: tags: - "task" summary: "List tasks within a range" description: "Returns an array with a limited number of tasks.\n" parameters: - name: "limit" in: "path" description: "Optional, although required in this interface. The maximum number\ \ of tasks to return. Without specifying an offset, it returns the first\ \ 'limit' tasks." required: true type: "number" format: "integer" - name: "offset" in: "path" description: "Optional (although required in this interface). The offset to\ \ start from. With /limit/5/offset/10, tasks 11..15 will be returned (these\ \ are indices, not IDs). Is ignored when no limit is given." required: true type: "number" format: "integer" - name: "api_key" in: "query" description: "API key to authenticate the user" required: false type: "string" responses: 200: description: "A list of tasks" examples: application/json: "{\n \"task\": {\n \"task\": [\n {\n \ \ \"task_id\":\"1\",\n \"task_type\":\"Supervised Classification\"\ ,\n \"did\":\"1\",\n \"name\":\"anneal\",\n \"\ status\":\"active\",\n \"format\":\"ARFF\",\n \"input\"\ :[\n {\n \"name\":\"estimation_procedure\",\n \ \ \"value\":\"1\"\n },\n {\n \"\ name\":\"evaluation_measures\",\n \"value\":\"predictive_accuracy\"\ \n },\n {\n \"name\":\"source_data\",\n\ \ \"value\":\"1\"\n },\n {\n \ \ \"name\":\"target_feature\",\n \"value\":\"class\"\n \ \ }\n ],\n \"quality\":[\n {\n \ \ \"name\":\"MajorityClassSize\",\n \"value\":\"684\"\ \n },\n {\n \"name\":\"MaxNominalAttDistinctValues\"\ ,\n \"value\":\"10.0\"\n },\n {\n \ \ \"name\":\"MinorityClassSize\",\n \"value\":\"0\"\ \n },\n {\n \"name\":\"NumBinaryAtts\"\ ,\n \"value\":\"14.0\"\n },\n {\n \ \ \"name\":\"NumberOfClasses\",\n \"value\":\"6\"\n\ \ },\n {\n \"name\":\"NumberOfFeatures\"\ ,\n \"value\":\"39\"\n },\n {\n \ \ \"name\":\"NumberOfInstances\",\n \"value\":\"898\"\ \n },\n {\n \"name\":\"NumberOfInstancesWithMissingValues\"\ ,\n \"value\":\"0\"\n },\n {\n \ \ \"name\":\"NumberOfMissingValues\",\n \"value\":\"0\"\ \n },\n {\n \"name\":\"NumberOfNumericFeatures\"\ ,\n \"value\":\"6\"\n },\n {\n \ \ \"name\":\"NumberOfSymbolicFeatures\",\n \"value\":\"\ 32\"\n }\n ],\n \"tag\":[\n \"basic\"\ ,\n \"study_1\",\n \"study_7\",\n \"under100k\"\ ,\n \"under1m\"\n ]\n }\n ]\n }\n}" schema: $ref: "#/definitions/TaskList" default: description: "Unexpected error" schema: $ref: "#/definitions/Error" /task/list/status/{status}: get: tags: - "task" summary: "List tasks with given status" description: "Returns an array with all tasks in the system with the given status,\ \ either 'active', 'deactivated', or 'in_preparation'.\n" parameters: - name: "status" in: "path" description: "The status on which to filter the results, either 'active',\ \ 'deactivated', or 'in_preparation'." required: true type: "string" - name: "api_key" in: "query" description: "API key to authenticate the user" required: false type: "string" responses: 200: description: "A list of tasks with the given status" examples: application/json: "{\n \"data\": {\n \"dataset\": [\n {\n \ \ \"did\":\"1\",\n \"name\":\"anneal\",\n \"status\"\ :\"active\",\n \"format\":\"ARFF\",\n \"quality\":[\n\ \ {\n \"name\":\"MajorityClassSize\",\n \ \ \"value\":\"684\"\n },\n {\n \"name\"\ :\"MaxNominalAttDistinctValues\",\n \"value\":\"10.0\"\n\ \ },\n {\n \"name\":\"MinorityClassSize\"\ \n ,\"value\":\"0\"\n },\n {\n \ \ \"name\":\"NumBinaryAtts\",\n \"value\":\"14.0\"\n \ \ },\n {\n \"name\":\"NumberOfClasses\"\ ,\n \"value\":\"6\"\n },\n {\n \ \ \"name\":\"NumberOfFeatures\",\n \"value\":\"39\"\n\ \ },\n {\n \"name\":\"NumberOfInstances\"\ ,\n \"value\":\"898\"\n },\n {\n \ \ \"name\":\"NumberOfInstancesWithMissingValues\",\n \ \ \"value\":\"0\"\n },\n {\n \"name\"\ :\"NumberOfMissingValues\",\n \"value\":\"0\"\n \ \ },\n {\n \"name\":\"NumberOfNumericFeatures\"\ ,\n \"value\":\"6\"\n },\n {\n \ \ \"name\":\"NumberOfSymbolicFeatures\",\n \"value\":\"\ 32\"\n }\n ]\n }\n ]\n }\n}" schema: $ref: "#/definitions/DataList" 482: description: "No tasks available. There are no tasks in the system with\ \ the given status." /task/list/type/{id}: get: tags: - "task" summary: "List tasks of given type." description: "Returns an array with all tasks for the given task type id (1\ \ = Supervised Classification). Can be combined with limits and tags.\n" parameters: - name: "id" in: "path" description: "On which task type id to filter the results" required: true type: "number" format: "integer" - name: "api_key" in: "query" description: "API key to authenticate the user" required: false type: "string" responses: 200: description: "A list of tasks" examples: application/json: "{\n \"task\": {\n \"task\": [\n {\n \ \ \"task_id\":\"1\",\n \"task_type\":\"Supervised Classification\"\ ,\n \"did\":\"1\",\n \"name\":\"anneal\",\n \"\ status\":\"active\",\n \"format\":\"ARFF\",\n \"input\"\ :[\n {\n \"name\":\"estimation_procedure\",\n \ \ \"value\":\"1\"\n },\n {\n \"\ name\":\"evaluation_measures\",\n \"value\":\"predictive_accuracy\"\ \n },\n {\n \"name\":\"source_data\",\n\ \ \"value\":\"1\"\n },\n {\n \ \ \"name\":\"target_feature\",\n \"value\":\"class\"\n \ \ }\n ],\n \"quality\":[\n {\n \ \ \"name\":\"MajorityClassSize\",\n \"value\":\"684\"\ \n },\n {\n \"name\":\"MaxNominalAttDistinctValues\"\ ,\n \"value\":\"10.0\"\n },\n {\n \ \ \"name\":\"MinorityClassSize\",\n \"value\":\"0\"\ \n },\n {\n \"name\":\"NumBinaryAtts\"\ ,\n \"value\":\"14.0\"\n },\n {\n \ \ \"name\":\"NumberOfClasses\",\n \"value\":\"6\"\n\ \ },\n {\n \"name\":\"NumberOfFeatures\"\ ,\n \"value\":\"39\"\n },\n {\n \ \ \"name\":\"NumberOfInstances\",\n \"value\":\"898\"\ \n },\n {\n \"name\":\"NumberOfInstancesWithMissingValues\"\ ,\n \"value\":\"0\"\n },\n {\n \ \ \"name\":\"NumberOfMissingValues\",\n \"value\":\"0\"\ \n },\n {\n \"name\":\"NumberOfNumericFeatures\"\ ,\n \"value\":\"6\"\n },\n {\n \ \ \"name\":\"NumberOfSymbolicFeatures\",\n \"value\":\"\ 32\"\n }\n ],\n \"tag\":[\n \"basic\"\ ,\n \"study_1\",\n \"study_7\",\n \"under100k\"\ ,\n \"under1m\"\n ]\n }\n ]\n }\n}" schema: $ref: "#/definitions/TaskList" 480: description: "Please provide task type ID." 482: description: "No results. There where no matches for the given task type\ \ ID." /task/list/tag/{tag}: get: tags: - "task" summary: "List tasks with given tag" description: "Returns an array with all tasks with the given tag. Can be combined\ \ with limits and other filters.\n" parameters: - name: "tag" in: "path" description: "The tag on which to filter the results" required: true type: "string" - name: "api_key" in: "query" description: "API key to authenticate the user" required: false type: "string" responses: 200: description: "A list of tasks with the given tag" examples: application/json: "{\n \"task\": {\n \"task\": [\n {\n \ \ \"task_id\":\"1\",\n \"task_type\":\"Supervised Classification\"\ ,\n \"did\":\"1\",\n \"name\":\"anneal\",\n \"\ status\":\"active\",\n \"format\":\"ARFF\",\n \"input\"\ :[\n {\n \"name\":\"estimation_procedure\",\n \ \ \"value\":\"1\"\n },\n {\n \"\ name\":\"evaluation_measures\",\n \"value\":\"predictive_accuracy\"\ \n },\n {\n \"name\":\"source_data\",\n\ \ \"value\":\"1\"\n },\n {\n \ \ \"name\":\"target_feature\",\n \"value\":\"class\"\n \ \ }\n ],\n \"quality\":[\n {\n \ \ \"name\":\"MajorityClassSize\",\n \"value\":\"684\"\ \n },\n {\n \"name\":\"MaxNominalAttDistinctValues\"\ ,\n \"value\":\"10.0\"\n },\n {\n \ \ \"name\":\"MinorityClassSize\",\n \"value\":\"0\"\ \n },\n {\n \"name\":\"NumBinaryAtts\"\ ,\n \"value\":\"14.0\"\n },\n {\n \ \ \"name\":\"NumberOfClasses\",\n \"value\":\"6\"\n\ \ },\n {\n \"name\":\"NumberOfFeatures\"\ ,\n \"value\":\"39\"\n },\n {\n \ \ \"name\":\"NumberOfInstances\",\n \"value\":\"898\"\ \n },\n {\n \"name\":\"NumberOfInstancesWithMissingValues\"\ ,\n \"value\":\"0\"\n },\n {\n \ \ \"name\":\"NumberOfMissingValues\",\n \"value\":\"0\"\ \n },\n {\n \"name\":\"NumberOfNumericFeatures\"\ ,\n \"value\":\"6\"\n },\n {\n \ \ \"name\":\"NumberOfSymbolicFeatures\",\n \"value\":\"\ 32\"\n }\n ],\n \"tag\":[\n \"basic\"\ ,\n \"study_1\",\n \"study_7\",\n \"under100k\"\ ,\n \"under1m\"\n ]\n }\n ]\n }\n}" schema: $ref: "#/definitions/TaskList" 482: description: "No results. There where no matches for the given task tag." /task/list/data_tag/{tag}: get: tags: - "task" summary: "List tasks with the given data tag" description: "Returns an array with all tasks where the underlying dataset has\ \ the given tag. Can be combined with limits and other filters.\n" parameters: - name: "tag" in: "path" description: "The tag on which to filter the results" required: true type: "string" - name: "api_key" in: "query" description: "API key to authenticate the user" required: false type: "string" responses: 200: description: "A list of tasks where the underlying dataset has the given\ \ tag" examples: application/json: "{\n \"task\": {\n \"task\": [\n {\n \ \ \"task_id\":\"1\",\n \"task_type\":\"Supervised Classification\"\ ,\n \"did\":\"1\",\n \"name\":\"anneal\",\n \"\ status\":\"active\",\n \"format\":\"ARFF\",\n \"input\"\ :[\n {\n \"name\":\"estimation_procedure\",\n \ \ \"value\":\"1\"\n },\n {\n \"\ name\":\"evaluation_measures\",\n \"value\":\"predictive_accuracy\"\ \n },\n {\n \"name\":\"source_data\",\n\ \ \"value\":\"1\"\n },\n {\n \ \ \"name\":\"target_feature\",\n \"value\":\"class\"\n \ \ }\n ],\n \"quality\":[\n {\n \ \ \"name\":\"MajorityClassSize\",\n \"value\":\"684\"\ \n },\n {\n \"name\":\"MaxNominalAttDistinctValues\"\ ,\n \"value\":\"10.0\"\n },\n {\n \ \ \"name\":\"MinorityClassSize\",\n \"value\":\"0\"\ \n },\n {\n \"name\":\"NumBinaryAtts\"\ ,\n \"value\":\"14.0\"\n },\n {\n \ \ \"name\":\"NumberOfClasses\",\n \"value\":\"6\"\n\ \ },\n {\n \"name\":\"NumberOfFeatures\"\ ,\n \"value\":\"39\"\n },\n {\n \ \ \"name\":\"NumberOfInstances\",\n \"value\":\"898\"\ \n },\n {\n \"name\":\"NumberOfInstancesWithMissingValues\"\ ,\n \"value\":\"0\"\n },\n {\n \ \ \"name\":\"NumberOfMissingValues\",\n \"value\":\"0\"\ \n },\n {\n \"name\":\"NumberOfNumericFeatures\"\ ,\n \"value\":\"6\"\n },\n {\n \ \ \"name\":\"NumberOfSymbolicFeatures\",\n \"value\":\"\ 32\"\n }\n ],\n \"tag\":[\n \"basic\"\ ,\n \"study_1\",\n \"study_7\",\n \"under100k\"\ ,\n \"under1m\"\n ]\n }\n ]\n }\n}" schema: $ref: "#/definitions/TaskList" 482: description: "No results. There where no matches for the given data tag." /task/list/{filters}: get: tags: - "task" summary: "Get tasks by data properties" description: "Get tasks based on properties of the underlying dataset - data_id,\ \ NumberOfInstances, NumberOfFeatures, NumberOfClasses or NumberOfMissingValues.\ \ Properties can be combined, and ranges can be used in the form '0..10'.\ \ Can also be combined with imits, tags, or types. Returns an array with all\ \ tasks in the system that match the constraints.\n" parameters: - name: "filters" in: "path" description: "Any combination of filters (data_id, NumberOfInstances, NumberOfFeatures,\ \ NumberOfClasses, NumberOfMissingValues) and corresponding values or ranges,\ \ e.g. 'NumberOfInstances/0..50/NumberOfFeatures/0..10'. With or without\ \ limits, tags, or types." required: true type: "string" - name: "api_key" in: "query" description: "API key to authenticate the user" required: false type: "string" responses: 200: description: "A list of tasks with the given tag" examples: application/json: "{\n \"task\": {\n \"task\": [\n {\n \ \ \"task_id\":\"1\",\n \"task_type\":\"Supervised Classification\"\ ,\n \"did\":\"1\",\n \"name\":\"anneal\",\n \"\ status\":\"active\",\n \"format\":\"ARFF\",\n \"input\"\ :[\n {\n \"name\":\"estimation_procedure\",\n \ \ \"value\":\"1\"\n },\n {\n \"\ name\":\"evaluation_measures\",\n \"value\":\"predictive_accuracy\"\ \n },\n {\n \"name\":\"source_data\",\n\ \ \"value\":\"1\"\n },\n {\n \ \ \"name\":\"target_feature\",\n \"value\":\"class\"\n \ \ }\n ],\n \"quality\":[\n {\n \ \ \"name\":\"MajorityClassSize\",\n \"value\":\"684\"\ \n },\n {\n \"name\":\"MaxNominalAttDistinctValues\"\ ,\n \"value\":\"10.0\"\n },\n {\n \ \ \"name\":\"MinorityClassSize\",\n \"value\":\"0\"\ \n },\n {\n \"name\":\"NumBinaryAtts\"\ ,\n \"value\":\"14.0\"\n },\n {\n \ \ \"name\":\"NumberOfClasses\",\n \"value\":\"6\"\n\ \ },\n {\n \"name\":\"NumberOfFeatures\"\ ,\n \"value\":\"39\"\n },\n {\n \ \ \"name\":\"NumberOfInstances\",\n \"value\":\"898\"\ \n },\n {\n \"name\":\"NumberOfInstancesWithMissingValues\"\ ,\n \"value\":\"0\"\n },\n {\n \ \ \"name\":\"NumberOfMissingValues\",\n \"value\":\"0\"\ \n },\n {\n \"name\":\"NumberOfNumericFeatures\"\ ,\n \"value\":\"6\"\n },\n {\n \ \ \"name\":\"NumberOfSymbolicFeatures\",\n \"value\":\"\ 32\"\n }\n ],\n \"tag\":[\n \"basic\"\ ,\n \"study_1\",\n \"study_7\",\n \"under100k\"\ ,\n \"under1m\"\n ]\n }\n ]\n }\n}" schema: $ref: "#/definitions/TaskList" 482: description: "No results. There where no matches for the given constraints." /task/tag: post: tags: - "task" summary: "Tag a task" description: "Tags a task." consumes: - "application/x-www-form-urlencoded" parameters: - name: "task_id" in: "formData" description: "Id of the task." required: true type: "number" format: "integer" - name: "tag" in: "formData" description: "Tag name" required: true type: "string" - name: "api_key" in: "formData" description: "Api key to authenticate the user" required: true type: "string" responses: 200: description: "The id of the tagged task" examples: application/json: "{\n \"task_tag\": {\n \"id\": \"2\"\n }\n}" schema: type: "object" properties: task_tag: $ref: "#/definitions/inline_response_200_6_task_tag" 470: description: "In order to add a tag, please upload the entity id (either\ \ data_id, task_id, flow_id, run_id) and tag (the name of the tag)." 471: description: "Entity not found. The provided entity_id {data_id, task_id,\ \ flow_id, run_id} does not correspond to an existing entity." 472: description: "Entity already tagged by this tag. The entity {dataset, task,\ \ flow, run} already had this tag." 473: description: "Something went wrong inserting the tag. Please contact OpenML\ \ Team." 474: description: "Internal error tagging the entity. Please contact OpenML Team." /task/untag: post: tags: - "task" summary: "Untag a task" description: "Untags a task." consumes: - "application/x-www-form-urlencoded" parameters: - name: "task_id" in: "formData" description: "Id of the task." required: true type: "number" - name: "tag" in: "formData" description: "Tag name" required: true type: "string" - name: "api_key" in: "formData" description: "Api key to authenticate the user" required: true type: "string" responses: 200: description: "A the features of the task" examples: application/json: "{\n \"task_untag\": {\n \"id\": \"2\"\n }\n}" schema: type: "object" properties: task_untag: $ref: "#/definitions/inline_response_200_7_task_untag" 475: description: "Please give entity_id {data_id, flow_id, run_id} and tag.\ \ In order to remove a tag, please upload the entity id (either data_id,\ \ task_id, flow_id, run_id) and tag (the name of the tag)." 476: description: "Entity {dataset, task, flow, run} not found. The provided\ \ entity_id {data_id, task_id, flow_id, run_id} does not correspond to\ \ an existing entity." 477: description: "Tag not found. The provided tag is not associated with the\ \ entity {dataset, task, flow, run}." 478: description: "Tag is not owned by you. The entity {dataset, flow, run} was\ \ tagged by another user. Hence you cannot delete it." 479: description: "Internal error removing the tag. Please contact OpenML Team." /tasktype/{id}: get: tags: - "tasktype" summary: "Get task type description" description: "Returns information about a task type. The information includes\ \ a description, the given inputs and the expected outputs.\n" parameters: - name: "id" in: "path" description: "ID of the task." required: true type: "number" format: "integer" - name: "api_key" in: "query" description: "Api key to authenticate the user" required: false type: "string" responses: 200: description: "A task type description" examples: application/json: "{\n \"task_type\":{\n \"id\":\"1\",\n \"name\"\ :\"Supervised Classification\",\n \"description\":\"In supervised\ \ classification, you are given ...\",\n \"contributor\":[\"Joaquin\ \ Vanschoren\",\"Jan van Rijn\",\"Luis Torgo\",\"Bernd Bischl\"],\n\ \ \"date\":\"24-01-2013\",\n \"input\":[\n {\n \"\ name\":\"source_data\",\n \"data_set\":\n {\n \ \ \"data_set_id\":\"[INPUT:source_data]\",\n \"target_feature\"\ :\"[INPUT:target_feature]\"\n }\n },\n {\n \ \ \"name\":\"estimation_procedure\",\n \"estimation_procedure\"\ :\n {\n \"type\":\"[LOOKUP:estimation_procedure.type]\"\ ,\n \"data_splits_url\":\"splits.arff\",\n \"parameter\"\ :[\n {\n \"name\":\"number_repeats\",\n \ \ \"value\":\"[LOOKUP:estimation_procedure.repeats]\"\n \ \ },\n {\n \"name\":\"number_folds\"\ ,\n \"value\":\"[LOOKUP:estimation_procedure.folds]\"\n\ \ },\n {\n \"name\":\"percentage\"\ ,\n \"value\":\"[LOOKUP:estimation_procedure.percentage]\"\ \n },\n {\n \"name\":\"stratified_sampling\"\ ,\n \"value\":\"[LOOKUP:estimation_procedure.stratified_sampling]\"\ \n }\n ]\n }\n },\n {\n \ \ \"name\":\"cost_matrix\",\n \"cost_matrix\":\"[INPUT:cost_matrix]\"\ \n },\n {\n \"name\":\"evaluation_measures\",\n \ \ \"evaluation_measures\": {\n \"evaluation_measure\":\"\ [INPUT:evaluation_measures]\"\n }\n }\n ],\n \"\ output\":{\n \"name\":\"predictions\",\n \"predictions\":{\n\ \ \"format\":\"ARFF\",\n \"feature\":[\n {\n\ \ \"name\":\"repeat\",\n \"type\":\"integer\"\n\ \ },\n {\n \"name\":\"fold\",\n \ \ \"type\":\"integer\"\n },\n {\n \"\ name\":\"row_id\",\n \"type\":\"integer\"\n },\n\ \ {\n \"name\":\"confidence.classname\",\n \ \ \"type\":\"numeric\"\n },\n {\n \ \ \"name\":\"prediction\",\n \"type\":\"string\"\n \ \ }\n ]\n }\n }\n }\n}" schema: $ref: "#/definitions/TaskType" 240: description: "Please provide task type ID." 241: description: "Unknown task type. The task type with the given id was not\ \ found in the database" /tasktype/list: get: tags: - "tasktype" summary: "List all task types" description: "Returns an array with all task types in the system.\n" parameters: - name: "api_key" in: "query" description: "API key to authenticate the user" required: false type: "string" responses: 200: description: "A task description" examples: application/json: "{\n \"task_types\":{\n \"task_type\":[\n {\n\ \ \"id\":\"1\",\n \"name\":\"Supervised Classification\"\ ,\n \"description\":\"In supervised classification, you are given\ \ ...\",\n \"creator\":\"Joaquin Vanschoren, Jan van Rijn, Luis\ \ Torgo, Bernd Bischl\"\n },\n {\n \"id\":\"2\",\n\ \ \"name\":\"Supervised Regression\",\n \"description\"\ :\"Given a dataset with a numeric target ...\",\n \"creator\"\ :\"Joaquin Vanschoren, Jan van Rijn, Luis Torgo, Bernd Bischl\"\n \ \ },{}\n ]\n }\n}" schema: $ref: "#/definitions/TaskTypeList" default: description: "Unexpected error" schema: $ref: "#/definitions/Error" /flow/{id}: get: tags: - "flow" summary: "Get flow description" description: "Returns information about a flow. The information includes the\ \ name, information about the creator, dependencies, parameters, run instructions\ \ and more.\n" parameters: - name: "id" in: "path" description: "ID of the flow." required: true type: "number" format: "integer" - name: "api_key" in: "query" description: "API key to authenticate the user" required: false type: "string" responses: 180: description: "Please provide flow id." 181: description: "Unknown flow. The flow with the given ID was not found in\ \ the database." 200: description: "A flow description" examples: application/json: "{\n \"flow\": {\n \"id\":\"100\",\n \"uploader\"\ :\"1\",\n \"name\":\"weka.J48\",\n \"version\":\"2\",\n \"\ external_version\":\"Weka_3.7.5_9117\",\n \"description\":\"...\"\ ,\n \"upload_date\":\"2014-04-23 18:00:36\",\n \"language\":\"\ Java\",\n \"dependencies\":\"Weka_3.7.5\",\n \"parameter\": [\n\ \ {\n \"name\":\"A\",\n \"data_type\":\"flag\",\n\ \ \"default_value\":[],\n \"description\":\"Laplace smoothing...\"\ \n },\n {\n \"name\":\"C\",\n \"data_type\"\ :\"option\",\n \"default_value\":\"0.25\",\n \"description\"\ :\"Set confidence threshold...\"\n }\n ]\n }\n}" schema: $ref: "#/definitions/Flow" delete: tags: - "flow" summary: "Delete a flow" description: "Deletes a flow. Upon success, it returns the ID of the deleted\ \ flow.\n" parameters: - name: "id" in: "path" description: "Id of the flow." required: true type: "number" format: "integer" - name: "api_key" in: "query" description: "API key to authenticate the user" required: true type: "string" responses: 200: description: "ID of the deleted flow" examples: application/json: "{\n \"flow_delete\": {\n \"id\": \"4328\"\n }\n\ }" schema: type: "object" properties: flow_delete: $ref: "#/definitions/inline_response_200_8_flow_delete" 320: description: "Please provide API key. In order to remove your content, please\ \ authenticate." 321: description: "Authentication failed. The API key was not valid. Please try\ \ to login again, or contact api administrators ." 322: description: "Flow does not exists. The flow ID could not be linked to an\ \ existing flow." 323: description: "Flow is not owned by you. The flow is owned by another user.\ \ Hence you cannot delete it." 324: description: "Flow is in use by other content. Can not be deleted. The flow\ \ is used in runs, evaluations or as a component of another flow. Delete\ \ other content before deleting thisflow." 325: description: "Deleting flow failed. Deleting the flow failed. Please contact\ \ support team." /flow: post: tags: - "flow" summary: "Upload a flow" description: "Uploads a flow. Upon success, it returns the flow id.\n" consumes: - "multipart/form-data" parameters: - name: "description" in: "formData" description: "An XML file describing the flow. Only name and description are\ \ required. Also see the [XSD schema](https://www.openml.org/api/v1/xsd/openml.implementation.upload)\ \ and an [XML example](https://www.openml.org/api/v1/xml_example/flow)." required: true type: "file" - name: "flow" in: "formData" description: "The actual flow, being a source (or binary) file." required: false type: "file" - name: "api_key" in: "query" description: "Api key to authenticate the user" required: true type: "string" responses: 160: description: "Error in file uploading. There was a problem with the file\ \ upload." 161: description: "Please provide description xml." 163: description: "Problem validating uploaded description file. The XML description\ \ format does not meet the standards." 164: description: "Flow already stored in database. Please change name or version\ \ number" 165: description: "Failed to insert flow. There can be many causes for this error.\ \ If you included the implements field, it should be an existing entry\ \ in the algorithm or math_function table. Otherwise it could be an internal\ \ server error. Please contact API support team." 166: description: "Failed to add flow to database. Internal server error, please\ \ contact API administrators" 167: description: "Illegal files uploaded. An non required file was uploaded." 168: description: "The provided md5 hash equals not the server generated md5\ \ hash of the file." 169: description: "Please provide API key. In order to share content, please\ \ authenticate and provide API key." 170: description: "Authentication failed. The API key was not valid. Please try\ \ to login again, or contact API administrators" 171: description: "Flow already exists. This flow is already in the database" 172: description: "XSD not found. Please contact API support team" 200: description: "Id of the uploaded flow" examples: application/json: "{\n \"upload_flow\": {\n \"id\": \"2520\"\n }\n\ }" schema: type: "object" properties: upload_flow: $ref: "#/definitions/inline_response_200_9_upload_flow" /flow/exists/{name}/{version}: get: tags: - "flow" summary: "Check whether flow exists" description: "Checks whether a flow with the given name and (external) version\ \ exists.\n" parameters: - name: "name" in: "path" description: "The name of the flow." required: true type: "string" - name: "version" in: "path" description: "The external version of the flow" required: true type: "string" - name: "api_key" in: "query" description: "API key to authenticate the user" required: false type: "string" responses: 200: description: "A list of flows" examples: application/json: "{\n \"flow_exists\": {\n \"exists\": \"true\",\n\ \ \"id\": \"65\"\n }\n}" schema: type: "object" properties: flow_exists: $ref: "#/definitions/inline_response_200_10_flow_exists" 330: description: "Mandatory fields not present. Please provide name and external_version." /flow/list: get: tags: - "flow" summary: "List all flows" description: "Returns an array with all flows in the system.\n" parameters: - name: "api_key" in: "query" description: "API key to authenticate the user" required: false type: "string" responses: 200: description: "A list of flows" examples: application/json: "{\n \"flows\":\n {\n \"flow\":[\n {\n\ \ \"id\":\"65\",\n \"full_name\":\"weka.RandomForest(1)\"\ ,\n \"name\":\"weka.RandomForest\",\n \"version\"\ :\"1\",\n \"external_version\":\"Weka_3.7.10_9186\",\n \ \ \"uploader\":\"1\"\n },\n {\n \"id\":\"\ 66\",\n \"full_name\":\"weka.IBk(1)\",\n \"name\"\ :\"weka.IBk\",\n \"version\":\"1\",\n \"external_version\"\ :\"Weka_3.7.10_8034\",\n \"uploader\":\"1\"\n },\n \ \ {\n \"id\":\"67\",\n \"full_name\":\"weka.BayesNet_K2(1)\"\ ,\n \"name\":\"weka.BayesNet_K2\",\n \"version\":\"\ 1\",\n \"external_version\":\"Weka_3.7.10_8034\",\n \ \ \"uploader\":\"1\"\n }\n ]\n }\n }" schema: $ref: "#/definitions/FlowList" 500: description: "There where no results." /flow/list/limit/{limit}/offset/{offset}: get: tags: - "flow" summary: "List flows within a range" description: "Returns an array with the requested flows.\n" parameters: - name: "limit" in: "path" description: "Optional, although required in this interface. The maximum number\ \ of flows to return. Without specifying an offset, it returns the first\ \ 'limit' flows." required: true type: "number" format: "integer" - name: "offset" in: "path" description: "Optional (although required in this interface). The offset to\ \ start from. With /limit/5/offset/10, flows 11..15 will be returned (these\ \ are indices, not IDs). Is ignored when no limit is given." required: true type: "number" format: "integer" - name: "api_key" in: "query" description: "API key to authenticate the user" required: false type: "string" responses: 200: description: "A list of flows" examples: application/json: "{\n \"flows\":\n {\n \"flow\":[\n {\n\ \ \"id\":\"65\",\n \"full_name\":\"weka.RandomForest(1)\"\ ,\n \"name\":\"weka.RandomForest\",\n \"version\"\ :\"1\",\n \"external_version\":\"Weka_3.7.10_9186\",\n \ \ \"uploader\":\"1\"\n },\n {\n \"id\":\"\ 66\",\n \"full_name\":\"weka.IBk(1)\",\n \"name\"\ :\"weka.IBk\",\n \"version\":\"1\",\n \"external_version\"\ :\"Weka_3.7.10_8034\",\n \"uploader\":\"1\"\n },\n \ \ {\n \"id\":\"67\",\n \"full_name\":\"weka.BayesNet_K2(1)\"\ ,\n \"name\":\"weka.BayesNet_K2\",\n \"version\":\"\ 1\",\n \"external_version\":\"Weka_3.7.10_8034\",\n \ \ \"uploader\":\"1\"\n }\n ]\n }\n }" schema: $ref: "#/definitions/FlowList" 500: description: "There where no results." /flow/list/tag/{tag}: get: tags: - "flow" summary: "List flows with given tag." description: "Returns an array with all flows in the system with the given tag.\n" parameters: - name: "tag" in: "path" description: "The tag on which to filter the results" required: true type: "string" - name: "api_key" in: "query" description: "API key to authenticate the user" required: false type: "string" responses: 200: description: "A list of flows with the given tag" examples: application/json: "{\n \"flows\":\n {\n \"flow\":[\n {\n\ \ \"id\":\"65\",\n \"full_name\":\"weka.RandomForest(1)\"\ ,\n \"name\":\"weka.RandomForest\",\n \"version\"\ :\"1\",\n \"external_version\":\"Weka_3.7.10_9186\",\n \ \ \"uploader\":\"1\"\n },\n {\n \"id\":\"\ 66\",\n \"full_name\":\"weka.IBk(1)\",\n \"name\"\ :\"weka.IBk\",\n \"version\":\"1\",\n \"external_version\"\ :\"Weka_3.7.10_8034\",\n \"uploader\":\"1\"\n },\n \ \ {\n \"id\":\"67\",\n \"full_name\":\"weka.BayesNet_K2(1)\"\ ,\n \"name\":\"weka.BayesNet_K2\",\n \"version\":\"\ 1\",\n \"external_version\":\"Weka_3.7.10_8034\",\n \ \ \"uploader\":\"1\"\n }\n ]\n }\n }" schema: $ref: "#/definitions/FlowList" 500: description: "There where no results." /flow/owned: get: tags: - "flow" summary: "List flows owned by you" description: "Returns an array with all flows owned by you.\n" parameters: - name: "api_key" in: "query" description: "API key to authenticate the user" required: false type: "string" responses: 200: description: "A list of flows" examples: application/json: "{\n \"flow_owned\": {\n \"id\": [\n \"111\"\ ,\n \"112\",\n \"113\",\n \"114\",\n \"115\",\n\ \ \"116\",\n \"117\"\n ]\n }\n}" schema: type: "object" properties: flow_owned: $ref: "#/definitions/inline_response_200_11_flow_owned" 310: description: "Please provide API key to authenticate." 311: description: "Authentication failed. The API key was not valid. Please try\ \ to login again, or contact api administrators." 312: description: "No flows owned by you." /flow/tag: post: tags: - "flow" summary: "Tag a flow" description: "Tags a flow." consumes: - "application/x-www-form-urlencoded" parameters: - name: "flow_id" in: "formData" description: "Id of the flow." required: true type: "number" format: "integer" - name: "tag" in: "formData" description: "Tag name" required: true type: "string" - name: "api_key" in: "formData" description: "Api key to authenticate the user" required: true type: "string" responses: 200: description: "The id of the tagged flow" examples: application/json: "{\n \"flow_tag\": {\n \"id\": \"2\"\n }\n}" schema: type: "object" properties: flow_tag: $ref: "#/definitions/inline_response_200_12_flow_tag" 470: description: "In order to add a tag, please upload the entity id (either\ \ data_id, flow_id, run_id) and tag (the name of the tag)." 471: description: "Entity not found. The provided entity_id {data_id, flow_id,\ \ run_id} does not correspond to an existing entity." 472: description: "Entity already tagged by this tag. The entity {dataset, flow,\ \ run} already had this tag." 473: description: "Something went wrong inserting the tag. Please contact OpenML\ \ Team." 474: description: "Internal error tagging the entity. Please contact OpenML Team." /flow/untag: post: tags: - "flow" summary: "Untag a flow" description: "Untags a flow." consumes: - "application/x-www-form-urlencoded" parameters: - name: "flow_id" in: "formData" description: "Id of the flow." required: true type: "number" - name: "tag" in: "formData" description: "Tag name" required: true type: "string" - name: "api_key" in: "formData" description: "Api key to authenticate the user" required: true type: "string" responses: 200: description: "The id of the untagged flow" examples: application/json: "{\n \"flow_untag\": {\n \"id\": \"2\"\n }\n}" schema: type: "object" properties: flow_untag: $ref: "#/definitions/inline_response_200_13_flow_untag" 475: description: "Please give entity_id {data_id, flow_id, run_id} and tag.\ \ In order to remove a tag, please upload the entity id (either data_id,\ \ flow_id, run_id) and tag (the name of the tag)." 476: description: "Entity {dataset, flow, run} not found. The provided entity_id\ \ {data_id, flow_id, run_id} does not correspond to an existing entity." 477: description: "Tag not found. The provided tag is not associated with the\ \ entity {dataset, flow, run}." 478: description: "Tag is not owned by you. The entity {dataset, flow, run} was\ \ tagged by another user. Hence you cannot delete it." 479: description: "Internal error removing the tag. Please contact OpenML Team." /setup/{id}: get: tags: - "setup" summary: "Get a hyperparameter setup" description: "Returns information about a setup. The information includes the\ \ list of hyperparameters, with name, value, and default value.\n" parameters: - name: "id" in: "path" description: "ID of the hyperparameter setup (configuration). These IDs are\ \ stated in run descriptions." required: true type: "number" format: "integer" - name: "api_key" in: "query" description: "API key to authenticate the user" required: false type: "string" responses: 200: description: "A setup description" examples: application/json: "{\n \"setup_parameters\":{\n \"flow_id\":\"59\"\ ,\n \"parameter\":[\n {\n \"full_name\":\"weka.JRip(1)_F\"\ ,\n \"parameter_name\":\"F\",\n \"data_type\":\"option\"\ ,\n \"default_value\":\"3\",\n \"value\":\"3\"\n \ \ },{\n \"full_name\":\"weka.JRip(1)_N\",\n \"parameter_name\"\ :\"N\",\n \"data_type\":\"option\",\n \"default_value\"\ :\"2.0\",\n \"value\":\"2.0\"\n },{\n \"full_name\"\ :\"weka.JRip(1)_O\",\n \"parameter_name\":\"O\",\n \"\ data_type\":\"option\",\n \"default_value\":\"2\",\n \"\ value\":\"2\"\n },{\n \"full_name\":\"weka.JRip(1)_S\",\n\ \ \"parameter_name\":\"S\",\n \"data_type\":\"option\"\ ,\n \"default_value\":\"1\",\n \"value\":\"1\"\n \ \ }]\n }\n}" schema: $ref: "#/definitions/Setup" 280: description: "Please provide setup ID. In order to view setup details, please\ \ provide the run ID" 281: description: "Setup not found. The setup ID was invalid, or setup does not\ \ exist (anymore)." /run/{id}: get: tags: - "run" summary: "Get run description" description: "Returns information about a run. The information includes the\ \ name, information about the creator, dependencies, parameters, run instructions\ \ and more.\n" parameters: - name: "id" in: "path" description: "ID of the run." required: true type: "number" format: "integer" - name: "api_key" in: "query" description: "API key to authenticate the user" required: false type: "string" responses: 200: description: "A run description" examples: application/json: "{\n \"run\": {\n \"run_id\":\"100\",\n \"uploader\"\ :\"1\",\n \"uploader_name\":\"Jan van Rijn\",\n \"task_id\":\"\ 28\",\n \"task_type\":\"Supervised Classification\",\n \"task_evaluation_measure\"\ :\"predictive_accuracy\",\n \"flow_id\":\"67\",\n \"flow_name\"\ :\"weka.BayesNet_K2(1)\",\n \"setup_string\":\"weka.classifiers.bayes.BayesNet\ \ -- -D -Q weka.classifiers.bayes.net.search.local.K2 -- -P 1 -S BAYES\ \ -E weka.classifiers.bayes.net.estimate.SimpleEstimator -- -A 0.5\"\ ,\n \"parameter_setting\": [\n {\n \"name\":\"D\",\n\ \ \"value\":\"true\"\n },\n {\n \"name\":\"\ Q\",\n \"value\":\"weka.classifiers.bayes.net.search.local.K2\"\ \n },\n {\n \"name\":\"P\",\n \"value\":\"1\"\ \n },\n {\n \"name\":\"S\",\n \"value\":\"BAYES\"\ \n }\n ],\n \"input_data\":\n {\n \"dataset\"\ :\n {\n \"did\":\"28\",\n \"name\":\"\ optdigits\",\n \"url\":\"https:\\/\\/www.openml.org\\/data\\\ /download\\/28\\/dataset_28_optdigits.arff\"\n }\n },\n\ \ \"output_data\":\n {\n \"file\": [\n {\n \ \ \"did\":\"48838\",\n \"file_id\":\"261\",\n \ \ \"name\":\"description\",\n \"url\":\"https:\\\ /\\/www.openml.org\\/data\\/download\\/261\\/weka_generated_run935374685998857626.xml\"\ \n },\n {\n \"did\":\"48839\",\n \ \ \"file_id\":\"262\",\n \"name\":\"predictions\",\n\ \ \"url\":\"https:\\/\\/www.openml.org\\/data\\/download\\\ /262\\/weka_generated_predictions576954524972002741.arff\"\n \ \ }\n ],\n \"evaluation\": [\n {\n \ \ \"name\":\"area_under_roc_curve\",\n \"flow_id\":\"\ 4\",\n \"value\":\"0.990288\",\n \"array_data\"\ :\"[0.99724,0.989212,0.992776,0.994279,0.980578,0.98649,0.99422,0.99727,0.994858,0.976143]\"\ \n },\n {\n \"name\":\"confusion_matrix\"\ ,\n \"flow_id\":\"10\",\n \"array_data\":\"[[544,1,0,0,7,0,1,0,0,1],[0,511,21,1,0,1,3,1,5,28],[0,7,511,1,0,1,0,3,23,11],[0,2,2,519,0,3,0,12,16,18],[0,3,0,0,528,0,4,21,6,6],[0,1,0,7,5,488,2,0,4,51],[1,7,0,0,2,0,548,0,0,0],[0,2,0,1,9,1,0,545,4,4],[1,25,2,2,3,6,2,1,503,9],[0,7,0,20,16,5,0,19,9,486]]\"\ \n },\n {\n \"name\":\"f_measure\",\n \ \ \"flow_id\":\"12\",\n \"value\":\"0.922723\"\ ,\n \"array_data\":\"[0.989091,0.898857,0.935041,0.92431,0.927944,0.918156,0.980322,0.933219,0.895018,0.826531]\"\ \n },\n {\n \"name\":\"kappa\",\n \ \ \"flow_id\":\"13\",\n \"value\":\"0.913601\"\n \ \ }\n ]\n }\n }\n}" schema: $ref: "#/definitions/Run" 220: description: "Please provide run ID. In order to view run details, please\ \ provide the run ID" 221: description: "Run not found. The run ID was invalid, run does not exist\ \ (anymore)." delete: tags: - "run" summary: "Delete run" description: "Deletes a run. Upon success, it returns the ID of the deleted\ \ run.\n" parameters: - name: "id" in: "path" description: "Id of the run." required: true type: "number" format: "integer" - name: "api_key" in: "query" description: "API key to authenticate the user" required: true type: "string" responses: 200: description: "ID of the deleted run" examples: application/json: "{\n \"run_delete\": {\n \"id\": \"2520\"\n }\n\ }" schema: type: "object" properties: data_delete: $ref: "#/definitions/inline_response_200_14_data_delete" 390: description: "Please provide API key. In order to remove your content, please\ \ authenticate." 391: description: "Authentication failed. The API key was not valid. Please try\ \ to login again, or contact api administrators" 392: description: "Run does not exists. The run ID could not be linked to an\ \ existing run." 393: description: "Run is not owned by you. The run was owned by another user.\ \ Hence you cannot delete it." 394: description: "Deleting run failed. Deleting the run failed. Please contact\ \ support team." /run: post: tags: - "run" summary: "Upload run" description: "Uploads a run. Upon success, it returns the run id.\n" consumes: - "multipart/form-data" parameters: - name: "description" in: "formData" description: "An XML file describing the dataset. Only name, description,\ \ and data format are required. Also see the [XSD schema](https://www.openml.org/api/v1/xsd/openml.run.upload)\ \ and an [XML example](https://www.openml.org/api/v1/xml_example/run)." required: true type: "file" - name: "predictions" in: "formData" description: "The predictions generated by the run" required: true type: "file" - name: "model_readable" in: "formData" description: "The human-readable model generated by the run" required: false type: "file" - name: "model_serialized" in: "formData" description: "The serialized model generated by the run" required: false type: "file" - name: "api_key" in: "query" description: "Api key to authenticate the user" required: true type: "string" responses: 200: description: "Id of the uploaded run" examples: application/json: "{\n \"upload_run\": {\n \"id\": \"2520\"\n }\n\ }" schema: type: "object" properties: upload_flow: $ref: "#/definitions/inline_response_200_15_upload_flow" 201: description: "Authentication failed. The API key was not valid. Please try\ \ to login again, or contact api administrators." 202: description: "Please provide run XML." 203: description: "Could not validate run xml by XSD. Please double check that\ \ the xml is valid." 204: description: "Unknown task. The task with the given ID was not found in\ \ the database." 205: description: "Unknown flow. The flow with the given ID was not found in\ \ the database." 206: description: "Invalid number of files. The number of uploaded files did\ \ not match the number of files expected for the task type" 207: description: "File upload failed. One of the files uploaded has a problem." 208: description: "Error inserting setup record. Please contact api administrators" 210: description: "Unable to store run. Please contact api administrators." 211: description: "Dataset not in database. One of the datasets of the task was\ \ not included in database, please contact api administrators." 212: description: "Unable to store file. Please contact api administrators." 213: description: "Parameter in run xml unknown. One of the parameters provided\ \ in the run xml is not registered as parameter for the flow nor its components." 214: description: "Unable to store input setting. Please contact API support\ \ team." 215: description: "Unable to evaluate predictions. Please contact API support\ \ team." 216: description: "Error thrown by Java Application. Additional information field\ \ is provided." 217: description: "Error processing output data. Unknown or inconsistent evaluation\ \ measure. One of the provided evaluation measures could not be matched\ \ with a record in the math_function or flow table." 218: description: "Wrong flow associated with run. The flow implements a math_function,\ \ which is unable to generate predictions. Please select another flow." 219: description: "Error reading the XML document. The XML description file could\ \ not be verified." /run/list/limit/{limit}/offset/{offset}: get: tags: - "run" summary: "Get runs by limit/offset" description: "Returns an array with all runs matching the given limit and offset.\n" parameters: - name: "limit" in: "path" description: "The maximum number of runs to return. Without specifying an\ \ offset, it returns the first 'limit' runs." required: true type: "number" format: "integer" - name: "offset" in: "path" description: "Optional (although required in this interface). The offset to\ \ start from. With /limit/5/offset/10, runs 11..15 will be returned (these\ \ are indices, not IDs). Is ignored when no limit is given." required: true type: "number" format: "integer" - name: "api_key" in: "query" description: "API key to authenticate the user" required: false type: "string" responses: 200: description: "A list of runs descriptions" examples: application/json: runs: run: - run_id: "100" task_id: "28" setup_id: "12" flow_id: "67" uploader: "1" upload_time: "2014-04-06 23:30:40" error_message: [] - run_id: "101" task_id: "48" setup_id: "6" flow_id: "61" uploader: "1" upload_time: "2014-04-06 23:30:40" error_message: [] - run_id: "102" task_id: "41" setup_id: "3" flow_id: "58" uploader: "1" upload_time: "2014-04-06 23:30:40" error_message: [] schema: $ref: "#/definitions/RunList" 510: description: "Please provide at least task, flow or setup, uploader or run,\ \ to filter results, or limit the number of responses. The number of runs\ \ is huge. Please limit the result space." 511: description: "Input not safe. The input parameters (task_id, setup_id, flow_id,\ \ run_id, uploader_id) did not meet the constraints (comma separated list\ \ of integers)." 512: description: "There where no results. Check whether there are runs under\ \ the given constraint." 513: description: "Too many results. Given the constraints, there were still\ \ too many results. Please add more filters." /run/list/run/{ids}: get: tags: - "run" summary: "Get runs by id(s)" description: "Returns an array with all runs matching the given run id(s).\n" parameters: - name: "ids" in: "path" description: "Comma-separated list of run IDs, e.g. '1,2,3'." required: true type: "string" - name: "api_key" in: "query" description: "API key to authenticate the user" required: false type: "string" responses: 200: description: "A list of runs descriptions" examples: application/json: runs: run: - run_id: "100" task_id: "28" setup_id: "12" flow_id: "67" uploader: "1" upload_time: "2014-04-06 23:30:40" error_message: [] - run_id: "101" task_id: "48" setup_id: "6" flow_id: "61" uploader: "1" upload_time: "2014-04-06 23:30:40" error_message: [] - run_id: "102" task_id: "41" setup_id: "3" flow_id: "58" uploader: "1" upload_time: "2014-04-06 23:30:40" error_message: [] schema: $ref: "#/definitions/RunList" 510: description: "Please provide at least task, flow or setup, uploader or run,\ \ to filter results, or limit the number of responses. The number of runs\ \ is huge. Please limit the result space." 511: description: "Input not safe. The input parameters (task_id, setup_id, flow_id,\ \ run_id, uploader_id) did not meet the constraints (comma separated list\ \ of integers)." 512: description: "There where no results. Check whether there are runs under\ \ the given constraint." 513: description: "Too many results. Given the constraints, there were still\ \ too many results. Please add more filters." /run/list/tag/{tag}: get: tags: - "run" summary: "Get runs by tag" description: "Returns an array with all runs matching the given tag.\n" parameters: - name: "tag" in: "path" description: "The tag on which to filter the results." required: true type: "string" - name: "api_key" in: "query" description: "API key to authenticate the user" required: false type: "string" responses: 200: description: "A list of runs with the given tag" examples: application/json: runs: run: - run_id: "100" task_id: "28" setup_id: "12" flow_id: "67" uploader: "1" upload_time: "2014-04-06 23:30:40" error_message: [] - run_id: "101" task_id: "48" setup_id: "6" flow_id: "61" uploader: "1" upload_time: "2014-04-06 23:30:40" error_message: [] - run_id: "102" task_id: "41" setup_id: "3" flow_id: "58" uploader: "1" upload_time: "2014-04-06 23:30:40" error_message: [] schema: $ref: "#/definitions/RunList" 510: description: "Please provide at least task, tag, flow or setup, uploader\ \ or run, to filter results, or limit the number of responses. The number\ \ of runs is huge. Please limit the result space." 511: description: "Input not safe. The input parameters (task_id, setup_id, flow_id,\ \ run_id, uploader_id, tag) did not meet the constraints (comma separated\ \ list of integers)." 512: description: "There where no results. Check whether there are runs under\ \ the given constraint." 513: description: "Too many results. Given the constraints, there were still\ \ too many results. Please add more filters." /run/list/task/{ids}: get: tags: - "run" summary: "Get runs by task(s)" description: "Returns an array with all runs belonging to one of the given task(s).\n" parameters: - name: "ids" in: "path" description: "Comma-separated list of task IDs, e.g. '1,2,3'." required: true type: "string" - name: "api_key" in: "query" description: "API key to authenticate the user" required: false type: "string" responses: 200: description: "A list of runs descriptions" examples: application/json: runs: run: - run_id: "142564" task_id: "1" setup_id: "829" flow_id: "362" uploader: "212" upload_time: "2014-04-06 23:30:40" error_message: [] - run_id: "249273" task_id: "1" setup_id: "829" flow_id: "362" uploader: "348" upload_time: "2014-04-06 23:30:40" error_message: [] - run_id: "249280" task_id: "1" setup_id: "829" flow_id: "362" uploader: "348" upload_time: "2014-04-06 23:30:40" error_message: [] schema: $ref: "#/definitions/RunList" 510: description: "Please provide at least task, flow or setup, uploader or run,\ \ to filter results, or limit the number of responses. The number of runs\ \ is huge. Please limit the result space." 511: description: "Input not safe. The input parameters (task_id, setup_id, flow_id,\ \ run_id, uploader_id) did not meet the constraints (comma separated list\ \ of integers)." 512: description: "There where no results. Check whether there are runs under\ \ the given constraint." 513: description: "Too many results. Given the constraints, there were still\ \ too many results. Please add more filters." /run/list/uploader/{ids}: get: tags: - "run" summary: "Get runs by uploader(s)" description: "Returns an array with all runs uploaded by one of the given user(s).\n" parameters: - name: "ids" in: "path" description: "Comma-separated list of user IDs, e.g. '1,2,3'." required: true type: "string" - name: "api_key" in: "query" description: "API key to authenticate the user" required: false type: "string" responses: 200: description: "A list of runs descriptions" examples: application/json: runs: run: - run_id: "45015" task_id: "1" setup_id: "1225" flow_id: "673" uploader: "1" upload_time: "2014-04-06 23:30:40" error_message: [] - run_id: "45016" task_id: "1" setup_id: "1225" flow_id: "673" uploader: "1" upload_time: "2014-04-06 23:30:40" error_message: [] - run_id: "54729" task_id: "1" setup_id: "1468" flow_id: "707" uploader: "1" upload_time: "2014-04-06 23:30:40" error_message: [] schema: $ref: "#/definitions/RunList" 510: description: "Please provide at least task, flow or setup, uploader or run,\ \ to filter results, or limit the number of responses. The number of runs\ \ is huge. Please limit the result space." 511: description: "Input not safe. The input parameters (task_id, setup_id, flow_id,\ \ run_id, uploader_id) did not meet the constraints (comma separated list\ \ of integers)." 512: description: "There where no results. Check whether there are runs under\ \ the given constraint." 513: description: "Too many results. Given the constraints, there were still\ \ too many results. Please add more filters." /run/list/flow/{ids}: get: tags: - "run" summary: "Get runs by flow(s)" description: "Returns an array with all runs generated by the given flow(s).\n" parameters: - name: "ids" in: "path" description: "Comma-separated list of user IDs, e.g. '1,2,3'." required: true type: "string" - name: "api_key" in: "query" description: "API key to authenticate the user" required: false type: "string" responses: 200: description: "A list of runs descriptions" examples: application/json: runs: run: - run_id: "413" task_id: "1" setup_id: "10" flow_id: "65" uploader: "1" upload_time: "2014-04-06 23:30:40" error_message: [] - run_id: "6253" task_id: "1" setup_id: "10" flow_id: "65" uploader: "17" upload_time: "2014-04-06 23:30:40" error_message: [] - run_id: "10451" task_id: "1" setup_id: "79" flow_id: "65" uploader: "17" upload_time: "2014-04-06 23:30:40" error_message: [] schema: $ref: "#/definitions/RunList" 510: description: "Please provide at least task, flow or setup, uploader or run,\ \ to filter results, or limit the number of responses. The number of runs\ \ is huge. Please limit the result space." 511: description: "Input not safe. The input parameters (task_id, setup_id, flow_id,\ \ run_id, uploader_id) did not meet the constraints (comma separated list\ \ of integers)." 512: description: "There where no results. Check whether there are runs under\ \ the given constraint." 513: description: "Too many results. Given the constraints, there were still\ \ too many results. Please add more filters." /run/list/{filters}: get: tags: - "run" summary: "Get runs by limit, id, task, uploader and/or flow" description: "Returns an array with all runs matching any or all of the given\ \ filters. You can combine any of the above filters any way you want.\n" parameters: - name: "filters" in: "path" description: "Any combination of filters (run,task,uploader and/or flow) and\ \ corresponding comma-separated IDs, e.g. 'run/1,2,3/uploader/1' or 'task/1,2,3/flow/1,2'.\ \ With or without limit." required: true type: "string" - name: "api_key" in: "query" description: "API key to authenticate the user" required: false type: "string" responses: 200: description: "A list of runs descriptions" examples: application/json: runs: run: - run_id: "100" task_id: "28" setup_id: "12" flow_id: "67" uploader: "1" upload_time: "2014-04-06 23:30:40" error_message: [] - run_id: "101" task_id: "48" setup_id: "6" flow_id: "61" uploader: "1" upload_time: "2014-04-06 23:30:40" error_message: [] - run_id: "102" task_id: "41" setup_id: "3" flow_id: "58" uploader: "1" upload_time: "2014-04-06 23:30:40" error_message: [] schema: $ref: "#/definitions/RunList" 510: description: "Please provide at least task, flow or setup, uploader or run,\ \ to filter results, or limit the number of responses. The number of runs\ \ is huge. Please limit the result space." 511: description: "Input not safe. The input parameters (task_id, setup_id, flow_id,\ \ run_id, uploader_id) did not meet the constraints (comma separated list\ \ of integers)." 512: description: "There where no results. Check whether there are runs under\ \ the given constraint." 513: description: "Too many results. Given the constraints, there were still\ \ too many results. Please add more filters." /run/tag: post: tags: - "run" summary: "Tag a run" description: "Tags a run." consumes: - "application/x-www-form-urlencoded" parameters: - name: "run_id" in: "formData" description: "Id of the run." required: true type: "number" format: "integer" - name: "tag" in: "formData" description: "Tag name" required: true type: "string" - name: "api_key" in: "formData" description: "Api key to authenticate the user" required: true type: "string" responses: 200: description: "The id of the tagged run" examples: application/json: "{\n \"run_tag\": {\n \"id\": \"2\"\n }\n}" schema: type: "object" properties: run_tag: $ref: "#/definitions/inline_response_200_16_run_tag" 470: description: "In order to add a tag, please upload the entity id (either\ \ data_id, flow_id, run_id) and tag (the name of the tag)." 471: description: "Entity not found. The provided entity_id {data_id, flow_id,\ \ run_id} does not correspond to an existing entity." 472: description: "Entity already tagged by this tag. The entity {dataset, flow,\ \ run} already had this tag." 473: description: "Something went wrong inserting the tag. Please contact OpenML\ \ Team." 474: description: "Internal error tagging the entity. Please contact OpenML Team." /run/untag: post: tags: - "run" summary: "Untag a run" description: "Untags a run." consumes: - "application/x-www-form-urlencoded" parameters: - name: "run_id" in: "formData" description: "Id of the run." required: true type: "number" - name: "tag" in: "formData" description: "Tag name" required: true type: "string" - name: "api_key" in: "formData" description: "Api key to authenticate the user" required: true type: "string" responses: 200: description: "The id of the untagged run" examples: application/json: "{\n \"run_untag\": {\n \"id\": \"2\"\n }\n}" schema: type: "object" properties: run_untag: $ref: "#/definitions/inline_response_200_17_run_untag" 475: description: "Please give entity_id {data_id, flow_id, run_id} and tag.\ \ In order to remove a tag, please upload the entity id (either data_id,\ \ flow_id, run_id) and tag (the name of the tag)." 476: description: "Entity {dataset, flow, run} not found. The provided entity_id\ \ {data_id, flow_id, run_id} does not correspond to an existing entity." 477: description: "Tag not found. The provided tag is not associated with the\ \ entity {dataset, flow, run}." 478: description: "Tag is not owned by you. The entity {dataset, flow, run} was\ \ tagged by another user. Hence you cannot delete it." 479: description: "Internal error removing the tag. Please contact OpenML Team." /run/evaluate: post: tags: - "run" summary: "Uploads a run evaluation" description: "Uploads a run evaluation. When successful, it returns the run\ \ id.\n" consumes: - "multipart/form-data" parameters: - name: "description" in: "formData" description: "An XML file describing the run evaluation.Also see the [XSD\ \ schema](https://www.openml.org/api/v1/xsd/openml.run.evaluate) and an\ \ [XML example](https://www.openml.org/api/v1/xml_example/run.evaluate)." required: true type: "file" - name: "api_key" in: "query" description: "Api key to authenticate the user" required: true type: "string" responses: 200: description: "Id of the evaluated run" examples: application/json: "{\n \"run_evaluate\": {\n \"id\": \"2520\"\n }\n\ }" schema: type: "object" properties: upload_flow: $ref: "#/definitions/inline_response_200_18_upload_flow" 422: description: "Upload problem description XML" 423: description: "Problem validating uploaded description file" 424: description: "Problem opening description xml" /run/reset/{id}: get: tags: - "run" summary: "Resets a run." description: "Removes all run evaluations. When a run is reset, the runs will\ \ automatically be evaluated as soon as they are picked up by the evaluation\ \ engine again.\n" parameters: - name: "id" in: "path" description: "Run ID." required: true type: "string" - name: "api_key" in: "query" description: "API key to authenticate the user" required: false type: "string" responses: 200: description: "Id of the evaluated run" examples: application/json: "{\n \"run_reset\": {\n \"id\": \"2520\"\n }\n}" schema: type: "object" properties: run_reset: $ref: "#/definitions/inline_response_200_18_upload_flow" 394: description: "Resetting run failed" 412: description: "Run does not exist" 413: description: "Run is not owned by you" /run/trace/{id}: get: tags: - "run" summary: "Get run trace" description: "Returns the optimization trace of run. The trace contains every\ \ setup tried, its evaluation, and whether it was selected.\n" parameters: - name: "id" in: "path" description: "ID of the run." required: true type: "number" format: "integer" - name: "api_key" in: "query" description: "API key to authenticate the user" required: false type: "string" responses: 200: description: "A run trace description" examples: application/json: "{\n \"trace\": {\n \"run_id\":\"573055\",\n \ \ \"trace_iteration\": {\n \"repeat\":\"0\",\n \"fold\"\ :\"0\",\n \"repeat\":\"0\",\n \"iteration\":\"0\",\n \ \ \"setup_string\":{\"parameter_minNumObj\": '1',\n \ \ \"parameter_confidenceFactor\": '0.1'}\n \"evaluation\"\ :\"94.814815\",\n \"selected\": \"true\"\n },\n \"trace_iteration\"\ : {\n \"repeat\":\"0\",\n \"fold\":\"0\",\n \"\ repeat\":\"0\",\n \"iteration\":\"1\",\n \"setup_string\"\ :{\"parameter_minNumObj\": '1',\n \"parameter_confidenceFactor\"\ : '0.25'}\n \"evaluation\": \"94.074074\",\n \"selected\"\ : \"true\"\n }\n }\n}" schema: $ref: "#/definitions/RunTrace" 570: description: "No successful trace associated with this run" post: tags: - "run" summary: "Upload run" description: "Uploads a run. Upon success, it returns the run id.\n" consumes: - "multipart/form-data" parameters: - name: "id" in: "path" description: "ID of the run." required: true type: "number" format: "integer" - name: "description" in: "formData" description: "An XML file describing the trace. Also see the [XSD schema](https://www.openml.org/api/v1/xsd/openml.run.trace)\ \ and an [XML example](https://www.openml.org/api/v1/xml_example/run.trace)." required: true type: "file" - name: "api_key" in: "query" description: "Api key to authenticate the user" required: true type: "string" responses: 200: description: "Id of the run with the trace" examples: application/json: "{\n \"run_trace\": {\n \"id\": \"2520\"\n }\n}" schema: type: "object" properties: upload_flow: $ref: "#/definitions/inline_response_200_20_upload_flow" 561: description: "Problem with uploaded trace file." 562: description: "Problem validating xml trace file." 563: description: "Problem loading xml trace file." /evaluation/list/run/{ids}: get: tags: - "evaluation" summary: "Get evaluations by run id(s)" description: "Returns an array with all evaluations matching the given run id(s).\n" parameters: - name: "ids" in: "path" description: "Comma-separated list of run IDs, e.g. '1,2,3'." required: true type: "string" - name: "api_key" in: "query" description: "API key to authenticate the user" required: false type: "string" responses: 200: description: "A list of evaluation descriptions" examples: application/json: evaluations: evaluation: - run_id: "1" task_id: "68" flow_id: "61" function: "area_under_roc_curve" upload_time: "2014-04-06 23:30:40" value: "0.839359" array_data: "[0,0.99113,0.898048,0.874862,0.791282,0.807343,0.820674]" - run_id: "1" task_id: "68" flow_id: "61" function: "f_measure" upload_time: "2014-04-06 23:30:40" value: "0.600026" array_data: "[0,0,0.711934,0.735714,0.601363,0.435678,0.430913]" - run_id: "1" task_id: "68" flow_id: "61" function: "predictive_accuracy" upload_time: "2014-04-06 23:30:40" value: "0.614634" array_data: [] schema: $ref: "#/definitions/EvaluationList" 540: description: "Please provide at least task, flow or setup, uploader or run,\ \ to filter results." 541: description: "Input not safe. The input parameters (task_id, setup_id, flow_id,\ \ run_id, uploader_id) did not meet the constraints (comma separated list\ \ of integers)." 542: description: "There where no results. Check whether there are runs under\ \ the given constraint." 543: description: "Too many results. Given the constraints, there were still\ \ too many results. Please add filters to narrow down the list." /evaluation/list/limit/{limit}/offset/{offset}: get: tags: - "evaluation" summary: "Get evaluations by limit/offset" description: "Returns an array with all evaluations matching the given limit/offset.\n" parameters: - name: "limit" in: "path" description: "The maximum number of datasets to return. Without specifying\ \ an offset, it returns the first 'limit' evaluations." required: true type: "number" format: "integer" - name: "offset" in: "path" description: "Optional (although required in this interface). The offset to\ \ start from. With /limit/5/offset/10, evaluations 11..15 will be returned\ \ (these are indices, not IDs). Is ignored when no limit is given." required: true type: "number" format: "integer" - name: "api_key" in: "query" description: "API key to authenticate the user" required: false type: "string" responses: 200: description: "A list of evaluations with the given limit/offset" examples: application/json: evaluations: evaluation: - run_id: "1" task_id: "68" flow_id: "61" function: "area_under_roc_curve" upload_time: "2014-04-06 23:30:40" value: "0.839359" array_data: "[0,0.99113,0.898048,0.874862,0.791282,0.807343,0.820674]" - run_id: "1" task_id: "68" flow_id: "61" function: "f_measure" upload_time: "2014-04-06 23:30:40" value: "0.600026" array_data: "[0,0,0.711934,0.735714,0.601363,0.435678,0.430913]" - run_id: "1" task_id: "68" flow_id: "61" function: "predictive_accuracy" upload_time: "2014-04-06 23:30:40" value: "0.614634" array_data: [] schema: $ref: "#/definitions/EvaluationList" 540: description: "Please provide at least task, tag, flow or setup, uploader\ \ or run, to filter results, or limit the number of responses." 541: description: "Input not safe. The input parameters (tag, task_id, setup_id,\ \ flow_id, run_id, uploader_id) did not meet the constraints (comma separated\ \ list of integers)." 542: description: "There where no results. Check whether there are runs under\ \ the given constraint." 543: description: "Too many results. Given the constraints, there were still\ \ too many results. Please add filters to narrow down the list." /evaluation/list/tag/{tag}: get: tags: - "evaluation" summary: "Get evaluations by tag" description: "Returns an array with all evaluations matching the given tag.\n" parameters: - name: "tag" in: "path" description: "The tag on which to filter the results." required: true type: "string" - name: "api_key" in: "query" description: "API key to authenticate the user" required: false type: "string" responses: 200: description: "A list of evaluations with the given tag" examples: application/json: evaluations: evaluation: - run_id: "1" task_id: "68" flow_id: "61" function: "area_under_roc_curve" upload_time: "2014-04-06 23:30:40" value: "0.839359" array_data: "[0,0.99113,0.898048,0.874862,0.791282,0.807343,0.820674]" - run_id: "1" task_id: "68" flow_id: "61" function: "f_measure" upload_time: "2014-04-06 23:30:40" value: "0.600026" array_data: "[0,0,0.711934,0.735714,0.601363,0.435678,0.430913]" - run_id: "1" task_id: "68" flow_id: "61" function: "predictive_accuracy" upload_time: "2014-04-06 23:30:40" value: "0.614634" array_data: [] schema: $ref: "#/definitions/EvaluationList" 540: description: "Please provide at least task, tag, flow or setup, uploader\ \ or run, to filter results, or limit the number of responses." 541: description: "Input not safe. The input parameters (tag, task_id, setup_id,\ \ flow_id, run_id, uploader_id) did not meet the constraints (comma separated\ \ list of integers)." 542: description: "There where no results. Check whether there are runs under\ \ the given constraint." 543: description: "Too many results. Given the constraints, there were still\ \ too many results. Please add filters to narrow down the list." /evaluation/list/task/{ids}: get: tags: - "evaluation" summary: "Get evaluations by task(s)" description: "Returns an array with all evaluations belonging to one of the\ \ given task(s).\n" parameters: - name: "ids" in: "path" description: "Comma-separated list of task IDs, e.g. '1,2,3'." required: true type: "string" - name: "api_key" in: "query" description: "API key to authenticate the user" required: false type: "string" responses: 200: description: "A list of evaluation descriptions" examples: application/json: evaluations: evaluation: - run_id: "1" task_id: "68" flow_id: "61" function: "area_under_roc_curve" upload_time: "2014-04-06 23:30:40" value: "0.839359" array_data: "[0,0.99113,0.898048,0.874862,0.791282,0.807343,0.820674]" - run_id: "1" task_id: "68" flow_id: "61" function: "f_measure" upload_time: "2014-04-06 23:30:40" value: "0.600026" array_data: "[0,0,0.711934,0.735714,0.601363,0.435678,0.430913]" - run_id: "1" task_id: "68" flow_id: "61" function: "predictive_accuracy" upload_time: "2014-04-06 23:30:40" value: "0.614634" array_data: [] schema: $ref: "#/definitions/EvaluationList" 540: description: "Please provide at least task, flow or setup, uploader or run,\ \ to filter results, or limit the number of responses." 541: description: "Input not safe. The input parameters (task_id, setup_id, flow_id,\ \ run_id, uploader_id) did not meet the constraints (comma separated list\ \ of integers)." 542: description: "There where no results. Check whether there are runs under\ \ the given constraint." 543: description: "Too many results. Given the constraints, there were still\ \ too many results. Please add filters to narrow down the list." /evaluation/list/uploader/{ids}: get: tags: - "evaluation" summary: "Get evaluations by uploader(s)" description: "Returns an array with all evaluations uploaded by one of the given\ \ user(s).\n" parameters: - name: "ids" in: "path" description: "Comma-separated list of user IDs, e.g. '1,2,3'." required: true type: "string" - name: "api_key" in: "query" description: "API key to authenticate the user" required: false type: "string" responses: 200: description: "A list of evaluation descriptions" examples: application/json: evaluations: evaluation: - run_id: "1" task_id: "68" flow_id: "61" function: "area_under_roc_curve" upload_time: "2014-04-06 23:30:40" value: "0.839359" array_data: "[0,0.99113,0.898048,0.874862,0.791282,0.807343,0.820674]" - run_id: "1" task_id: "68" flow_id: "61" function: "f_measure" upload_time: "2014-04-06 23:30:40" value: "0.600026" array_data: "[0,0,0.711934,0.735714,0.601363,0.435678,0.430913]" - run_id: "1" task_id: "68" flow_id: "61" function: "predictive_accuracy" upload_time: "2014-04-06 23:30:40" value: "0.614634" array_data: [] schema: $ref: "#/definitions/EvaluationList" 540: description: "Please provide at least task, flow or setup, uploader or run,\ \ to filter results, or limit the number of responses." 541: description: "Input not safe. The input parameters (task_id, setup_id, flow_id,\ \ run_id, uploader_id) did not meet the constraints (comma separated list\ \ of integers)." 542: description: "There where no results. Check whether there are runs under\ \ the given constraint." 543: description: "Too many results. Given the constraints, there were still\ \ too many results. Please add filters to narrow down the list." /evaluation/list/flow/{ids}: get: tags: - "evaluation" summary: "Get evaluations by flow(s)" description: "Returns an array with all evaluations generated by the given flow(s).\n" parameters: - name: "ids" in: "path" description: "Comma-separated list of user IDs, e.g. '1,2,3'." required: true type: "string" - name: "api_key" in: "query" description: "API key to authenticate the user" required: false type: "string" responses: 200: description: "A list of evaluations descriptions" examples: application/json: evaluations: evaluation: - run_id: "1" task_id: "68" flow_id: "61" function: "area_under_roc_curve" upload_time: "2014-04-06 23:30:40" value: "0.839359" array_data: "[0,0.99113,0.898048,0.874862,0.791282,0.807343,0.820674]" - run_id: "1" task_id: "68" flow_id: "61" function: "f_measure" upload_time: "2014-04-06 23:30:40" value: "0.600026" array_data: "[0,0,0.711934,0.735714,0.601363,0.435678,0.430913]" - run_id: "1" task_id: "68" flow_id: "61" function: "predictive_accuracy" upload_time: "2014-04-06 23:30:40" value: "0.614634" array_data: [] schema: $ref: "#/definitions/EvaluationList" 540: description: "Please provide at least task, flow or setup, uploader or run,\ \ to filter results, or limit the number of responses." 541: description: "Input not safe. The input parameters (task_id, setup_id, flow_id,\ \ run_id, uploader_id) did not meet the constraints (comma separated list\ \ of integers)." 542: description: "There where no results. Check whether there are runs under\ \ the given constraint." 543: description: "Too many results. Given the constraints, there were still\ \ too many results. Please add filters to narrow down the list." /evaluation/list/function/{name}: get: tags: - "evaluation" summary: "Get evaluations for a specific evaluation method" description: "Returns an array with all evaluations using the given function.\ \ Can be combined with all other filters.\n" parameters: - name: "name" in: "path" description: "Name of the evaluation measure, e.g. area_under_auc or predictive_accuracy.\ \ See the OpenML website for the complete list of measures." required: true type: "string" - name: "api_key" in: "query" description: "API key to authenticate the user" required: false type: "string" responses: 200: description: "A list of evaluations descriptions" examples: application/json: evaluations: evaluation: - run_id: "1" task_id: "68" flow_id: "61" function: "area_under_roc_curve" upload_time: "2014-04-06 23:30:40" value: "0.839359" array_data: "[0,0.99113,0.898048,0.874862,0.791282,0.807343,0.820674]" - run_id: "2" task_id: "69" flow_id: "61" function: "area_under_roc_curve" upload_time: "2014-04-07 23:30:40" value: "0.600026" array_data: "[0,0,0.711934,0.735714,0.601363,0.435678,0.430913]" - run_id: "3" task_id: "70" flow_id: "61" function: "area_under_roc_curve" upload_time: "2014-04-08 23:30:40" value: "0.839359" array_data: "[0,0.99113,0.898048,0.874862,0.791282,0.807343,0.820674]" schema: $ref: "#/definitions/EvaluationList" 540: description: "Please provide at least task, flow or setup, uploader or run,\ \ to filter results, or limit the number of responses." 541: description: "Input not safe. The input parameters (task_id, setup_id, flow_id,\ \ run_id, uploader_id) did not meet the constraints (comma separated list\ \ of integers)." 542: description: "There where no results. Check whether there are runs under\ \ the given constraint." 543: description: "Too many results. Given the constraints, there were still\ \ too many results. Please add filters to narrow down the list." /evaluation/list/{filters}: get: tags: - "evaluation" summary: "Get evaluations by run, task, uploader, function, and or flow (with\ \ or without limit)" description: "Returns an array with all evaluations matching any or all of the\ \ given filters. You can combine any of the four above filters any way you\ \ want.\n" parameters: - name: "filters" in: "path" description: "Any combination of filters (limit,run,task,uploader and/or flow)\ \ and corresponding comma-separated IDs, e.g. 'run/1,2,3/uploader/1' or\ \ 'task/1,2,3/flow/1,2'." required: true type: "string" - name: "api_key" in: "query" description: "API key to authenticate the user" required: false type: "string" responses: 200: description: "A list of evaluations descriptions" examples: application/json: evaluations: evaluation: - run_id: "1" task_id: "68" flow_id: "61" function: "area_under_roc_curve" upload_time: "2014-04-06 23:30:40" value: "0.839359" array_data: "[0,0.99113,0.898048,0.874862,0.791282,0.807343,0.820674]" - run_id: "1" task_id: "68" flow_id: "61" function: "f_measure" upload_time: "2014-04-06 23:30:40" value: "0.600026" array_data: "[0,0,0.711934,0.735714,0.601363,0.435678,0.430913]" - run_id: "1" task_id: "68" flow_id: "61" function: "predictive_accuracy" upload_time: "2014-04-06 23:30:40" value: "0.614634" array_data: [] schema: $ref: "#/definitions/EvaluationList" 540: description: "Please provide at least task, flow or setup, uploader or run,\ \ to filter results, or limit the number of responses." 541: description: "Input not safe. The input parameters (task_id, setup_id, flow_id,\ \ run_id, uploader_id) did not meet the constraints (comma separated list\ \ of integers)." 542: description: "There where no results. Check whether there are runs under\ \ the given constraint." 543: description: "Too many results. Given the constraints, there were still\ \ too many results. Please add filters to narrow down the list." /evaluation/request/{evaluation_engine_id}/{order}: get: tags: - "evaluation" summary: "Get an unevaluated run" description: "This call is for people running their own evaluation engines.\ \ It returns the details of a run that is not yet evaluated by the given evaluation\ \ engine. It doesn't evaluate the run, it just returns the run info.\n" parameters: - name: "evaluation_engine_id" in: "path" description: "The ID of the evaluation engine. You get this ID when you register\ \ a new evaluation engine with OpenML. The ID of the main evaluation engine\ \ is 1." required: true type: "string" - name: "order" in: "path" description: "When there are multiple runs still to evaluate, this defines\ \ which one to return. Options are 'normal' - the oldest run, 'reverse'\ \ - the newest run, or 'random' - a random run." required: true type: "string" - name: "api_key" in: "query" description: "API key to authenticate the user" required: false type: "string" responses: 100: description: "Function not valid." 200: description: "A list of evaluations descriptions" examples: application/json: evaluation_request: run: - run_id: "8943712" task_id: "3021" setup_id: "68799271" uploader: "1935" upload_time: "2018-04-03 21:05:38" schema: $ref: "#/definitions/EvaluationRequest" 545: description: "No unevaluated runs according to the criteria." 546: description: "Illegal filter." /estimationprocedure/list: get: tags: - "estimationprocedure" summary: "List all estimation procedures" description: "Returns an array with all model performance estimation procedures\ \ in the system.\n" parameters: - name: "api_key" in: "query" description: "API key to authenticate the user" required: false type: "string" responses: 200: description: "A list of estimation procedures" examples: application/json: "{\n \"estimationprocedures\": {\n \"estimationprocedure\"\ : [\n {\n \"id\":\"1\",\n \"ttid\":\"1\",\n \ \ \"name\":\"10-fold Crossvalidation\",\n \"type\":\"crossvalidation\"\ ,\n \"repeats\":\"1\",\n \"folds\":\"10\",\n \ \ \"stratified_sampling\":\"true\"\n },\n {\n \"id\"\ :\"2\",\n \"ttid\":\"1\",\n \"name\":\"5 times 2-fold\ \ Crossvalidation\",\n \"type\":\"crossvalidation\",\n \ \ \"repeats\":\"5\",\n \"folds\":\"2\",\n \"stratified_sampling\"\ :\"true\"\n }\n ]\n }\n}" schema: $ref: "#/definitions/EstimationProcedureList" 500: description: "No model performance estimation procedures available." definitions: Flow: type: "object" properties: flow_description: $ref: "#/definitions/Flow_flow_description" FlowList: type: "object" properties: flows: $ref: "#/definitions/FlowList_flows" Task: type: "object" properties: task_description: $ref: "#/definitions/Task_task_description" TaskList: type: "object" properties: task: $ref: "#/definitions/TaskList_task" EstimationProcedureList: type: "object" properties: estimationprocedures: $ref: "#/definitions/EstimationProcedureList_estimationprocedures" DataList: type: "object" properties: data: $ref: "#/definitions/DataList_data" DataQualities: type: "object" properties: data_qualities: $ref: "#/definitions/DataQualities_data_qualities" DataFeatures: type: "object" properties: data_features: $ref: "#/definitions/DataFeatures_data_features" Data: type: "object" properties: data_set_description: $ref: "#/definitions/Data_data_set_description" RunList: type: "object" properties: runs: $ref: "#/definitions/RunList_runs" EvaluationList: type: "object" properties: evaluations: $ref: "#/definitions/EvaluationList_evaluations" EvaluationRequest: type: "object" properties: evaluation_request: $ref: "#/definitions/EvaluationRequest_evaluation_request" DataUnprocessed: type: "object" properties: data_unprocessed: $ref: "#/definitions/DataUnprocessed_data_unprocessed" Setup: type: "object" properties: setup_parameters: $ref: "#/definitions/Setup_setup_parameters" Run: type: "object" properties: run_description: $ref: "#/definitions/Run_run_description" TaskType: type: "object" properties: id: type: "string" description: "ID of the task type, a positive integer" name: type: "string" description: "The name of the task type, e.g. Supervised Classification" description: type: "string" description: "A description of the task type" contributor: type: "array" items: type: "string" description: "A list of people who defined the task type" date: type: "string" description: "The date when the task type was created" input: type: "array" items: $ref: "#/definitions/TaskType_input" output: type: "array" items: $ref: "#/definitions/TaskType_output" TaskTypeList: type: "object" properties: task_types: $ref: "#/definitions/TaskTypeList_task_types" StudyList: type: "object" properties: study_list: $ref: "#/definitions/StudyList_study_list" RunTrace: type: "object" properties: trace: $ref: "#/definitions/RunTrace_trace" Error: type: "object" properties: code: type: "integer" format: "int32" message: type: "string" additional_message: type: "string" inline_response_200_data_delete: properties: id: type: "string" description: "ID of the deleted dataset, a positive integer" inline_response_200: properties: data_delete: $ref: "#/definitions/inline_response_200_data_delete" inline_response_200_1_upload_data_set: properties: id: type: "string" description: "ID of the uploaded dataset, a positive integer" inline_response_200_1: properties: upload_data_set: $ref: "#/definitions/inline_response_200_1_upload_data_set" inline_response_200_2_data_tag: properties: id: type: "string" description: "ID of the tagged dataset" inline_response_200_2: properties: data_tag: $ref: "#/definitions/inline_response_200_2_data_tag" inline_response_200_3_data_untag: properties: id: type: "string" description: "ID of the untagged dataset" inline_response_200_3: properties: data_untag: $ref: "#/definitions/inline_response_200_3_data_untag" inline_response_200_4_task_delete: properties: id: type: "string" description: "ID of the deleted task, a positive integer" inline_response_200_4: properties: task_delete: $ref: "#/definitions/inline_response_200_4_task_delete" inline_response_200_5_upload_task: properties: id: type: "string" description: "ID of the uploaded task, a positive integer" inline_response_200_5: properties: upload_task: $ref: "#/definitions/inline_response_200_5_upload_task" inline_response_200_6_task_tag: properties: id: type: "string" description: "ID of the tagged task" inline_response_200_6: properties: task_tag: $ref: "#/definitions/inline_response_200_6_task_tag" inline_response_200_7_task_untag: properties: id: type: "string" description: "ID of the untagged task" inline_response_200_7: properties: task_untag: $ref: "#/definitions/inline_response_200_7_task_untag" inline_response_200_8_flow_delete: properties: id: type: "string" description: "ID of the deleted flow, a positive integer" inline_response_200_8: properties: flow_delete: $ref: "#/definitions/inline_response_200_8_flow_delete" inline_response_200_9_upload_flow: properties: id: type: "string" description: "ID of the uploaded flow, a positive integer" inline_response_200_9: properties: upload_flow: $ref: "#/definitions/inline_response_200_9_upload_flow" inline_response_200_10_flow_exists: properties: exists: type: "string" description: "true or false" id: type: "string" description: "The id of the flow with the given name and (external) version" inline_response_200_10: properties: flow_exists: $ref: "#/definitions/inline_response_200_10_flow_exists" inline_response_200_11_flow_owned: properties: id: type: "array" items: type: "string" inline_response_200_11: properties: flow_owned: $ref: "#/definitions/inline_response_200_11_flow_owned" inline_response_200_12_flow_tag: properties: id: type: "string" description: "ID of the tagged flow" inline_response_200_12: properties: flow_tag: $ref: "#/definitions/inline_response_200_12_flow_tag" inline_response_200_13_flow_untag: properties: id: type: "string" description: "ID of the untagged flow" inline_response_200_13: properties: flow_untag: $ref: "#/definitions/inline_response_200_13_flow_untag" inline_response_200_14_data_delete: properties: id: type: "string" description: "ID of the deleted run, a positive integer" inline_response_200_14: properties: data_delete: $ref: "#/definitions/inline_response_200_14_data_delete" inline_response_200_15_upload_flow: properties: id: type: "string" description: "ID of the uploaded run, a positive integer" inline_response_200_15: properties: upload_flow: $ref: "#/definitions/inline_response_200_15_upload_flow" inline_response_200_16_run_tag: properties: id: type: "string" description: "ID of the tagged run" inline_response_200_16: properties: run_tag: $ref: "#/definitions/inline_response_200_16_run_tag" inline_response_200_17_run_untag: properties: id: type: "string" description: "ID of the untagged run" inline_response_200_17: properties: run_untag: $ref: "#/definitions/inline_response_200_17_run_untag" inline_response_200_18_upload_flow: properties: id: type: "string" description: "ID of the evaluated run, a positive integer" inline_response_200_18: properties: upload_flow: $ref: "#/definitions/inline_response_200_18_upload_flow" inline_response_200_19: properties: run_reset: $ref: "#/definitions/inline_response_200_18_upload_flow" inline_response_200_20_upload_flow: properties: id: type: "string" description: "ID of the run with the trace, a positive integer" inline_response_200_20: properties: upload_flow: $ref: "#/definitions/inline_response_200_20_upload_flow" Flow_flow_description_parameter: properties: name: type: "string" description: "The name of the parameter" data_type: type: "string" description: "The data type of the parameter" default_value: type: "string" description: "The default value of the parameter" description: type: "string" description: "A description of the parameter" Flow_flow_description: properties: id: type: "string" description: "ID of the flow, a positive integer" uploader: type: "string" description: "The uploader of the flow" name: type: "string" description: "The name of the flow" version: type: "string" description: "The version of the flow, set by OpenML. A positive integer" version_label: type: "string" description: "The version of the flow, as defined by the uploader, for reference.\ \ Can be any format as long as it is unique." description: type: "string" description: "Wiki description of the flow, in (Git flavoured) markdown format" upload_date: type: "string" description: "The datetime that the flow was uploaded, format yyyy-MM-dd HH:mm:ss" language: type: "string" description: "The programming language the flow is written in." dependencies: type: "string" description: "The libraries that this flow depends on, and their version numbers." tag: type: "array" description: "Tags added by OpenML users. Includes study tags in the form\ \ `study_1`" items: type: "string" parameter: type: "array" items: $ref: "#/definitions/Flow_flow_description_parameter" FlowList_flows_flow: properties: id: type: "string" description: "The flow ID" full_name: type: "string" description: "The full flow name (name + internal version number)" name: type: "string" description: "The flow name" version: type: "string" description: "The internal flow version" external_version: type: "string" description: "The external flow version" uploader: type: "string" description: "The ID of the person who uploaded the flow" FlowList_flows: properties: flow: type: "array" items: $ref: "#/definitions/FlowList_flows_flow" Task_task_description_data_set: properties: data_set_id: type: "string" description: "The id of the dataset" target_feature: type: "string" description: "The name of the target feature for this task" Task_task_description_estimation_procedure_parameter: properties: name: type: "string" description: "The name of the parameter" value: type: "string" description: "The value of the parameter" Task_task_description_estimation_procedure: properties: type: type: "string" description: "The type of procedure, e.g. crossvalidation" data_splits_url: type: "string" description: "The url where the data splits can be downloaded" parameter: type: "array" items: $ref: "#/definitions/Task_task_description_estimation_procedure_parameter" Task_task_description_evaluation_measures: properties: evaluation_measure: type: "string" description: "The evaluation measure to optimize in this task" Task_task_description_input: properties: name: type: "string" description: "The name of the input, e.g. source_data" data_set: $ref: "#/definitions/Task_task_description_data_set" estimation_procedure: $ref: "#/definitions/Task_task_description_estimation_procedure" cost_matrix: type: "array" description: "The cost matrix, indicating the costs for each type of misclassification" items: type: "array" items: type: "integer" format: "int64" evaluation_measures: $ref: "#/definitions/Task_task_description_evaluation_measures" Task_task_description_predictions_feature: properties: name: type: "string" description: "The name of the prediction feature, e.g. row_id" type: type: "string" description: "The type of the prediction feature, e.g. integer" Task_task_description_predictions: properties: format: type: "string" description: "The fromat of the predictions, e.g. ARFF" feature: type: "array" items: $ref: "#/definitions/Task_task_description_predictions_feature" Task_task_description_output: properties: name: type: "string" description: "The name of the output, e.g. predictions" predictions: $ref: "#/definitions/Task_task_description_predictions" Task_task_description: properties: task_id: type: "string" description: "ID of the task, a positive integer" task_type: type: "string" description: "The type of the task, e.g. Supervised Classification" input: type: "array" items: $ref: "#/definitions/Task_task_description_input" output: type: "array" items: $ref: "#/definitions/Task_task_description_output" tag: type: "array" items: type: "string" description: "Tags added by OpenML users. Includes study tags in the form\ \ `study_1`" TaskList_task_input: properties: name: type: "string" description: "The name of the input" value: type: "string" description: "The value of the input" TaskList_task_quality: properties: name: type: "string" description: "The name of the quality" value: type: "string" description: "The value of the quality" TaskList_task_task: properties: task_id: type: "string" description: "The ID of the task" task_type: type: "string" description: "The type of task (e.g. Supervised Classificationr)" did: type: "string" description: "The id of the source dataset" name: type: "string" description: "The name of the source dataset" status: type: "string" description: "The status of the source dataset, active, in_preparation, or\ \ deactivated" format: type: "string" description: "The format of the source dataset" input: type: "array" items: $ref: "#/definitions/TaskList_task_input" quality: type: "array" items: $ref: "#/definitions/TaskList_task_quality" tag: type: "array" items: type: "string" description: "Tags added by OpenML users. Includes study tags in the form\ \ `study_1`" TaskList_task: properties: task: type: "array" items: $ref: "#/definitions/TaskList_task_task" EstimationProcedureList_estimationprocedures_estimationprocedure: properties: id: type: "string" description: "The estimation procedure ID" ttid: type: "string" description: "The task type ID" name: type: "string" description: "The estimation procedure name, e.g. '10 fold Crossvalidation'" type: type: "string" description: "The estimation procedure type, e.g. 'crossvalidation'" repeats: type: "string" description: "The number of repeats, e.g. '10'" folds: type: "string" description: "The number of cross-validation folds, e.g. '10'" stratified_sampling: type: "string" description: "Whether or not the sampling is stratified, 'true' or 'false'" EstimationProcedureList_estimationprocedures: properties: estimationprocedure: type: "array" items: $ref: "#/definitions/EstimationProcedureList_estimationprocedures_estimationprocedure" DataList_data_quality: properties: name: type: "string" description: "The name of the property" value: type: "string" description: "The value of the property" DataList_data_dataset: properties: did: type: "string" description: "The dataset ID" name: type: "string" description: "The dataset name" status: type: "string" description: "The dataset status, either in_preparation, active, or deactivated" format: type: "string" description: "The data format of the dataset, e.g. ARFF" quality: type: "array" items: $ref: "#/definitions/DataList_data_quality" DataList_data: properties: dataset: type: "array" items: $ref: "#/definitions/DataList_data_dataset" DataQualities_data_qualities_quality: properties: name: type: "string" description: "The name of the dataset quality measures" value: type: "string" description: "The value for this dataset" DataQualities_data_qualities: properties: quality: type: "array" items: $ref: "#/definitions/DataQualities_data_qualities_quality" DataFeatures_data_features_feature: properties: index: type: "string" description: "Feature index" name: type: "string" description: "Feature name" data_type: type: "string" description: "Feature data type" is_target: type: "string" description: "Whether this feature is seen as a target feature" is_ignore: type: "string" description: "Whether this feature should be ignored in modelling (e.g. every\ \ value is unique)" is_row_identifier: type: "string" description: "Whether this feature is a row identifier" DataFeatures_data_features: properties: feature: type: "array" items: $ref: "#/definitions/DataFeatures_data_features_feature" Data_data_set_description: required: - "description" - "format" - "name" properties: id: type: "string" description: "ID of the dataset, a positive integer" name: type: "string" description: "The name of the dataset" version: type: "string" description: "The version of the dataset, set by OpenML. A positive integer" description: type: "string" description: "Wiki description of the dataset, in (Git flavoured) markdown\ \ format" format: type: "string" description: "Data format, for instance ARFF" upload_date: type: "string" description: "The datetime that the dataset was uploaded, format yyyy-MM-dd\ \ HH:mm:ss" licence: type: "string" description: "The licence granted for using the dataset, for instance Public\ \ or CC-BY" url: type: "string" description: "The URL where the data can be downloaded" file_id: type: "string" description: "The ID of the dataset file stored on the OpenML server" default_target_attribute: type: "string" description: "For tabular data, the name of the column that is typically used\ \ as the target attribute for that data set" version_label: type: "string" description: "The version of the dataset, as defined by the uploader, for\ \ reference. Can be any format as long as it is unique." tag: type: "array" description: "Tags added by OpenML users. Includes study tags in the form\ \ `study_1`" items: type: "string" visibility: type: "string" description: "Who can see the dataset. For instance `public`." original_data_url: type: "string" description: "The URL where the original data is hosted." status: type: "string" description: "active, in_preparation, or deactivated" md5_checksum: type: "string" description: "Checksum to verify downloads of the dataset" RunList_runs_run: properties: run_id: type: "string" description: "The run ID" task_id: type: "string" description: "The ID of the task solved by this run" setup_id: type: "string" description: "Ignore (internal representation of the parameter setting)" flow_id: type: "string" description: "The ID of the flow used in this run" uploader: type: "string" description: "The ID of the person uploading this run" error_message: type: "string" description: "Error message generated by the run (if any)" RunList_runs: properties: run: type: "array" items: $ref: "#/definitions/RunList_runs_run" EvaluationList_evaluations_evaluation: properties: run_id: type: "string" description: "The run ID" task_id: type: "string" description: "The ID of the tasks solved by this run" flow_id: type: "string" description: "The ID of the flow used by this run" function: type: "string" description: "The name of the evaluation function" value: type: "string" description: "The outcome of the evaluation" array_data: type: "string" description: "For structured evaluation measures, an array of evaluation values\ \ (e.g. per-class predictions, evaluation matrices,...)" EvaluationList_evaluations: properties: evaluation: type: "array" items: $ref: "#/definitions/EvaluationList_evaluations_evaluation" EvaluationRequest_evaluation_request_run: properties: run_id: type: "string" description: "ID of the run, a positive integer" task_id: type: "string" description: "ID of the task, a positive integer" setup_id: type: "string" description: "ID of the setup, a positive integer" uploader: type: "string" description: "ID of the uploader, a positive integer" upload_time: type: "string" description: "The datetime that the dataset was uploaded, format yyyy-MM-dd\ \ HH:mm:ss" EvaluationRequest_evaluation_request: properties: run: $ref: "#/definitions/EvaluationRequest_evaluation_request_run" DataUnprocessed_data_unprocessed_dataset: properties: did: type: "string" description: "ID of the dataset a positive integer" name: type: "string" description: "The name of the dataset" version: type: "string" description: "Version of the dataset, a positive integer" status: type: "string" description: "Status of the dataset" format: type: "string" description: "The dataset format, e.g. ARFF" DataUnprocessed_data_unprocessed: properties: dataset: $ref: "#/definitions/DataUnprocessed_data_unprocessed_dataset" Setup_setup_parameters_parameter_setting: properties: full_name: type: "string" description: "The full name of the hyperparameter" parameter_name: type: "string" description: "The short name of the hyperparameter" data_type: type: "string" description: "The data type of the hyperparameter value" default_value: type: "string" description: "The default value of the parameter used" value: type: "string" description: "The value of the parameter used" description: "Hyperparameter settings. Can be multiple." Setup_setup_parameters: properties: flow_id: type: "string" description: "ID of the flow, a positive integer" parameter_setting: type: "array" items: $ref: "#/definitions/Setup_setup_parameters_parameter_setting" Run_run_description_parameter_setting: properties: name: type: "string" description: "The name of the parameter" value: type: "string" description: "The value of the parameter used" description: "Parameter settings used in this run. Can be multiple." Run_run_description_input_data_dataset: properties: did: type: "string" description: "The id of the dataset" name: type: "string" description: "The name of the dataset" url: type: "string" description: "The download url of the dataset" Run_run_description_input_data: properties: dataset: $ref: "#/definitions/Run_run_description_input_data_dataset" description: "The input data for this run." Run_run_description_output_data_file: properties: did: type: "string" description: "The id of the uploaded file" file_id: type: "string" description: "The reference id of the uploaded file, for downloading afterward" name: type: "string" description: "The name of the uploaded file (e.g., description, predictions,\ \ model,...)" description: "Files uploaded by the user, e.g. run description, predictions. Can\ \ be multiple." Run_run_description_output_data_evaluation: properties: name: type: "string" description: "The name of the evaluation measure" flow_id: type: "string" description: "The id of the code used to compute this evaluation method" value: type: "string" description: "The result of the evaluation" array_data: type: "string" description: "For composite evaluation measures (e.g. per-class measures,\ \ confusion matrix), a string (JSON) representation of the evaluation." description: "Evaluations uploaded by the user, e.g. runtimes, or computed by\ \ the server (after run upload). Can be multiple." Run_run_description_output_data: properties: file: type: "array" items: $ref: "#/definitions/Run_run_description_output_data_file" evaluation: type: "array" items: $ref: "#/definitions/Run_run_description_output_data_evaluation" description: "The data generated by this run." Run_run_description: properties: id: type: "string" description: "ID of the run, a positive integer" uploader: type: "string" description: "The uploader of the run" uploader_name: type: "string" description: "The name of the uploader of the run" task_id: type: "string" description: "The id of the task solved by this run" task_type: type: "string" description: "The type of task solved by this run (e.g., classification)" task_evaluation_measure: type: "string" description: "The evaluation measure that is supposed to be optimized in the\ \ task, if any" flow_id: type: "string" description: "The id of the flow used in this run" flow_name: type: "string" description: "The name of the flow used in this run" setup_string: type: "string" description: "Configuration of the flow as a string, to be interpreted by\ \ the flow, its library, or command line interface." tag: type: "array" description: "Tags added by OpenML users. Includes study tags in the form\ \ `study_1`" items: type: "string" parameter_setting: type: "array" items: $ref: "#/definitions/Run_run_description_parameter_setting" input_data: $ref: "#/definitions/Run_run_description_input_data" output_data: $ref: "#/definitions/Run_run_description_output_data" TaskType_input: properties: name: type: "string" description: "The name of the input, e.g. source_data" data_set: $ref: "#/definitions/Task_task_description_data_set" estimation_procedure: $ref: "#/definitions/Task_task_description_estimation_procedure" cost_matrix: type: "array" items: type: "array" description: "The cost matrix, indicating the costs for each type of misclassification" items: type: "integer" format: "int64" evaluation_measures: $ref: "#/definitions/Task_task_description_evaluation_measures" TaskType_predictions: properties: format: type: "string" description: "The format of the predictions, e.g. ARFF" feature: type: "array" items: $ref: "#/definitions/Task_task_description_predictions_feature" TaskType_output: properties: name: type: "string" description: "The name of the output, e.g. predictions" predictions: $ref: "#/definitions/TaskType_predictions" TaskTypeList_task_types_task_type: properties: id: type: "string" description: "The ID of the task type" name: type: "string" description: "The name of the task type" description: type: "string" description: "A description of the task type" creator: type: "string" description: "A comma-separated list of the task type creators" TaskTypeList_task_types: properties: task_type: type: "array" items: $ref: "#/definitions/TaskTypeList_task_types_task_type" StudyList_study_list_study: properties: id: type: "string" description: "The ID of the study" alias: type: "string" description: "The alias of the study" name: type: "string" description: "The name of the study" creation_date: type: "string" description: "The datetime that the dataset was uploaded, format yyyy-MM-dd\ \ HH:mm:ss" creator: type: "string" description: "A comma-separated list of the task type creators" StudyList_study_list: properties: study: type: "array" items: $ref: "#/definitions/StudyList_study_list_study" RunTrace_trace_trace_iteration: properties: repeat: type: "string" description: "The number of the repeat in the outer cross-valudation" fold: type: "string" description: "The number of the fold in the inner cross-validation" iteration: type: "string" description: "A number of the optimization iteration" setup_string: type: "string" description: "A JSON representation of the setup (configuration)" evaluation: type: "string" description: "The evaluation score of the setup" selected: type: "string" description: "Whether this setup was selected as the best one (true or false)" RunTrace_trace: properties: run_id: type: "string" description: "run ID" trace_iteration: type: "array" items: $ref: "#/definitions/RunTrace_trace_trace_iteration"