一般操作コマンド¶

一般的な操作を行うコマンドの操作方法を解説します。

help¶

各コマンドの利用方法を表示するコマンドです。
また、一部の引数の書式についても表示できます。

使い方
softneuro help [-h] COMMAND

引数

引数名	内容
COMMAND	ヘルプを表示する対象のコマンド。

オプション

オプション	効果
-h, --help	本コマンドのヘルプを表示します。

使用例1

$ softneuro help version

usage: softneuro version [-h]

Show the SoftNeuro version.

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

使用例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¶

SoftNeuroのバージョン情報を表示するコマンドです。

使い方
softneuro [-h] version

オプション

オプション	効果
-h, --help	本コマンドのヘルプを表示します。

使用例

$ softneuro version

SoftNeuro 5.0.e41bf68

license¶

ライセンス情報の確認とライセンスキーの設定を行うためのコマンドです。

使い方
softneuro [-h] license [--key LICENSE_KEY]

オプション

Flag	Description
-h, --help	本コマンドのヘルプを表示します。
--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.

ライセンスキーの期限前¶

$ softneuro license

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

ライセンスキーの期限後¶

$ 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.

ライセンスキーの設定¶

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