General Commands¶

help¶

Shows usage help for each command. Also describes the formatting of some arguments.

Usage
softneuro help [-h] COMMAND

Arguments

Argument	Description
COMMAND	Command for which the help will be shown.

Flags

Flag	Description
-h, --help	Shows the help for this command.

Example 1

$ softneuro help version

usage: softneuro version [-h]

Show the SoftNeuro version.

[OPTIONS]
     -h, --help  show this help message and exit.

Example 2

$ softneuro help routine_desc

usage: DEVICE[:DTYPE][:CH][/LEVEL][/AUX]

The routine descriptor represents routine information. It may be followed by
layer indices starting with @ ('softneuro help layer_indices' for more detail).

[REQUIRED]
    DEVICE  device name. 'cpu', 'opencl', 'cuda', etc.

[OPTIONS]
    DTYPE   a data type. 'float32' (default), 'float16', 'qint8', etc.
    CH      a channels position. 'chf' (channels-first) or 'chl'
            (channels-last, default).
    LEVEL   a optimization level. 'naive', 'fast' (default) or 'faster'.
    AUX     auxiliary information. Any text can be used except those used in
            LEVEL.

[EXAMPLES]
    cpu/faster/wg3x3_nxn
        DEVICE='cpu', DTYPE='float32', CH='chl', LEVEL='faster' and
        AUX='wg3x3_nxn'.
    opencl:float16
        DEVICE='opencl', DTYPE='float16', CH='chl', LEVEL='fast' and AUX=''.
    cpu:chf/naive
        DEVICE='cpu', DTYPE='float32', CH='chf', LEVEL='naive' and AUX=''.

version¶

Shows the SoftNeuro version.

Usage
softneuro [-h] version

Flags

Flag	Description
-h, --help	Shows the help for this command.

Example

$ softneuro version

SoftNeuro 5.0.e41bf68

license¶

Command for checking the license information and setting a license key.

Usage
softneuro [-h] license [--key LICENSE_KEY]

Flags

Flag	Description
-h, -help	Shows the help for this command.
--key	Specify a license key to be set.

Example

Checking license information¶

Before setting a license key¶

$ softneuro license

softneuro:Error: No license key.
softneuro:Error: User ID: 12345678-ABCDEFGH.
softneuro:Error: Send to Morpho staff this USER_ID to get LICENSE_KEY.

License key expiration date¶

$ softneuro license

License is valid.
User ID: 12345678-ABCDEFGH.
License Key: BC67E6E8-9AC2F88B-88F4005D-12238393.
Expired Date: 2021-03-14.

After license key expiration¶

$ softneuro license

softneuro:Error: License expired.
softneuro:Error: User ID: 12345678-ABCDEFGH.
softneuro:Error: License Key: B30CF510-B284DCEF-E9F7ECC3-9114E854.
softneuro:Error: Expired Date: 2021-02-11.

Setting a license key¶

$ softneuro license --key 12345678-90123456-ABCDEFGH-IJKLMNOP