/rlhfblender-ui

User Interface Implementation for: RLHF-Blender: A Configurable Interactive Interface for Learning from Diverse Human Feedback

Primary LanguageTypeScriptMIT LicenseMIT

RLHF-Blender UI

Implementation for the user interface of RLHF-Blender: A Configurable Interactive Interface for Learning from Diverse Human Feedback

Note

The following repository is part of of the RLHF-Blender project. You find the main repository (including the RLHF-Blender python package) here. Joint documentation: https://rlhfblender.readthedocs.io/en/latest/

RLHF-Blender UI

Installation

The RLHF-Blender UI can be installed alongside the main RLHF-Blender implementation by following the instructions in the main repository.

Standalone Installation

  1. Clone the repository
git clone https://github.com/ymetz/rlhfblender-ui.git
  1. Install dependencies
cd rlhfblender-ui
npm install
  1. Start the development server
npm start
  1. Open http://localhost:3000 to view it in the browser.

Usage

The RLHF-Blender UI is a React application that can be used to interact with the RLHF-Blender python package. The UI is designed to be used in a browser and can be accessed via the URL http://localhost:3000 after starting the development server. Additional guides to setup advanced interface (e.g. a local join setup via docker-compose or a remote setup in Kubernetes) is provided in the main repository.

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.