From ae8fb90bec55f2c6576409281429b70a5898dcc8 Mon Sep 17 00:00:00 2001 From: ArlindKadra Date: Tue, 25 Apr 2017 16:41:58 +0200 Subject: [PATCH] Minor fixes in the documentation --- .gitignore | 2 +- .../org/openml/apiconnector/io/OpenmlConnector.java | 10 +++++----- .../java/org/openml/apiconnector/settings/Config.java | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/.gitignore b/.gitignore index 92d44ae3..a99b5bb6 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,3 @@ *.DS_Store */target/* -*/bin/* \ No newline at end of file +*/bin/* diff --git a/apiconnector/src/main/java/org/openml/apiconnector/io/OpenmlConnector.java b/apiconnector/src/main/java/org/openml/apiconnector/io/OpenmlConnector.java index 416701a7..71601a98 100644 --- a/apiconnector/src/main/java/org/openml/apiconnector/io/OpenmlConnector.java +++ b/apiconnector/src/main/java/org/openml/apiconnector/io/OpenmlConnector.java @@ -690,7 +690,7 @@ public UploadFlow flowUpload(File description, File binary, File source) throws * - An XML file describing the run. See documentation at * openml.org. * @param output_files - * - A Map containing all relevant output files. Key + * - A Map>String,File< containing all relevant output files. Key * "predictions" usually contains the predictions that were * generated by this run. * @return UploadRun - An object containing information on the @@ -878,13 +878,13 @@ public RunTraceUpload runTraceUpload(File trace) throws Exception { /** * Stores trace results in the database, typically used when an internal parameter optimization loop was executed. (admin rights required, typically executed by evaluation engine) * - * @param trace - the trace description xml + * @param trace_id - the trace description xml * @return * @throws Exception */ - public RunTrace runTrace(int run_id) throws Exception { + public RunTrace runTrace(int trace_id) throws Exception { - Object apiResult = HttpConnector.doApiRequest(OPENML_URL + API_PART + "run/trace/" + run_id, getApiKey(), verboseLevel); + Object apiResult = HttpConnector.doApiRequest(OPENML_URL + API_PART + "run/trace/" + trace_id, getApiKey(), verboseLevel); if (apiResult instanceof RunTrace) { return (RunTrace) apiResult; } else { @@ -947,7 +947,7 @@ public RunReset runReset(int run_id) throws Exception { /** * A list with the parameter settings of a setup * - * @param a file equivalent to run description, but only featuring the parts important to parameters + * @param description - a file equivalent to run description, but only featuring the parts important to parameters * @return * @throws Exception */ diff --git a/apiconnector/src/main/java/org/openml/apiconnector/settings/Config.java b/apiconnector/src/main/java/org/openml/apiconnector/settings/Config.java index 28276f80..d1f68957 100644 --- a/apiconnector/src/main/java/org/openml/apiconnector/settings/Config.java +++ b/apiconnector/src/main/java/org/openml/apiconnector/settings/Config.java @@ -36,7 +36,7 @@ * information. Highly recommended to use config file and this class when * executing experiments on a server. * - * @author J. N. van Rijn + * @author J. N. van Rijn >j.n.van.rijn@liacs.leidenuniv.nl< */ public class Config implements Serializable {