nth-iteration-labs / streamingbandit-ui Goto Github PK

Client that handles the administration of StreamingBandit online, or straight from your desktop. Setup and run streaming (contextual) bandit experiments in your browser.

Home Page: https://github.com/Nth-iteration-labs/streamingbandit

HTML 2.72% CSS 2.00% JavaScript 95.29%

streamingbandit-client react bandit-learning bandit-algorithm contextual-bandits multiarm-bandit javascript client webapp machine-learning

streamingbandit-ui's Introduction

StreamingBanditUI

StreamingBanditUI is an open source software tool written in Javascript (particularly, in React), intended to handle the administration of StreamingBandit server(s) over the Web or from your Desktop.

How to install and use StreamingBanditUI

To start, first make sure you have installed StreamingBandit server.

Then just follow these steps.

Download and unzip the StreamingBanditUI package here, if you haven't already. The StreamingBanditUI package will extract into a folder called StreamingBanditUI in the same directory that you downloaded StreamingBanditUI.zip
Upload the all of the files contained in the StreamingBanditUI folder to the desired location on your web server and visit index.html.

Run StreamingBanditUI by clicking on index.html in the StreamingBanditUI directory. This works in most, but not all browsers. Recent versions of Firefox, Microsoft Edge and Google Chrome should work fine.
Now enter the IP or domain together with the port on StreamingBandit is running (default: http://localhost:8080) and login to the StreamingBandit server.

That's it! You should now be able to access your StreamingBandit server, and start experimenting!

Browser compatibility

StreamingBandit Client is compatible with the following browsers:

Desktop	Mobile
Chrome 49.0 +	Android 56 +
MS Edge 12 (10240) +	Safari Mobile 10.0 +
Firefox 18 +	Edge (Yes) +
Safari 10.0 +	Firefox Mobile 18 +
Opera 36 +	IE Mobile 13 (10586) +
	Opera Mobile 37 +
	Chrome for Android 49.0 +

StreamingBandit Client is not compatible with Internet Explorer, and does not run locally (by clicking index.html) in Safari.

Specifications

RESTful frontend for StreamingBandit.

Build on Admin-on-rest and React.

To explore the source code, start with src/index.js.

Note: This project was bootstrapped with Create React App.

Available Scripts

The StreamingBandit team makes use of Yarn, but NPM should build StreamingBanditUI fine too. In that case, replace "yarn" below with "npm".

In the project directory, you can run:

`yarn 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.

`yarn 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!

streamingbandit-ui's People

Contributors

Stargazers

Watchers

Forkers

curioustauseef mi5victim nikolaismolin

streamingbandit-ui's Issues

Front-end from build not working in Safari

index.html in safari gives blank page.

Replace calls to localStorage.getItem

Replace calls to localStorage.getItem() with a function that offers a fallback when the browser's cache is cleared:

A "server_url" setting set in a configuration file.
If all else fails, http://localhost:8080.

Informative error message when loggin in with wrong uname and pass

(Perhaps also back-end?)

In any case, we now have no real feedback when logging in; would be nice to at least show whether (e.g.,) the username and pass were not ok.

Add theta_value and theta_key fields to the theta reset form

Currently, a user is unable to set the theta_value and theta_key parameters in the theta reset form. Adding two form fields where the user can set these parameters ought to resolve that.

Change "Fill fields with default values"

I'd say: "Use default experiment" is better. What about you? @robinvanemden @MKaptein

Feature request: show url's and exp_id

This is just a feature request since it was not easily seen in the current screenshot that I have:

It would be great if a) the exp_id is clearly visible in the from end, and b) properly formatted example of the getaction and setreward queries can easily be obtained for each experiment.

Enable users to change their password

Add the option to change your password to the configuration screen.

Enable users to set simulation parameters

Currently, you are unable to set your own simulation parameters. This can be resolved by adding form fields representing each simulation parameter to the form in the simulation tab.

Clicking on "Experiments" in empty installation gives "internal server error"

When logging in to a fresh new back-end instance clicking on "experiments" give a "internal server error": basically this call:

http://localhost:8080/exp?_end=10&_order=DESC&_sort=id&_start=0

apparently fails. Perhaps its back-end?

Format history

Format the history nicely (i.e. no \n's).

When clicked for the first time, download buttons refresh the page

When you click one of the download buttons for the first time, they refresh the page, which switches to the first tab.

This is not ok, particularly as the Ajax download buttons function asynchronously: on click, a download button displays that it is now retrieving the relevant log data. When all data is in, it displays you can now click again to download the file. So its paramount the buttons stay in view.

Show example output in front-end?

Hi,

When people fill out the "get context" and get action fields, as well as the "default reward" it is not immediately clear what is expected. E.g., do we expect

self.context["bla"] = 10

or do we expect

{"bla":"10"}

(or something else). Maybe we can make this visually clear in some way?

Login should show address of the remote back-end

It is currently upon login unclear "where" you are logging in; this makes it difficult to know which server you are addressing when logging in.

Feature request: Hourly theta and Advice defaults

When setting up an experiment, it would be nice if the options Hourly theta and Advice have a standard option filled in. Maybe something like: Do not store theta hourly and No advice ID as default settings?