zeff commandline

Zeff commandline tool man page.

Zeff

Usage

Name

zeff

Synopsis

zeff

Description

zeff simplifies experimentation with Zeff Cloud API.

Options

-h --help

Display help.

--version

Show version for zeff.

--verbose {{critical,error,warning,info,debug}}

Change the root logger logging level and the root logger handler name console logging level. Other loggers and handlers are unchanged, but named loggers that use console handler may emit more log information.

Sub-commands

init

Setup a new project in the current directory.

upload

Build, validate, and upload training records.

train

Control training sessions.

predict

Upload record to infer a prediction.

Configuration

Configuration may be done through command line options or may be set in configuration files that are read from standard locations (/etc/zeff.conf, ${HOME}/.config/zeff/zeff.conf, ${PWD}/zeff.conf), if the file exists.

Logging

Logging configuration will use either ${PWD}/zeff_logging.conf or a default internal configuration.

Named Loggers
zeffclient.record.generator

Used during the configuration generation stage as configuration strings are created.

zeffclient.record.builder

Used during the builder stage as records are being built from the configuration string parameter.

zeffclient.record.validator

Used during the validation stage as records are being validated.

zeffclient.record.uploader

Used during the upload stage as records are being uploaded.

The single unamed root logger will have log messages that are not associated with the generator, builder, validator, or uploader stages.

Default Configuration

The default configuration of the named loggers is to warning and higher level log messages to the console, and will emit info and higher level log messages associated named and dated log files in ${PWD}/var/log (e.g. ${PWD}/var/log/builder_2019-12-16T11:23:47.log if the log file for the builder stage for an execution run that started on 16 Dec 2019 at 11:23:47 local time).

The named loggers and the root logger will emit log messages of debug or higher level into a master log file in ${PWD}/var/log. The master log file will be dated with the start date and time of the run.

The ${PWD}/var/log directory may be removed at anytime: it will be recreated on the next run of zeff.

Exit Status

The following exit values shall be returned:

0

Successful completion.

>0

An error occurred (Standard errors from <errno.h>).