Setup and installation#
In this guide, we will help you to get up and running with Rubrix. Basically, you need to:
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 install "rubrix[server]==0.17.0"
conda install -c conda-forge "rubrix-server==0.17.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" docker.elastic.co/elasticsearch/elasticsearch-oss:7.10.2
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
3. Start logging data#
The following code will log one record into a data set called
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.
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;