Merge pull request #670 from EducationalTestingService/rename-log-to-logs

Rename `log` output option to `logs`

Author: desilinguist

README.rst

@@ -94,7 +94,7 @@ like:
   # Also compute the area under the ROC curve as an additional metric
   metrics = ['roc_auc']
   # The following can also be absolute paths
-  log = output
+  logs = output
   results = output
   predictions = output
   probability = true

doc/run_experiment.rst

@@ -1184,10 +1184,10 @@ by the experiment. The most common fields are ``logs``, ``models``,
 although they may be required in certain cases. A common option
 is to use the same directory for all of these fields.
 
-.. _log:
+.. _logs:
 
-log *(Optional)*
-""""""""""""""""
+logs *(Optional)*
+"""""""""""""""""
 
 Directory to store SKLL :ref:`log files <output_log_files>` in.
 If omitted, the current working directory is used.

doc/tutorial.rst

@@ -98,7 +98,7 @@ metrics we want to compute in addition to the tuning objective via the
 :ref:`metrics <metrics>` option. The other options are directories
 where you'd like all of the relevant output from your experiment to go.
 :ref:`results <results>` refers to the results of the experiment in both
-human-readable and JSON forms.  :ref:`log <log>` specifies where to put log
+human-readable and JSON forms.  :ref:`logs <logs>` specifies where to put log
 files containing any status, warning, or error messages generated during
 model training and evaluation.  :ref:`predictions <predictions>` refers to
 where to store the individual predictions generated for the test set.

examples/Tutorial.ipynb

@@ -256,7 +256,7 @@
       "save_cv_models = true\n",
       "models = output\n",
       "results = output\n",
-      "log = output\n",
+      "logs = output\n",
       "predictions = output\n"
      ]
     }

examples/boston/cross_val.cfg

@@ -23,5 +23,5 @@ objectives = ['pearson']
 [Output]
 # again, these can be absolute paths
 results = output
-log = output
+logs = output
 predictions = output

examples/boston/evaluate.cfg

@@ -23,5 +23,5 @@ objectives = ['unweighted_kappa']
 [Output]
 # again, these can be absolute paths
 results = output
-log = output
+logs = output
 predictions = output

examples/boston/voting.cfg

@@ -27,5 +27,5 @@ objectives = ['pearson']
 predictions = output
 models = output
 results = output
-log = output
+logs = output
 save_votes = true

examples/iris/cross_val.cfg

@@ -22,5 +22,5 @@ objectives = ['f1_score_micro']
 save_cv_models = true
 models = output
 results = output
-log = output
+logs = output
 predictions = output

examples/iris/evaluate.cfg

@@ -21,5 +21,5 @@ objectives = ['f1_score_micro']
 [Output]
 # again, these can be absolute paths
 results = output
-log = output
+logs = output
 predictions = output

examples/iris/voting.cfg

@@ -24,6 +24,6 @@ objectives = ["accuracy"]
 # again, these can be absolute paths
 models = output
 results = output
-log = output
+logs = output
 predictions = output
 save_votes = true

examples/titanic/cross_validate.cfg

@@ -17,6 +17,6 @@ objectives = ['accuracy']
 
 [Output]
 # again, these can be absolute paths
-log = output
+logs = output
 results = output
 predictions = output

examples/titanic/evaluate.cfg

@@ -17,7 +17,7 @@ objectives = ['accuracy']
 
 [Output]
 # again, these can be absolute paths
-log = output
+logs = output
 results = output
 predictions = output
 models = output

examples/titanic/evaluate_tuned.cfg

@@ -21,7 +21,7 @@ objectives = ['accuracy']
 # again, these can be absolute paths
 metrics = ['roc_auc']
 probability = true
-log = output
+logs = output
 results = output
 predictions = output
 models = output

examples/titanic/learning_curve.cfg

@@ -17,6 +17,6 @@ grid_search = false
 
 [Output]
 # again, these can be absolute paths
-log = output
+logs = output
 results = output
 metrics = ['accuracy']

examples/titanic/predict_train+dev.cfg

@@ -18,6 +18,6 @@ objectives = ['accuracy']
 
 [Output]
 # again, these can be absolute paths
-log = output
+logs = output
 predictions = output
 models = output

examples/titanic/predict_train+dev_tuned.cfg

@@ -19,6 +19,6 @@ objectives = ['accuracy']
 
 [Output]
 # again, these can be absolute paths
-log = output
+logs = output
 predictions = output
 models = output

examples/titanic/predict_train_only.cfg

@@ -18,6 +18,6 @@ objectives = ['accuracy']
 
 [Output]
 # again, these can be absolute paths
-log = output
+logs = output
 predictions = output
 models = output

examples/titanic/predict_train_only_tuned.cfg

@@ -19,6 +19,6 @@ objectives = ['accuracy']
 
 [Output]
 # again, these can be absolute paths
-log = output
+logs = output
 predictions = output
 models = output

examples/titanic/train.cfg

@@ -18,5 +18,5 @@ objectives = ['accuracy']
 
 [Output]
 # again, these can be absolute paths
-log = output
+logs = output
 models = output

skll/config/__init__.py

@@ -69,6 +69,7 @@ def __init__(self):
                     'ids_to_floats': 'False',
                     'label_col': 'y',
                     'log': '',
+                    'logs': '',
                     'learning_curve_cv_folds_list': '[]',
                     'learning_curve_train_sizes': '[]',
                     'min_feature_count': '1',
@@ -113,6 +114,7 @@ def __init__(self):
                                    'ids_to_floats': 'Input',
                                    'label_col': 'Input',
                                    'log': 'Output',
+                                   'logs': 'Output',
                                    'learning_curve_cv_folds_list': 'Input',
                                    'learning_curve_train_sizes': 'Input',
                                    'min_feature_count': 'Tuning',
@@ -398,8 +400,22 @@ def parse_config_file(config_path, log_level=logging.INFO):  # noqa: C901
     # next, get the log path before anything else since we need to
     # save all logging messages to a log file in addition to displaying
     # them on the console
+
+    # if the user specified "log" instead of "logs", we need
+    # to show a warning and save its value in "logs" instead
+    log_value = config.get("Output", "log")
+    show_log_warning = False
+    if log_value:
+        # since we do not have a logger yet, we will show the warning later
+        show_log_warning = True
+        config.set('Output', 'logs', log_value)
+        config.remove_option('Output', 'log')
+
+    # now get the value from the 'logs' field
+    log_value = config.get("Output", "logs")
+
     try:
-        log_path = locate_file(config.get("Output", "log"), config_dir)
+        log_path = locate_file(log_value, config_dir)
     except IOError as e:
         if e.errno == errno.ENOENT:
             log_path = e.filename
@@ -416,6 +432,13 @@ def parse_config_file(config_path, log_level=logging.INFO):  # noqa: C901
                              filepath=main_log_file,
                              log_level=log_level)
 
+    # now show the 'log' warning, if any, since we have the logger set up
+    if show_log_warning:
+        logger.warning("The 'log' option in the [Output] section is deprecated "
+                       "and will be removed in the next version. Use 'logs' "
+                       "instead.")
+        show_log_warning = False
+
     if config.has_option("General", "task"):
         task = config.get("General", "task")
     else: