v2025-12-06 or later
Xarvis is a neuromorphic training environment for RVX, based on
snnTorch.
This tutorial walks you through the setup and execution process.
Any part starting with # should be replaced or modified according to your environment.
On Linux, use the bash shell for command-line operations.
On Windows, use the Windows Power Shell for command-line operations.
If you install Xarvis before RVX,
please follow the manual below to install Git, make, and python3.
Install - Git, make,
and python3
cmd) git clone --recursive https://github.com/rvx-etri/npx-xarvis.gitSet the python3 command used in RVX.cmd) cd #(cloned directory)
cmd) make check_python
cmd) make check_pipcmd) cd #(cloned directory)
cmd) make config_python
inst) Verify that ‘rvx_python_config.mh’ is generated.
inst) Open ‘rvx_python_config.mh’ in a text editor
> If no path is listed, manually enter the path to the executable.
> If more than one path is listed, keep only the one you intend to use and delete the others.cmd) cd #(cloned directory)
cmd) make config_python
inst) Verify that ‘rvx_python_config.mh’ and ‘python3.bat’ are generated.
inst) Do NOT modify ‘rvx_python_config.mh’
inst) Open ‘python3.bat’ in a text editor
> If no path is listed, manually enter the path to the executable.
> If more than one path is listed, keep only the one you intend to use and delete the others.
> Do NOT remove ‘%*’ at the end of the line.
> If the directory name contains spaces, enclose it in double quotation marks as shown below.
ex) C:\Users\‘‘Kyuseung Han’’\... %*cmd) cd #(cloned directory)
cmd) make preinstall
cmd) make installcmd) cd #(cloned directory)
cmd) make config
> Check that the file ./rvx_setup.sh has been created.
inst) Add the line source #(cloned directory)/rvx_setup.sh to your .bashrc.
> Be sure to replace #(cloned directory) with the absolute path before adding it.
inst) To apply the changes to .bashrc, close and reopen the terminal.
> Now, #(cloned directory) is registered as ${XARVIS_HOME}.cmd) cd #(cloned directory)
cmd) make config
inst) This command add the environment variable
inst) To apply the changes, close and reopen the terminal.
> Now, #(cloned directory) is registered as ${XARVIS_HOME}.Xarvis uses text-based configuration files to define preprocessing
steps, training parameters, and network structures.
These files are located in #(cloned
directory)/npx_trainer/app.
An example configuration file is mnist_app.cfg.
cmd) cd #(cloned directory)/npx_trainer
cmd) make mnist_appThe training results will be generated in #(cloned directory)/npx_trainer/result.