org.openml.apiconnector.io

Class OpenmlConnector

java.lang.Object

org.openml.apiconnector.io.OpenmlBasicConnector

org.openml.apiconnector.io.OpenmlConnector

All Implemented Interfaces:

Serializable

public class OpenmlConnector
extends OpenmlBasicConnector

See Also:

Serialized Form

Field Summary

Fields inherited from class org.openml.apiconnector.io.OpenmlBasicConnector

api_key, API_PART, OPENML_URL, verboseLevel

Constructor Summary

Constructors

Constructor and Description
OpenmlConnector()
OpenmlConnector(String api_key)
OpenmlConnector(String url, String api_key)

Method Summary

Modifier and Type	Method and Description
int	dataFeaturesUpload(DataFeature features) Uploads data features of a given dataset (requires admin account)
int	dataQualitiesUpload(DataQuality qualities) Uploads data qualities of a given dataset (requires admin account)
int	dataUpload(DataSetDescription dsd, File dataset) Uploads a new dataset
int	flowUpload(Flow flow) Uploads a flow
int	runEvaluate(RunEvaluation runEvaluation) Uploads the evaluation of a run (admin rights required)
int	runTraceUpload(RunTrace trace) Uploads trace results of a run.
int	runUpload(Run run, Map<String,File> outputFiles) Uploads a run
int	studyUpload(Study study) Uploads study
int	taskUpload(TaskInputs task) Uploads a task

Methods inherited from class org.openml.apiconnector.io.OpenmlBasicConnector

dataDelete, dataFeatures, dataFeaturesUpload, dataGet, dataList, dataQualities, dataQualitiesList, dataqualitiesUnprocessed, dataQualitiesUpload, dataReset, datasetGet, datasetGetCsv, dataStatusUpdate, dataTag, dataUnprocessed, dataUntag, dataUpload, estimationProcedureGet, estimationProcedureList, evaluationList, evaluationRequest, fileUpload, flowDelete, flowExists, flowForceDelete, flowGet, flowTag, flowUntag, flowUpload, getApiKey, getApiUrl, getOpenmlFileUrl, getOpenmlFileUrl, getVerboselevel, getXSD, runDelete, runEvaluate, runGet, runList, runReset, runTag, runTrace, runTraceUpload, runUntag, runUpload, setApiKey, setupDelete, setupDifferences, setupDifferences, setupExists, setupParameters, setupTag, setupUntag, setVerboseLevel, studyAttach, studyDetach, studyGet, studyGet, studyGet, studyList, studyUpload, taskDelete, taskGet, taskInputs, taskList, taskSplitsGet, taskTag, taskUntag, taskUpload

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OpenmlConnector

public OpenmlConnector()

OpenmlConnector

public OpenmlConnector(String url,
                       String api_key)

OpenmlConnector

public OpenmlConnector(String api_key)

Method Detail

dataUpload

public int dataUpload(DataSetDescription dsd,
                      File dataset)
               throws Exception

Uploads a new dataset

Parameters:

dsd - - object describing the dataset

dataset - - file representing the dataset (arff). optional. In case it is not provided, the dataset description should have an URL provided

Returns:

The id under which the dataset was uploaded

Throws:

Exception - - Can be: IOException (problem with connection, server), ApiException (contains error code, see OpenML documentation)

dataFeaturesUpload

public int dataFeaturesUpload(DataFeature features)
                       throws Exception

Uploads data features of a given dataset (requires admin account)

Parameters:

features - - object describing the features

Returns:

the id of the dataset to which the features were attached

Throws:

Exception - - Can be: IOException (problem with connection, server), ApiException (contains error code, see OpenML documentation)

dataQualitiesUpload

public int dataQualitiesUpload(DataQuality qualities)
                        throws Exception

Uploads data qualities of a given dataset (requires admin account)

Parameters:

qualities - - object describing the qualities (or meta-features)

Returns:

id of the dataset to which the qualities were attached

Throws:

Exception - - Can be: IOException (problem with connection, server), ApiException (contains error code, see OpenML documentation)

flowUpload

public int flowUpload(Flow flow)
               throws Exception

Uploads a flow

Parameters:

flow - - An XML file describing the implementation. See documentation at openml.org.

Returns:

the id of the uploaded flow

Throws:

Exception - - Can be: IOException (problem with connection, server), ApiException (contains error code, see OpenML documentation)

runEvaluate

public int runEvaluate(RunEvaluation runEvaluation)
                throws Exception

Uploads the evaluation of a run (admin rights required)

Parameters:

runEvaluation - - description file (complying to xsd)

Returns:

the id of the run that was evaluated

Throws:

Exception - - Can be: IOException (problem with connection, server), ApiException (contains error code, see OpenML documentation)

runUpload

public int runUpload(Run run,
                     Map<String,File> outputFiles)
              throws Exception

Uploads a run

Parameters:

run - - An XML file describing the run. See documentation at openml.org.

outputFiles - - A Map>String,File< containing all relevant output files. Key "predictions" usually contains the predictions that were generated by this run.

Returns:

the id of the uploaded run

Throws:

Exception - - Can be: IOException (problem with connection, server), ApiException (contains error code, see OpenML documentation)

runTraceUpload

public int runTraceUpload(RunTrace trace)
                   throws Exception

Uploads trace results of a run. (admin rights required)

Parameters:

trace - - the trace description

Returns:

the id of the run to which the trace was attached

Throws:

Exception - - Can be: IOException (problem with connection, server), ApiException (contains error code, see OpenML documentation)

studyUpload

public int studyUpload(Study study)
                throws Exception

Uploads study

Parameters:

study - - object describing the study

Returns:

id of the study

Throws:

Exception - - Can be: IOException (problem with connection, server), ApiException (contains error code, see OpenML documentation)

taskUpload

public int taskUpload(TaskInputs task)
               throws Exception

Uploads a task

Parameters:

task - - task description.

Returns:

id of the just up[loaded tasl

Throws:

Exception - - Can be: IOException (problem with connection, server), ApiException (contains error code, see OpenML documentation)