Welcome to Royal FLush’s documentation!
Installation Guide
To install Royal FLush for CPU-only run:
pip install royalflush
To install Royal FLush with CUDA 12.6 in Windows, use the following command:
pip install royalflush --extra-index-url https://download.pytorch.org/whl/cu126
Warning
Incorrect installation may cause issues! Ensure you use the correct CUDA version for PyTorch 2.6.0. If you are unsure, check your CUDA version and visit: https://pytorch.org/get-started/locally/
Quick Start
Warning
This webpage is under construction. We are sorry for the inconvenience.
Before running Royal FLush, you need to install and start the XMPP server. We recommend (PyJabber)[https://pyjabber.readthedocs.io] or (Prosody)[https://prosody.im/] with the register in-band enabled.
To run an experiment after installing Royal FLush:
Usage: royalflush [OPTIONS] COMMAND [ARGS]…
Royal FLush CLI
- Options:
- --verbose
Enable verbose output.
- --help
Show this message and exit.
- Commands:
analyze-logs Analyze logs from a previous run inside the given folder. create-template Create a JSON template for the experiment. run Run the main RoyalFlush application with the provided… version Show the current version of RoyalFlush.
royalflush run ./test_experiment.json
Source code