Command line interface¶

Installing the FreeDiscovery Engine is controlled with the freediscovery CLI command. It can be used to start the server and to manage trained models.

freediscovery¶

usage: freediscovery [-h] {run,info,list,show,rm,download} ...

-h, --help¶: show this help message and exit

freediscovery download¶

Download a document dataset

usage: freediscovery download [-h] [-o OUTPUT]
                              {treclegal09_2k_subset,treclegal09_20k_subset,treclegal09_37k_subset,legal09int,fedora_ml_3k_subset,20_newsgroups_3categories,20_newsgroups_micro,20_newsgroups}

name¶: The dataset name

-h, --help¶: show this help message and exit

-o <output>, --output <output>¶: Folder where to save the output folder

freediscovery info¶

Return debug information about the FreeDiscovery install.

usage: freediscovery info [-h] [-a]

-h, --help¶: show this help message and exit

-a, --all¶: Print detailed report.

freediscovery list¶

List trained models.

usage: freediscovery list [-h] [-c CACHE_DIR]

-h, --help¶: show this help message and exit

-c <cache_dir>, --cache-dir <cache_dir>¶: The cache directory in which the trained models are saved. If this parameter is not specified the value in the environement variable FREEDISCOVERY_CACHE_DIR will be used if it is specified. Otherwise the default value is used.

freediscovery rm¶

Remove a trained model specified by its ID.

usage: freediscovery rm [-h] [-c CACHE_DIR] [-y] [-a] [mid]

mid¶: Model id

-h, --help¶: show this help message and exit

-c <cache_dir>, --cache-dir <cache_dir>¶: The cache directory in which the trained models are saved. If this parameter is not specified the value in the environement variable FREEDISCOVERY_CACHE_DIR will be used if it is specified. Otherwise the default value is used.

-y, --yes¶: Do not ask for confirmation.

-a, --all¶: Remove all models.

freediscovery run¶

The command used to start the server.

usage: freediscovery run [-h] [-c CACHE_DIR] [-y] [--debug]
                         [--hostname HOSTNAME] [-p PORT] [-s {flask,gunicorn}]
                         [--log-file LOG_FILE] [-n N]

-h, --help¶: show this help message and exit

-c <cache_dir>, --cache-dir <cache_dir>¶: The cache directory in which the trained models are saved. If this parameter is not specified the value in the environement variable FREEDISCOVERY_CACHE_DIR will be used if it is specified. Otherwise the default value is used.

-y, --yes¶: Do not ask for confirmation.

--debug¶: Start server in debug mode.

--hostname <hostname>¶: Server hostname.

-p <port>, --port <port>¶: Server port.

-s {flask,gunicorn}, --server {flask,gunicorn}¶: The server used to run freediscovery. “flask” is the server built-in in flask suitable for developpement.

--log-file <log_file>¶: Path to the log file.

-n <n>¶: Number of workers to use when starting the freediscovery server. Only affects the gunicorn server.

freediscovery show¶

Show detailed information about a trained model.

usage: freediscovery show [-h] [-c CACHE_DIR] mid

mid¶: Model id

-h, --help¶: show this help message and exit

-c <cache_dir>, --cache-dir <cache_dir>¶: The cache directory in which the trained models are saved. If this parameter is not specified the value in the environement variable FREEDISCOVERY_CACHE_DIR will be used if it is specified. Otherwise the default value is used.