Practical overview
When it fits
Use NeuroRVQ when a research workflow needs biosignal tokenization, reconstruction examples, or pretrained models for representation-learning experiments.
Who it is for
- Researchers studying biosignal tokenization and generative foundation models
- Developers exploring EEG, ECG, EMG or PPG representation learning
- Brain-computer-interface researchers investigating downstream use of learned biosignal representations
Documented uses
- Convert multivariate biosignal time series into discrete, multi-scale tokens.
- Inspect reconstruction examples for supported biosignal modalities.
- Load pretrained tokenizer and foundation-model weights for research.
- Explore fine-tuning foundation models, following the repository’s data instructions for custom datasets.
Requirements & limits
- The project supplies code and pretrained model files rather than a documented hosted service.
- The documented setup uses Conda, Python 3.10 and the repository requirements file.
- The README lists tokenizer variants for EEG, EMG, ECG and PPG, but foundation-model variants for EEG, EMG and ECG.
- Custom-dataset fine-tuning depends on following the repository’s data instructions.
- No license is listed in the repository metadata.
Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.
Install NeuroRVQ and download EEG model files
Prepare a Python 3.10 Conda environment with the repository requirements and download the EEG tokenizer, foundation model, and sample signal.
Before you start
- Conda
- The NeuroRVQ repository cloned or otherwise available locally
Steps
Create and activate the environment:
conda create -n neurorvq python=3.10andconda activate neurorvq.From the repository directory, install dependencies with the command below.
pip install -r requirements.txtIn Python, use
hf_hub_downloadfromhuggingface_hubto downloadpretrained_models/tokenizers/NeuroRVQ_EEG_tokenizer_v1.pt,pretrained_models/foundation_models/NeuroRVQ_EEG_foundation_model_v1.pt, andexample_files/eeg_sample/example_eeg_file.xdffromntinosbarmpas/NeuroRVQ, settinglocal_dir="./"as in th
Expected outcome
The environment has the repository requirements installed, with the EEG tokenizer, foundation model, and example EEG file downloaded to the selected local directory.
Guide limitations
- The repository documentation gives no detailed dependency or hardware specifications beyond Python 3.10 and installing
requirements.txt. - The download example uses
local_dir="./"; model-loading examples expect model files under./pretrained_models/..., so ensure the downloaded files are placed at the paths used by those examples before loading. - Custom-dataset preparation is not covered by this setup recipe.
Run the EEG tokenizer reconstruction example
Load the EEG tokenizer and request its documented reconstruction example and plots.
Before you start
- NeuroRVQ environment with
requirements.txtinstalled - EEG tokenizer file available at
./pretrained_models/tokenizers/NeuroRVQ_EEG_tokenizer_v1.pt
Steps
In the repository environment, import
load_neurorqv_tokenizerfrominference.run.NeuroRVQ_EEG_tokenizer_example.Call
load_neurorqv_tokenizer(run_example=True, plot_results=True, verbose=True, model_path='./pretrained_models/tokenizers/NeuroRVQ_EEG_tokenizer_v1.pt').Use the example function’s documented options to inspect reconstruction results.
Expected outcome
The example is configured to run the EEG tokenizer reconstruction and display plots.
Guide limitations
- The documented call uses the example function; the README directs users to inspect that function to load and use the tokenizer in other workflows.
- The repository text does not specify expected numerical results or verify execution in a particular environment.
Sources & review
Source record details
- Source availability
- Active
- Sources checked
- 18 October 2026
- Original website title
- KonstantinosBarmpas/NeuroRVQ · Official homepage title · retained in its source language

