MindInsight Commands

View Source On Gitee

  1. View the command help information.

    mindinsight --help
    
  2. View the version information.

    mindinsight --version
    
  3. Start the service.

    mindinsight start [-h] [--config <CONFIG>] [--workspace <WORKSPACE>]
                      [--port <PORT>] [--url-path-prefix <URL_PATH_PREFIX>]
                      [--reload-interval <RELOAD_INTERVAL>]
                      [--summary-base-dir <SUMMARY_BASE_DIR>]
    

    Optional parameters as follows:

    • -h, --help : Displays the help information about the startup command.

    • --config <CONFIG> : Specifies the configuration file or module. CONFIG indicates the physical file path (file:/path/to/config.py), or a module path (python:path.to.config.module) that can be identified by Python.

    • --workspace <WORKSPACE> : Specifies the working directory. The default value of WORKSPACE is $HOME/mindinsight.

    • --port <PORT> : Specifies the port number of the web visualization service. The value ranges from 1 to 65535. The default value of PORT is 8080.

    • --url-path-prefix <URL_PATH_PREFIX> : Specifies the URL path prefix of the web visualization service. URL path prefix consists of segments separated by slashes. Each segment supports alphabets / digits / underscores / dashes / dots, but cannot just be emtpy string / single dot / double dots. The default value of URL_PATH_PREFIX is empty string.

    • --reload-interval <RELOAD_INTERVAL> : Specifies the interval (unit: second) for loading data. The value 0 indicates that data is loaded only once. The default value of RELOAD_INTERVAL is 3 seconds.

    • --summary-base-dir <SUMMARY_BASE_DIR> : Specifies the root directory for loading training log data. MindInsight traverses the direct subdirectories in this directory and searches for log files. If a direct subdirectory contains log files, it is identified as the log file directory. If a root directory contains log files, it is identified as the log file directory. SUMMARY_BASE_DIR is the current directory path by default.

    When the service is started, the parameter values of the command line are saved as the environment variables of the process and start with MINDINSIGHT_, for example, MINDINSIGHT_CONFIG, MINDINSIGHT_WORKSPACE, and MINDINSIGHT_PORT.

  4. View the service process information.

    MindInsight provides user with web services. Run the following command to view the running web service process:

    ps -ef | grep mindinsight
    

    Run the following command to access the working directory WORKSPACE corresponding to the service process based on the service process ID:

    lsof -p <PID> | grep access
    

    Output with the working directory WORKSPACE as follows:

    gunicorn  <PID>  <USER>  <FD>  <TYPE>  <DEVICE>  <SIZE/OFF>  <NODE>  <WORKSPACE>/log/gunicorn/access.log
    
  5. Stop the service.

    mindinsight stop [-h] [--port PORT]
    

    Optional parameters as follows:

    • -h, --help : Displays the help information about the stop command.

    • --port <PORT> : Specifies the port number of the web visualization service. The value ranges from 1 to 65535. The default value of PORT is 8080.