Skip to content
This repository has been archived by the owner on Sep 9, 2020. It is now read-only.

Commit

Permalink
Minor fixes for documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
Axik committed Dec 26, 2016
1 parent 59fc163 commit 08ad161
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -82,17 +82,17 @@ The following table describes each of the arguments:
n_concurrent=<n_concurrent> Specifies the number of concurrent requests to submit. By default, 4 concurrent requests are submitted. Set ``<n_concurrent>`` to match the number of cores in the prediction API endpoint.
create_api_token Requests a new API token. To use this option, you must specify the ``password`` argument for this request (not the ``api_token`` argument). Specifying this argument invalidates your existing API token and creates and stores a new token for future prediction requests.
n_retry=<n_retry> Specifies the number of times DataRobot will retry if a request fails. A value of -1, the default, specifies an infinite number of retries.
pred_name=<pred_name> Applies a name to the prediction column of the output file. If you do not supply the argument, the column name is blank. For binary predictions assumes last class in lexical order as positive.
pred_name=<pred_name> Applies a name to the prediction column of the output file. If you do not supply the argument, the column name is blank. For binary predictions only column for positive class is put into output. Assumes last class in lexical order as positive.
skip_row_id Skip the row_id column in output.
output_delimiter=<delimiter> Specifies delimiter for output CSV. The special keyword "tab" can be used to indicate a tab delimited csv.
timeout=<timeout> The time, in seconds, that DataRobot tries to make a connection to satisfy a prediction request. When the timeout expires, the client (the batch_scoring command) closes the connection and retries, up to number of times. The default value is 30 seconds.
timeout=<timeout> The time, in seconds, that DataRobot tries to make a connection to satisfy a prediction request. When the timeout expires, the client (the batch_scoring command) closes the connection and retries, up to number of times (which is defined by value of ``<n_retry>``). The default value is 30 seconds.
delimiter=<delimiter> Specifies the delimiter to recognize in the input .csv file. E.g. "--delimiter=,". If not specified, the script tries to automatically determine the delimiter. The special keyword "tab" can be used to indicate a tab delimited csv.
resume Starts the prediction from the point at which it was halted. If the prediction stopped, for example due to error or network connection issue, you can run the same command with all the same all arguments plus this ``resume`` argument. In that case, the prediction will resume from the point at which it stopped. If you do not include this argument, and the script detects a previous script was interrupted mid-execution, DataRobot prompts whether to resume. When resuming a script, you cannot change the ``dataset_filepath``, ``model_id``, ``project_id``, ``n_samples``, or ``keep_cols``.
help Show help of usage.
fast Experimental: faster CSV processor. Note: does not support multiline csv.
stdout Send all log messages to stdout.
auto_sample Override "n_samples" and instead use chunks of about 1.5 MB. This can improve throughput. On by default.
encoding Declare the dataset encoding. If an encoding is not provided the batch_scoring script attempts to detect it. E.g "utf-8", "latin-1" or "iso2022_jp". See the Python docs for a list of valid encodings https://docs.python.org/3/library/codecs.html#standard-encodings
encoding Declare the dataset encoding. If an encoding is not provided the batch_scoring script attempts to detect it. E.g "utf-8", "latin-1" or "iso2022_jp". `See the Python docs for a list of valid encodings <https://docs.python.org/3/library/codecs.html#standard-encodings>`_.
skip_dialect Tell the batch_scoring script to skip csv dialect detection.
============================== ===========

Expand All @@ -103,7 +103,7 @@ Example::

Using configuration file
------------------------
The `batch_scoring` command check for the existence of a batch_scoring.ini file at the location `$HOME/batch_scoring.ini` (your home directory) and directory where you running the script (working directory). If this file exists, the command uses the same arguments that described above.
The `batch_scoring` command check for the existence of a batch_scoring.ini file at the location `$HOME/batch_scoring.ini` (your home directory) and directory where you running the script (working directory). If this file exists, the command uses the same arguments that described above. If the file does not exists it proceed normally with command line arguments. Command lines arguments has higher priority than file arguments, it means, that you can override file arguments using command line.

The format of a `batch_scoring.ini` file is as follows::

Expand Down

0 comments on commit 08ad161

Please sign in to comment.