Pip Installation
1. Create a new [python virtual environment](https://docs.python.org/3/library/venv.html). ``` python -m venv rime-venv ``` 2. Activate the virtual environment.macOS & Linux
```bash source rime-venv/bin/activate ```Windows
```powershell .\rime-venv\Scripts\activate ``` 3. Update pip and install required Python packages from `trial_requirements.txt`. ``` pip install --upgrade pip pip install -r trial_requirements.txt ```Conda Installation
1. Create a new [conda virtual environment](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html). Replace `$PYTHON_VERSION_YOU_WISH_TO_USE` with the version of Python that you wish to use (e.g., `3.8`). ``` conda create --name rime-venv python=$PYTHON_VERSION_YOU_WISH_TO_USE ``` 2. Activate the virtual environment. ``` conda activate rime-venv ``` 5. Update pip and install required Python packages from `trial_requirements.txt`. ``` pip install --upgrade pip pip install -r trial_requirements.txt ``` ### Start RIMENOTE: Running the start command will generate a Robust Intelligence license file and place it in a newly created .robustintelligence folder in your $HOME directory.
1. Run the rime-helper `start` command to start the RIME backend and frontend. ```bash python rime_helper.py start ``` 2. Wait until you see the following message indicating that the backend and frontend have successfully started and that the UI can be viewed at [http://localhost:4000](http://localhost:4000). ```bash RIME is available at http://localhost:4000 ``` 3. (OPTIONAL) If you are running the Docker containers on a remote instance and would like to use **port forwarding** to view the UI on your local machine, we recommend using SSH tunneling: ```bash ssh -M -S rime-port-forwarding -fNT -L localhost:4000:localhost:4000 -L localhost:5555:localhost:5555 -L localhost:5001:localhost:5001 -L localhost:5002:localhost:5002 -L localhost:5004:localhost:5004 -L localhost:5012:localhost:5012 user@hostname ``` To terminate the session, you can run the following: ```bash ssh -S rime-port-forwarding -O exit user@hostname ``` ### Stop RIMEWARNING: The commands below will permanently delete existing RIME test runs.
To stop RIME, run the following. Note that this command will also delete existing RIME test runs. ```bash python rime_helper.py stop ``` **To completely remove RIME, you can uninstall.** ```bash python rime_helper.py uninstall ``` ## Install the Python Package 1. Install the `rime` Python package. ```bash pip install -r rime_requirements.txt ``` 2. Configure environment variables for use in CLI commands:macOS & Linux
```bash export RIME_UPLOAD_URL=localhost:5001 export RIME_FIREWALL_URL=localhost:5002 export RIME_DISABLE_TLS=True # Recommended for local uploads only! ```Windows
``` $Env:RIME_UPLOAD_URL = 'localhost:5001' $Env:RIME_FIREWALL_URL = 'localhost:5002' $Env:RIME_DISABLE_TLS = 'True' # Recommended for local uploads only! ``` {{ troubleshooting_local_installation_redirect }} ### Install the RIME NLP Dependencies (Optional) To use RIME with Natural Language Processing models, additional Python dependencies must be installed. ```bash pip install -r nlp_requirements.txt ``` ### Install the RIME CV Dependencies (Optional) To use RIME with Computer Vision models, additional Python dependencies must be installed. ```bash pip install -r cv_requirements.txt ```