xai-corner

SourceForge.net Logo

Documentation

Running Xai environment

  1. GUI menu options
    • File
      • Open - opens a file selection dialog
      • Save - saves the algorithm to current xml file
      • Save as... - saves the algorithm to specified xml file
      • Export to SVG... - saves the algorithm to an SVG file
      • Quit - exists the application and terminates any running execution
    • Edit
      • Connect - after choosing this option, clicking on an output of some block will start drawing a connection, the other end of the connection should be dragged to desired input
      • Connect by id... - opens a dialog that allows to connect manually two blocks by specifying their ids and numbers of input/output
      • Edit block properties - creates a dialog window which enables editing of blocks internal parameters
      • Select all - selects all items of the algorithm
      • Remove - removes all selected items (blocks and connections)
    • Run
      • Start - starts the algorithm
      • Pause - pause (state of each block is preserved)
      • Stop - stops the algorithm (each block is reset to its default values)
      • Show current performance metrics - shows summary of execution times of each block
      • Export current execution times - saves all execution times for each block in a CSV file
    • Blocks - this menu contains all blocks registered in XAI, clicking on one of them simply adds a new instance of this block to the algorithm
    • Help
      • Help - pop-ups help window

      • About... - some basic information on the program

  2. Xai can be also ran without the GUI. The following command line parameters are available to control execution of algorithms: 
    3.   Usage:xai [POSIX or GNU long style options]
    -h (or --help)
      get this help message
    -v (or --version)
      get version information
    -f algorithm_file (or --file=algorithm_file)
      run and open the algorithm_file on startup
    -n (or --no-gui)
      run and start the algorithm specified using option (-f) without showing the GUI.
    -b path_to_blocks_dir (or --blocks=path_to_blocks_dir)
      specify path to directory with blocks.