Skip to content

Commit

Permalink
[skipci] Update generate_predictions documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
desilinguist committed Dec 3, 2018
1 parent 075971a commit a6aa480
Showing 1 changed file with 16 additions and 5 deletions.
21 changes: 16 additions & 5 deletions doc/utilities.rst
Original file line number Diff line number Diff line change
Expand Up @@ -113,25 +113,36 @@ Positional Arguments

Model file to load and use for generating predictions.

.. option:: input_file
.. option:: input_file(s)

A csv file, json file, or megam file (with or without the label column),
with the appropriate suffix.
One or more csv file(s), jsonlines file(s), or megam file(s) (with or without the
label column), with the appropriate suffix.

Optional Arguments
^^^^^^^^^^^^^^^^^^
.. option:: -a, --all_probabilities

Flag indicating whether to output the probabilities of all labels instead of just
the probability of the positive label.

.. option:: -i <id_col>, --id_col <id_col>

Name of the column which contains the instance IDs in ARFF, CSV, or TSV files.
(default: ``id``)

.. option:: -l <label_col>, --label_col <label_col>

Name of the column which contains the labels in ARFF, CSV, or TSV files.
For ARFF files, this must be the final column to count as the label.
For ARFF files, this must be the final column to count as the label.
(default: ``y``)

.. option:: -p <positive_label>, --positive_label <positive_label>

If the model is only being used to predict the probability of a particular
label, this specifies the index of the label we're predicting. 1 = second
label, which is default for binary classification. Keep in mind that labels
are sorted lexicographically. (default: 1)
are sorted lexicographically.
(default: 1)

.. option:: -q, --quiet

Expand Down

0 comments on commit a6aa480

Please sign in to comment.