🚀 Q-ReAlign - Process data with smart language models

Q-ReAlign helps you run language models on your personal computer. These models process, organize, and score text data. The software includes prepared tools for building datasets and caching your progress. You can choose from three different model sizes to balance speed and accuracy.
💻 System Requirements
Your computer needs specific hardware to run these models. Verify that your machine meets these specifications before you begin:
- Operating System: Windows 10 or Windows 11.
- Processor: Modern Intel Core i5 or AMD Ryzen 5 or better.
- Memory: 8GB of RAM. If you want to use the larger models, 16GB of RAM is necessary.
- Graphics: An NVIDIA graphics card with at least 6GB of video memory helps performance. If you do not have an NVIDIA card, the system uses your main processor, which will be slower.
- Storage: You need at least 20GB of free space on your hard drive to store the models and your data caches.
📥 How to Install
Q-ReAlign works as a portable application. You do not need to run an installer. Follow these steps to set up the software:
- Visit the official releases page to download the latest version.
- Select the file ending in .zip that matches your Windows version.
- Once the download finishes, open your Downloads folder in File Explorer.
- Right-click the zip file and select Extract All.
- Choose a folder where you want to keep the application.
- Open the folder you just created.
- Locate the file named Q-ReAlign.exe and double-click it to start the program.
The first time you run the application, it creates a configuration folder in your user directory. Do not close the window while it initializes the workspace.
⚙️ Setting Up Your Models
After you open the main window, the application checks for available models. You must download a checkpoint to start processing data.
- Open the Settings menu inside the application.
- Navigate to the Model Management tab.
- You will see three choices: 0.8B, 4B, and 9B.
- Click the Download button next to the model size you want to use.
- The 0.8B model is the smallest and runs fastest on older computers.
- The 9B model provides the most accurate results but requires more memory.
- Wait for the progress bar to finish. The application stores these files in the Data subfolder.
📊 Using the CLI Workflows
Q-ReAlign provides a command-line interface for advanced batch tasks. If you prefer to automate your workflow, follow these steps:
- Press the Windows key and type cmd to open the Command Prompt.
- Navigate to your Q-ReAlign folder by typing:
cd C:\Path\To\Your\Folder.
- Use the following command to start a scoring task:
Q-ReAlign --model 4B --input your_data.csv --output results.csv.
- The system logs every step in the terminal window.
- You can view progress updates by checking the log file inside the logs directory.
🛠️ Building Datasets
Clean data results in better model performance. You can use the built-in dataset builder to prepare your information.
- Click the Dataset Builder tab in the main interface.
- Select the Raw Data folder that contains your text files.
- Choose the format of your input data. The application supports plain text and spreadsheet formats.
- Set the caching toggle to On. This saves your progress so you can pause your work without losing data.
- Click Start Processing.
- The window displays the number of items processed and the remaining time.
📋 Troubleshooting Common Issues
If you encounter problems, check the solutions listed here:
- Application fails to open: Ensure you extracted the files from the zip archive rather than running the program directly from inside the archive.
- Slow performance: Close other memory-intensive applications such as web browsers while running large models.
- Out of memory error: Switch to a smaller model size in the Settings menu.
- Command not found: Make sure you typed the file path correctly in the Command Prompt or PowerShell window.
- Data not saving: Verify that you have write permissions for the folder where you installed the application.
💡 Best Practices
- Use the 0.8B model for quick tests. Use the 9B model for final work.
- Keep your dataset files small. Process large spreadsheets in chunks of 500 lines to maintain system stability.
- Clear the cache folder periodically to free up disk space if you switch between different projects.
- Update the software whenever a new version appears on the release page to get the latest performance patches.
📖 Frequently Asked Questions
What happens if I turn off the computer while a task runs?
The application saves your progress in the cache folder. When you reopen the program, it detects the saved state and offers to resume from where it stopped.
Can I move the application folder?
Yes, the application is portable. You can move the entire folder to an external drive or a different location on your computer without breaking the setup.
Does the software send my data to the internet?
No, the application runs entirely on your local machine. Your data never leaves your computer, which ensures your information remains private.
How do I clear the logs?
You can safely delete the files inside the logs folder at any time. The application recreates the folder automatically when you run it again.
Are there plans for a visual interface for all settings?
The team continues to refine the interface. Check the GitHub repository for updates and release notes regarding new features and interface improvements.