Setup and installation#

In this guide, we will help you to get up and running with Rubrix. Basically, you need to:

  1. Install Rubrix

  2. Launch the web app

  3. Start logging data

1. Install Rubrix#

First, make sure you have Python 3.7 or above installed.

Then you can install Rubrix with pip or conda.

with pip

pip install "rubrix[server]==0.18.0"

with conda

conda install -c conda-forge "rubrix-server==0.18.0"

2. Launch the web app#

Rubrix uses Elasticsearch (ES) as its main persistent layer. If you do not have an ES instance running on your machine, we recommend setting one up via docker:

docker run -d --name elasticsearch-for-rubrix -p 9200:9200 -p 9300:9300 -e "ES_JAVA_OPTS=-Xms512m -Xmx512m" -e "discovery.type=single-node"


For more details about setting up ES via docker, check our advanced setup guide.

You can start the Rubrix web app via Python.

python -m rubrix

Afterward, you should be able to access the web app at http://localhost:6900/. The default username and password are rubrix and 1234 (see the user management guide to configure this).


You can also launch the web app via docker or docker-compose. For the latter you do not need a running ES instance.

3. Start logging data#

The following code will log one record into a data set called example-dataset:

import rubrix as rb

    rb.TextClassificationRecord(text="My first Rubrix example"),

If you now go to your Rubrix app at http://localhost:6900/, you will find your first data set.

Congratulations! You are ready to start working with Rubrix.

Next steps#

Have a look at our advanced setup guides if you want to (among other things):

To continue learning we recommend you to:

  • Check our Guides and Tutorials;

  • Read about Rubrix’s main concepts;