Rubrix

[0.13.1](https://github.com/recognai/rubrix/compare/v0.13.0...v0.13.1) (2022-04-01)


Bug Fixes

* **1244:** compute capitalness based on python methods ([1359](https://github.com/recognai/rubrix/issues/1359) [#1371](https://github.com/recognai/rubrix/issues/1371)) ([218f099](https://github.com/recognai/rubrix/commit/218f09937c85d9ee81f103fce1213aceb435a23d)), closes [#1244](https://github.com/recognai/rubrix/issues/1244)
* **1362:** using active api method instead instance ([1363](https://github.com/recognai/rubrix/issues/1363)) ([bcf446d](https://github.com/recognai/rubrix/commit/bcf446dcd671fa2b7eb78ae45f895af93ef14d53)), closes [#1362](https://github.com/recognai/rubrix/issues/1362)
* **1365:** create rules with regex queries ([1369](https://github.com/recognai/rubrix/issues/1369)) ([c2afc9c](https://github.com/recognai/rubrix/commit/c2afc9c66a9eeda8d94cda59b4e3fc22d891396f)), closes [#1365](https://github.com/recognai/rubrix/issues/1365)

[0.13.0](https://github.com/recognai/rubrix/compare/v0.12.1...v0.13.0) (2022-03-30)

🗂 Multilabel weak supervision
You can now build multilabel text classification datasets using query-based rules

If you want to get started, check out [this tutorial](https://rubrix.readthedocs.io/en/stable/tutorials/weak-supervision-multi-label.html).

https://user-images.githubusercontent.com/1107111/160930404-7b909f1e-b871-4e4c-b1c8-ea9eabfcad21.mp4


🤗 Reading Hugging Face datasets from the Hub
You can now read ANY text classification, NER, or text2text dataset directly from the Hub and load it into Rubrix.

To understand how Rubrix datasets work check out [this guide](https://rubrix.readthedocs.io/en/stable/guides/datasets.html).



👥 Redesigned team workspaces
Organizing teams and datasets is a key Rubrix feature. After several rounds of feedback with early users, we've completely redesigned the user experience. Let us know what you think.


You can get started and configure users and workspaces following [this guide](https://rubrix.readthedocs.io/en/stable/getting_started/user-management.html)

🔎 Guide for the query language and model
We have included a new [in-depth guide](https://rubrix.readthedocs.io/en/stable/guides/queries.html) about the Lucene-based query language and data model used for search, weak labeling, loading subsets of data, and metrics.
Features

* **1119:** users without personal datasets ([1282](https://github.com/recognai/rubrix/issues/1282)) ([555d41d](https://github.com/recognai/rubrix/commit/555d41d8919720398fac6a25f0a37d38a1741c34)), closes [#1119](https://github.com/recognai/rubrix/issues/1119) [#1318](https://github.com/recognai/rubrix/issues/1318) [#1317](https://github.com/recognai/rubrix/issues/1317) [#1323](https://github.com/recognai/rubrix/issues/1323) [#1324](https://github.com/recognai/rubrix/issues/1324)
* **1130:** cleanup rb namespace by refactoring client API ([1160](https://github.com/recognai/rubrix/issues/1160)) ([a0fdd8e](https://github.com/recognai/rubrix/commit/a0fdd8e4eb835d6c6b52f9c3a29d070f4ee77342)), closes [#1130](https://github.com/recognai/rubrix/issues/1130)
* **1144:** weak supervision for multilabel datasets ([1166](https://github.com/recognai/rubrix/issues/1166)) ([fd95bae](https://github.com/recognai/rubrix/commit/fd95baea6efe9fbd00d0b6cae415cd4b0002226f)), closes [#1144](https://github.com/recognai/rubrix/issues/1144) [#1190](https://github.com/recognai/rubrix/issues/1190) [#1237](https://github.com/recognai/rubrix/issues/1237) [#1233](https://github.com/recognai/rubrix/issues/1233) [#1326](https://github.com/recognai/rubrix/issues/1326)
* **datasets:** simplify load flow from hf datasets with no rb format ([1234](https://github.com/recognai/rubrix/issues/1234)) ([a6da1cd](https://github.com/recognai/rubrix/commit/a6da1cd430f4f648decedc5cad17a8fa618bcf3f)), closes [#1327](https://github.com/recognai/rubrix/issues/1327)
* **1180:** show Rubrix version in the webapp ([1243](https://github.com/recognai/rubrix/issues/1243)) ([8c71ad9](https://github.com/recognai/rubrix/commit/8c71ad91f76ccac4bde8e702ccbf2b2e475006bf)), closes [#1180](https://github.com/recognai/rubrix/issues/1180) [#1350](https://github.com/recognai/rubrix/issues/1350) [#1349](https://github.com/recognai/rubrix/issues/1349)
* **1225:** prepare tokenclass dataset for hf training ([1231](https://github.com/recognai/rubrix/issues/1231)) ([ae5e7cd](https://github.com/recognai/rubrix/commit/ae5e7cdd5e0c2eb22d568881b3df6424e3e71e48)), closes [#1225](https://github.com/recognai/rubrix/issues/1225)
* **950:** using record search_keywords for highlighting ([1235](https://github.com/recognai/rubrix/issues/1235)) ([47616bf](https://github.com/recognai/rubrix/commit/47616bfa4d2eec8b90cfb1b798270f458a5c3c0e)), closes [#950](https://github.com/recognai/rubrix/issues/950) [#1278](https://github.com/recognai/rubrix/issues/1278) [#1316](https://github.com/recognai/rubrix/issues/1316) [#1315](https://github.com/recognai/rubrix/issues/1315)
* **981:** add majority voter with multi label support ([1228](https://github.com/recognai/rubrix/issues/1228)) ([8052aa8](https://github.com/recognai/rubrix/commit/8052aa8567d2bdb6f8e52381ca4614a7e1328f1a)), closes [#981](https://github.com/recognai/rubrix/issues/981)
* Introduce a 'text' argument for the TextClassificationRecord ([1246](https://github.com/recognai/rubrix/issues/1246)) ([bb7d93e](https://github.com/recognai/rubrix/commit/bb7d93eadfa04de5e85889beacac4bca7eb77b75))


Bug Fixes
* **1347:** allow tooltip record overlapping in Token Classifier ([1352](https://github.com/recognai/rubrix/issues/1352)) ([87174d3](https://github.com/recognai/rubrix/commit/87174d34b36b48ff9cac275607430a72252fd43c)), closes [#1347](https://github.com/recognai/rubrix/issues/1347)
* **1103:** remove "Error Distribution" from metrics ([1255](https://github.com/recognai/rubrix/issues/1255)) ([b9bb5b4](https://github.com/recognai/rubrix/commit/b9bb5b4309f81dedad57e88a594c46fff2115d9b)), closes [#1103](https://github.com/recognai/rubrix/issues/1103)
* **1149:** fix vulnerable dependencies (node-sass) ([1263](https://github.com/recognai/rubrix/issues/1263)) ([7f8c1d1](https://github.com/recognai/rubrix/commit/7f8c1d18854cc19d9c1924deab22751d004cc20d)), closes [#1149](https://github.com/recognai/rubrix/issues/1149)
* **1211:** fix score scale ([1261](https://github.com/recognai/rubrix/issues/1261)) ([8a72281](https://github.com/recognai/rubrix/commit/8a722815195dd056aabf7053512042ff78a37805)), closes [#1211](https://github.com/recognai/rubrix/issues/1211)
* **1238:** show prediction labels when annotating rule ([1239](https://github.com/recognai/rubrix/issues/1239)) ([0321b88](https://github.com/recognai/rubrix/commit/0321b88b6724436a65e9c4c27871651ad1b804d0)), closes [#1238](https://github.com/recognai/rubrix/issues/1238)
* **1241, 1245:** show new line char in metrics plot & increase mentions in entity consistency ([1257](https://github.com/recognai/rubrix/issues/1257)) ([38930cb](https://github.com/recognai/rubrix/commit/38930cb99eeef0542c6b166034fd83869243e3a0)), closes [#1241](https://github.com/recognai/rubrix/issues/1241) [#1245](https://github.com/recognai/rubrix/issues/1245)
* **1311:** small defects about hover style ([1313](https://github.com/recognai/rubrix/issues/1313)) ([442703c](https://github.com/recognai/rubrix/commit/442703cbf3d708be85dffd2f0fe192d5836b8611)), closes [#1311](https://github.com/recognai/rubrix/issues/1311)
* **1320:** render car return in Token Classifier ([1328](https://github.com/recognai/rubrix/issues/1328)) ([b7f1b7b](https://github.com/recognai/rubrix/commit/b7f1b7bf1a5be2aafc6eb3f8a14e386e374a25d5)), closes [#1320](https://github.com/recognai/rubrix/issues/1320)
* **1335:** force line break in rules summary ([1336](https://github.com/recognai/rubrix/issues/1336)) ([2d77a76](https://github.com/recognai/rubrix/commit/2d77a76c9e33729eafd927dc9633c80751a1c4bc)), closes [#1335](https://github.com/recognai/rubrix/issues/1335)
* **1337:** number of records in the overall annotated coverage ([1338](https://github.com/recognai/rubrix/issues/1338)) ([d384713](https://github.com/recognai/rubrix/commit/d384713fb3f2bd0f525b079ce591f614b9e24790)), closes [#1337](https://github.com/recognai/rubrix/issues/1337)
* **1339:** metrics and status not updated when the query is refreshed ([1340](https://github.com/recognai/rubrix/issues/1340)) ([6fc0a58](https://github.com/recognai/rubrix/commit/6fc0a586497a1a8e8f167486d21b735b72b94943)), closes [#1339](https://github.com/recognai/rubrix/issues/1339)
* **984:** manage super user workspaces ([1268](https://github.com/recognai/rubrix/issues/1268)) ([9b24921](https://github.com/recognai/rubrix/commit/9b24921e094f138e488df1c07d1e6dcc06d4744a)), closes [#984](https://github.com/recognai/rubrix/issues/984) [#1288](https://github.com/recognai/rubrix/issues/1288) [#1290](https://github.com/recognai/rubrix/issues/1290)
* **datasets:** prevent error when no annotated records found in dataset ([1284](https://github.com/recognai/rubrix/issues/1284)) ([c20028f](https://github.com/recognai/rubrix/commit/c20028f746fa1f679a135744f5d5c81e60332869))
* **install:** make starlette an optional dependency ([1295](https://github.com/recognai/rubrix/issues/1295)) ([32afb3d](https://github.com/recognai/rubrix/commit/32afb3db3d5ef639d0457ea41185c7b9d432a071))
* **NER:** create record annotation from tags (also in from_datasets) ([1283](https://github.com/recognai/rubrix/issues/1283)) ([adcf1b1](https://github.com/recognai/rubrix/commit/adcf1b14306c226806187de9506a5d7cc276b072))
* **rules:** store single-label rules with a comp. format for old versions ([1334](https://github.com/recognai/rubrix/issues/1334)) ([eb310d3](https://github.com/recognai/rubrix/commit/eb310d3495a8264974d00e1ca97820cdf06ed701))

[0.12.1](https://github.com/recognai/rubrix/compare/v0.12.0...v0.12.1) (2022-03-11)


Bug Fixes
* **1238:** show prediction labels when annotating rule ([1239](https://github.com/recognai/rubrix/issues/1239)) ([6c1b975](https://github.com/recognai/rubrix/commit/6c1b97512eb9bbc8ed5d686761707d2e6e1feb0d)), closes [#1238](https://github.com/recognai/rubrix/issues/1238)

[0.12.0](https://github.com/recognai/rubrix/compare/v0.11.0...v0.12.0) (2022-03-08)


Features

* **1029:** improve server api logging ([1148](https://github.com/recognai/rubrix/issues/1148)) ([d4a121a](https://github.com/recognai/rubrix/commit/d4a121a772b8b7bd0e2fe5475108c124ecefd9a4)), closes [#1029](https://github.com/recognai/rubrix/issues/1029) [#1224](https://github.com/recognai/rubrix/issues/1224)
* **1183:** token classification fine-tuning ([1199](https://github.com/recognai/rubrix/issues/1199)) ([2cdd30b](https://github.com/recognai/rubrix/commit/2cdd30b6626f0af0787fbfd77ebcfe632eab4890)), closes [#1183](https://github.com/recognai/rubrix/issues/1183)
* **1192:** disable ssl verify for elasticsearch http client ([1193](https://github.com/recognai/rubrix/issues/1193)) ([631a729](https://github.com/recognai/rubrix/commit/631a729d067cc93fb7e92f02dd292ff21a1d979d)), closes [#1192](https://github.com/recognai/rubrix/issues/1192)
* **950:** include search keywords as part of record results ([1201](https://github.com/recognai/rubrix/issues/1201)) ([2dd5853](https://github.com/recognai/rubrix/commit/2dd5853152ff5051e16acc7f714eb4dc1552beb0)), closes [#950](https://github.com/recognai/rubrix/issues/950)
* **970:** header redesign ([1185](https://github.com/recognai/rubrix/issues/1185)) ([fa9c639](https://github.com/recognai/rubrix/commit/fa9c639f8a6b975bdd735ffc90932f956e16116e)), closes [#970](https://github.com/recognai/rubrix/issues/970) [#1218](https://github.com/recognai/rubrix/issues/1218) [#1214](https://github.com/recognai/rubrix/issues/1214) [#1223](https://github.com/recognai/rubrix/issues/1223)
* Implement 'prepare_for_training' for text classification datasets ([1209](https://github.com/recognai/rubrix/issues/1209)) ([f7fd59c](https://github.com/recognai/rubrix/commit/f7fd59c5493bfd1013237b242da7ad3d81c8741d))


Bug Fixes

* **1207:** using api sdk wrapper for init ([1208](https://github.com/recognai/rubrix/issues/1208)) ([2495c75](https://github.com/recognai/rubrix/commit/2495c75161572cd85152975048d5e70a0eff5be0)), closes [#1207](https://github.com/recognai/rubrix/issues/1207)

[0.11.1](https://github.com/recognai/rubrix/compare/v0.11.0...v0.11.1) (2022-03-11)


Bug Fixes

* **1238:** show prediction labels when annotating rule ([1239](https://github.com/recognai/rubrix/issues/1239)) ([28e97c6](https://github.com/recognai/rubrix/commit/28e97c6f0599c0487b2c03ee8334fea430d572df)), closes [#1238](https://github.com/recognai/rubrix/issues/1238)

[0.11.0](https://github.com/recognai/rubrix/compare/v0.10.0...v0.11.0) (2022-02-19)

Highlights

Introducing `rb.Dataset*` and 🤗 Hub integration

The Dataset classes are lightweight containers for Rubrix records. These classes facilitate importing from and exporting to different formats (e.g., `pandas.DataFrame`, `datasets.Dataset`) as well as sharing and versioning Rubrix datasets using the Hugging Face Hub.

With this release, Rubrix users and teams can use the Hugging Face Hub to share and read both public and private Rubrix datasets for TextClassification, TokenClassification, and Text2Text datasets. This opens up a whole new world of possibilities for data reproducibility and sharing. Let's see an example:

python
import rubrix as rb
from datasets import load_datasets

👧🏻 🏷️ Leire has labeled a text classification dataset using a local Rubrix instance
dataset_rb = rb.load("text_classification_ds", as_pandas=False)

👧🏻 exports a Rubrix Dataset to a hf Dataset
dataset_ds = dataset_rb.to_datasets()

👧🏻 🚀 Leire shares the labelled dataset with the world
dataset_ds.push_to_hub("text_classification_ds")

👨 John downloads the dataset from the Hugging Face Hub
dataset_ds = load_dataset("leire/text_classification_ds", split="train")

👨 reads in dataset
dataset_rb = rb.read_datasets(dataset_ds, task="TextClassification")

👨 🏷️ logs the dataset and continues labeling with his own Rubrix instance
rb.log(dataset_rb, "john_text_classification_ds")


You can read more at https://rubrix.readthedocs.io/en/stable/guides/datasets.html

For each record type, there’s a corresponding Dataset class called `DatasetFor<RecordType>`. You can look up their API in the [reference section](https://rubrix.readthedocs.io/en/stable/reference/python/python_client.html#module-rubrix.client.datasets).

Improving NER UI and UX
The UI for Token Classification has been completely redesigned to provide a better user experience for exploration and annotation. This is the first of a set of changes focusing on annotation productivity for token classification.

<img width="1564" alt="Screenshot 2022-02-21 at 12 39 22" src="https://user-images.githubusercontent.com/1107111/154948266-e458f604-1a8b-4e18-8f70-48f5f1c6b7b4.png">


Features

* **1051:** keep predictions labels when annotating ([1077](https://github.com/recognai/rubrix/issues/1077)) ([f1824ba](https://github.com/recognai/rubrix/commit/f1824ba2c759d6eb310de10c3791dde740e68118)), closes [#1051](https://github.com/recognai/rubrix/issues/1051)
* **1063:** Token Classifier fine tuning content selection ([1084](https://github.com/recognai/rubrix/issues/1084)) ([9e14d05](https://github.com/recognai/rubrix/commit/9e14d0566f033e1e12fba4f1f2fc1d194ee108f8)), closes [#1063](https://github.com/recognai/rubrix/issues/1063)
* **1127:** raise startup app error from es connection error ([1145](https://github.com/recognai/rubrix/issues/1145)) ([7e7e9d8](https://github.com/recognai/rubrix/commit/7e7e9d83ec73708d0f6bf13efd2933e0fb7ecdf7)), closes [#1127](https://github.com/recognai/rubrix/issues/1127)
* **422:** introducing the rb.Dataset* classes ([1109](https://github.com/recognai/rubrix/issues/1109)) ([b5bbca6](https://github.com/recognai/rubrix/commit/b5bbca62f9d8a833088c009ff1539d2843b30859)), closes [#422](https://github.com/recognai/rubrix/issues/422)
* **821:** token classifier show predictions in explore view ([1009](https://github.com/recognai/rubrix/issues/1009)) ([6ba6764](https://github.com/recognai/rubrix/commit/6ba6764c8ceef09037f6c76bc01f84f4660e9b36)), closes [#821](https://github.com/recognai/rubrix/issues/821)
* **951:** new *"not covered records by rules"* filter ([991](https://github.com/recognai/rubrix/issues/991)) ([0649f2a](https://github.com/recognai/rubrix/commit/0649f2ab30430e0f2486e2e4fd0f0c2096bd94cc)), closes [#951](https://github.com/recognai/rubrix/issues/951) [#1156](https://github.com/recognai/rubrix/issues/1156)


Bug Fixes

* **1140:** fix/make client models more consistent ([1147](https://github.com/recognai/rubrix/issues/1147)) ([926bb16](https://github.com/recognai/rubrix/commit/926bb1605c14cf4afbe6431f5914303b0cb01328)), closes [#1140](https://github.com/recognai/rubrix/issues/1140)
* **client:** parse unauthorized api error properly ([1164](https://github.com/recognai/rubrix/issues/1164)) ([1a5a08d](https://github.com/recognai/rubrix/commit/1a5a08d8cce98efa6c9d5ea2fc7ccc4b71494684))
* **search:** prevent metrics computation breaks searches ([1175](https://github.com/recognai/rubrix/issues/1175)) ([9f2adc9](https://github.com/recognai/rubrix/commit/9f2adc97d9958798be52cce5c2dd3e6af264a221))