@@ -33,7 +33,7 @@ Command-line Interface
33
33
~~~~~~~~~~~~~~~~~~~~~~
34
34
35
35
The main utility we provide is called ``run_experiment `` and it can be used to
36
- easily run a series of learners on datasets specified in a configuration file
36
+ easily run a series of learners on datasets specified in a configuration file
37
37
like:
38
38
39
39
.. code :: ini
42
42
experiment_name = Titanic_Evaluate_Tuned
43
43
# valid tasks: cross_validate, evaluate, predict, train
44
44
task = evaluate
45
-
45
+
46
46
[Input]
47
- # these directories could also be absolute paths
47
+ # these directories could also be absolute paths
48
48
# (and must be if you're not running things in local mode)
49
49
train_directory = train
50
50
test_directory = dev
@@ -57,13 +57,13 @@ like:
57
57
label_col = Survived
58
58
# Column in CSV containing instance IDs (if any)
59
59
id_col = PassengerId
60
-
60
+
61
61
[Tuning]
62
62
# Should we tune parameters of all learners by searching provided parameter grids?
63
63
grid_search = true
64
64
# Function to maximize when performing grid search
65
65
objectives = [' accuracy' ]
66
-
66
+
67
67
[Output]
68
68
# again, these can/should be absolute paths
69
69
log = output
@@ -89,11 +89,12 @@ Python API
89
89
~~~~~~~~~~
90
90
91
91
If you just want to avoid writing a lot of boilerplate learning code, you can
92
- also use our simple Python API. The main way you'll want to use the API is through
92
+ also use our simple Python API which also supports pandas DataFrames.
93
+ The main way you'll want to use the API is through
93
94
the ``Learner `` and ``Reader `` classes. For more details on our API, see
94
95
`the documentation <https://skll.readthedocs.org/en/latest/api.html >`__.
95
96
96
- While our API can be broadly useful, it should be noted that the command-line
97
+ While our API can be broadly useful, it should be noted that the command-line
97
98
utilities are intended as the primary way of using SKLL. The API is just a nice
98
99
side-effect of our developing the utilities.
99
100
@@ -104,7 +105,7 @@ A Note on Pronunciation
104
105
.. image :: doc/skll.png
105
106
:alt: SKLL logo
106
107
:align: right
107
-
108
+
108
109
.. container :: clear
109
110
110
111
.. image :: doc/spacer.png
@@ -123,7 +124,7 @@ Requirements
123
124
- `Grid Map <https://warehouse.python.org/project/gridmap >`__ (only required if you plan
124
125
to run things in parallel on a DRMAA-compatible cluster)
125
126
- `joblib <https://warehouse.python.org/project/joblib >`__
126
- - `PyYAML < https ://warehouse.python.org/project/PyYAML >`__
127
+ - `ruamel.yaml < http ://yaml.readthedocs.io/en/latest/overview.html >`__
127
128
- `configparser <https://warehouse.python.org/project/configparser >`__ (only required for
128
129
Python 2.7)
129
130
- `logutils <https://warehouse.python.org/project/logutils >`__ (only required for Python 2.7)
0 commit comments