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
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]"
with conda
conda install -c conda-forge rubrix-server
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 <setting-up-elasticsearch-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 <advanced-setup-guides>
if you want to (among other things):
configure the Rubrix server <server-configurations>
share an ES instance with other applications <configure-elasticsearch-role-users>
deploy Rubrix on an AWS instance <deploy-to-aws-instance-using-docker-machine>
Note
You can also launch the web app via docker <launching-the-web-app-via-docker>
or docker-compose <launching-the-web-app-via-docker-compose>
. For the latter you do not need a running ES instance.
The following code will log one record into a data set called example-dataset
:
import rubrix as rb
rb.log(
rb.TextClassificationRecord(text="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.
To continue learning we recommend you to:
- Check our Guides and Tutorials.
- Read about Rubrix's main
concepts