Setup and installation¶
In this guide, we will help you to get up and running with Rubrix. Basically, you need to:
Install Rubrix
Launch the web app
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.12.0
with conda
conda install -c conda-forge rubrix-server
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.
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).
Have a look at our advanced setup guides if you want to (among other things):
deploy Rubrix on an AWS instance
Note
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.log(
rb.TextClassificationRecord(inputs="My first Rubrix example"),
name='example-dataset'
)
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.