Argilla

[1.3.2](https://github.com/recognai/rubrix/compare/v1.3.1...v1.3.2)

Bug Fixes

- Copying datasets between workspaces with proper owner/workspace info. Closes [2562](https://github.com/argilla-io/argilla/issues/2562)
- Copy dataset with empty workspace to the default user workspace [905d4de](https://github.com/recognai/argilla/commit/905d4deaa769bfc9bbc022cd2dc75c7435cfe865)
- Using elasticsearch config to request backend version. Closes [2311](https://github.com/argilla-io/argilla/issues/2311)

[1.3.1](https://github.com/recognai/rubrix/compare/v1.3.0...v1.3.1) (2023-02-24)


Bug Fixes

* **quickstart:** change default api key for the argilla quickstart image ([2357](https://github.com/recognai/rubrix/issues/2357)) ([bb14f3c](https://github.com/recognai/rubrix/commit/bb14f3c90502a1ffbde0c64b070f73717041e15b))

* Resolve errors found in `prepare_for_training` during `autotrain` integration (https://github.com/argilla-io/argilla/pull/2411)
Closes https://github.com/argilla-io/argilla/issues/2406
Closes https://github.com/argilla-io/argilla/issues/2407
Closes https://github.com/argilla-io/argilla/issues/2408
Closes https://github.com/argilla-io/argilla/issues/2405


Documentation

* Add section from empty workspaces migration ([2382](https://github.com/recognai/rubrix/issues/2382)) ([d0f8882](https://github.com/recognai/rubrix/commit/d0f88827f62667b90d4e25d2b9d18486ba5606f0)), Refs [#2373](https://github.com/recognai/rubrix/issues/2373)

🔆 Highlights

Keyword metric from Python client
Most important keywords in the dataset or a subset (using the query param) can be retrieved from Python. This can be useful for EDA and defining programmatic labeling rules:

python
from argilla.metrics.commons import keywords
summary = keywords(name="example-dataset")
summary.visualize() will plot an histogram with results
summary.data returns the raw result data


Prepare for training for SparkNLP and spaCy text-cat
Added a new framework `sparknlp` and extended the support for `spacy` including text classification datasets. Check out this [section of the docs](https://docs.argilla.io/en/latest/guides/log_load_and_prepare_data.html#Prepare-dataset-for-training)

Create train and test split with prepare_for_training
You can pass `train_size` and `test_size` to `prepare_for_training` to get train-test splits. This is especially useful for spaCy. Check out this [section of the docs](https://docs.argilla.io/en/latest/guides/log_load_and_prepare_data.html#Train-test-split)

Better repr for Dataset and Rule (kudos Ankush-Chander)
When using the Python client now you get a human-readable visualization of `Dataset` and `Rule` entities

Changelog

All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.

[1.3.0](https://github.com/recognai/rubrix/compare/v1.2.1...v1.3.0) (2023-02-09)


Features

* better log error handling ([2245](https://github.com/recognai/rubrix/issues/2245)) ([66e5cce](https://github.com/recognai/rubrix/commit/66e5cce273051d93486507babc788dfd7c362db8)), closes [#2005](https://github.com/recognai/rubrix/issues/2005)
* Change view mode order in sidebar ([2215](https://github.com/recognai/rubrix/issues/2215)) ([dff1ea1](https://github.com/recognai/rubrix/commit/dff1ea1c1b3c27899eb1fd7f15eddc18b3797513)), closes [#2214](https://github.com/recognai/rubrix/issues/2214)
* **Client:** Expose keywords dataset metrics ([2290](https://github.com/recognai/rubrix/issues/2290)) ([a945c5e](https://github.com/recognai/rubrix/commit/a945c5e9d5a3eb12e21e9dc6ef240f2ad14e20d2)), closes [#2135](https://github.com/recognai/rubrix/issues/2135)
* **Client:** relax client constraints for rules management ([2242](https://github.com/recognai/rubrix/issues/2242)) ([6e749b7](https://github.com/recognai/rubrix/commit/6e749b78cdc817d131fc269ea68312af5afc534f)), closes [#2048](https://github.com/recognai/rubrix/issues/2048)
* Create a multiple contextual help component ([2255](https://github.com/recognai/rubrix/issues/2255)) ([a35fae2](https://github.com/recognai/rubrix/commit/a35fae23dd5c8517ef1cb5e5619248325997c606)), closes [#1926](https://github.com/recognai/rubrix/issues/1926)
* Include record event_timestamp ([2156](https://github.com/recognai/rubrix/issues/2156)) ([3992b8f](https://github.com/recognai/rubrix/commit/3992b8fa0b9e82c6d9110f3b217ecdbcf1f9ceab)), closes [#1911](https://github.com/recognai/rubrix/issues/1911)
* updated the `prepare_for_training` methods ([2225](https://github.com/recognai/rubrix/issues/2225)) ([e53c201](https://github.com/recognai/rubrix/commit/e53c2018c6ae781f35845e07c8806ca68acea7fc)), closes [#2154](https://github.com/recognai/rubrix/issues/2154) [#2132](https://github.com/recognai/rubrix/issues/2132) [#2122](https://github.com/recognai/rubrix/issues/2122) [#2045](https://github.com/recognai/rubrix/issues/2045) [#1697](https://github.com/recognai/rubrix/issues/1697)


Bug Fixes

* **Client:** formatting caused offset in prediction ([2241](https://github.com/recognai/rubrix/issues/2241)) ([d65db5a](https://github.com/recognai/rubrix/commit/d65db5afbf430d7153a0aa5701f56ecf284881e3))
* **Client:** Log remaining data when shutdown the dataset consumer ([2269](https://github.com/recognai/rubrix/issues/2269)) ([d78963e](https://github.com/recognai/rubrix/commit/d78963e12d8051f36ee22abd941f85ca090d428f)), closes [#2189](https://github.com/recognai/rubrix/issues/2189)
* validate predictions fails on text2text ([2271](https://github.com/recognai/rubrix/issues/2271)) ([f68856e](https://github.com/recognai/rubrix/commit/f68856e2db50a9e84a53dd818f493e8ab605176c)), closes [#2252](https://github.com/recognai/rubrix/issues/2252)


Visual enhancements

* Fine tune menu record card ([2240](https://github.com/recognai/rubrix/issues/2240)) ([62148e5](https://github.com/recognai/rubrix/commit/62148e5282958f5121ec0aaef5b30baaff6af7ce)), closes [#2224](https://github.com/recognai/rubrix/issues/2224)
* Rely on box-shadow to provide the secondary underline ([2283](https://github.com/recognai/rubrix/issues/2283)) ([d786171](https://github.com/recognai/rubrix/commit/d786171e94b54c6c534ed62eb9e653e9101ac0c1)), closes [#2282](https://github.com/recognai/rubrix/issues/2282) [#2282](https://github.com/recognai/rubrix/issues/2282)


Documentation

* Add deploy on Spaces buttons ([2293](https://github.com/recognai/rubrix/issues/2293)) ([60164a0](https://github.com/recognai/rubrix/commit/60164a077b0f6bc43ada3ac1bea68412b0a82821))
* fix typo in documentation ([2296](https://github.com/recognai/rubrix/issues/2296)) ([ab8e85e](https://github.com/recognai/rubrix/commit/ab8e85eeaa23878fc1a0f524790c5aa65202b580))
* Improve deployment and quickstart docs and tutorials ([2201](https://github.com/recognai/rubrix/issues/2201)) ([075bf94](https://github.com/recognai/rubrix/commit/075bf94bdc114cf634edaf0412862ed886d354a5)), closes [#2162](https://github.com/recognai/rubrix/issues/2162)
* More spaces! ([2309](https://github.com/recognai/rubrix/issues/2309)) ([f02eb60](https://github.com/recognai/rubrix/commit/f02eb602ea23b0044ddc42c4417536e003b43b0d))
* Remove cut-off sentence in docs codeblock ([2287](https://github.com/recognai/rubrix/issues/2287)) ([7e87f20](https://github.com/recognai/rubrix/commit/7e87f207e76709a160fcd1fbbfa0ce9e3b218386))
* Rephrase `to know more` into `to learn more` in Quickstart login page ([2305](https://github.com/recognai/rubrix/issues/2305)) ([6082a26](https://github.com/recognai/rubrix/commit/6082a264f1ce0a95b09f84119d98f8b6e71b4521))
* Replace leftover `rubrix.apikey` with `argilla.apikey` ([2286](https://github.com/recognai/rubrix/issues/2286)) ([4871127](https://github.com/recognai/rubrix/commit/487112795c0e26aeb4fce905e2bd03e5f275d6aa)), closes [#2254](https://github.com/recognai/rubrix/issues/2254) [#2254](https://github.com/recognai/rubrix/issues/2254)
* Simplify token attributions code block ([2322](https://github.com/recognai/rubrix/issues/2322)) ([4cb6ae1](https://github.com/recognai/rubrix/commit/4cb6ae142bb879481a1a20f1a95c58b8dcb40fa4))
* Tutorial buttons ([2310](https://github.com/recognai/rubrix/issues/2310)) ([d6e02de](https://github.com/recognai/rubrix/commit/d6e02de4056518177c82f698c202b69af94675c1))
* Update colab guide ([2320](https://github.com/recognai/rubrix/issues/2320)) ([e48a7cc](https://github.com/recognai/rubrix/commit/e48a7cce5d91db959bef450bb170db0e9373be7c))
* Update HF Spaces creation image ([2314](https://github.com/recognai/rubrix/issues/2314)) ([e4b2a04](https://github.com/recognai/rubrix/commit/e4b2a0414dfbf404c96172da3092c9401d61c576))


As always, thanks to our amazing contributors!


- add repr method for Rule, Dataset. (2148) by Ankush-Chander
- opensearch docker compose file doesn't run (2228) by kayvane1
- Docs: fix typo in documentation (2296) by anakin87

[1.2.2](https://github.com/recognai/rubrix/compare/v1.2.1...v1.2.2)

Bug Fixes

- Copying datasets between workspaces with proper owner/workspace info. Closes [2562](https://github.com/argilla-io/argilla/issues/2562)
- Copy dataset with empty workspace to the default user workspace [905d4de](https://github.com/recognai/argilla/commit/905d4deaa769bfc9bbc022cd2dc75c7435cfe865)
- Using elasticsearch config to request backend version. Closes [2311](https://github.com/argilla-io/argilla/issues/2311)

[1.2.1](https://github.com/recognai/rubrix/compare/v1.2.0...v1.2.1) (2023-01-23)


Bug Fixes

* Allow non-alphanumeric characters for login ([2207](https://github.com/recognai/rubrix/issues/2207)) ([629499a](https://github.com/recognai/rubrix/commit/629499a9a4d9190a0033b553be3ae8b698f7caab)), closes [#1879](https://github.com/recognai/rubrix/issues/1879)
* **Client:** Stop using `ujson` for client actions ([2211](https://github.com/recognai/rubrix/issues/2211)) ([920213e](https://github.com/recognai/rubrix/commit/920213e44c98abe813350818b5bc970739280e28))
* doc typos ([2203](https://github.com/recognai/rubrix/issues/2203)) ([b353a30](https://github.com/recognai/rubrix/commit/b353a30c8814e951775a1a547e0fcb8043ad83ff))
* Read statics with proper encoding ([2234](https://github.com/recognai/rubrix/issues/2234)) ([92739bf](https://github.com/recognai/rubrix/commit/92739bf38c6fd3c912f9460fe322d463f2e03300)), closes [#2219](https://github.com/recognai/rubrix/issues/2219)
* Remove 3.9+ string methods ([2230](https://github.com/recognai/rubrix/issues/2230)) ([4ed1ff0](https://github.com/recognai/rubrix/commit/4ed1ff00f4d19c1f5a656b1e77a6efa5ec4b343e)), closes [#2192](https://github.com/recognai/rubrix/issues/2192)
* Remove argilla:stats in metadata filter ([2218](https://github.com/recognai/rubrix/issues/2218)) ([a412b22](https://github.com/recognai/rubrix/commit/a412b22488a0595ddac113c9caa10eb99979d071)), closes [#2217](https://github.com/recognai/rubrix/issues/2217), [#2220](https://github.com/argilla-io/argilla/issues/2220)

[1.2.0](https://github.com/recognai/rubrix/compare/v1.1.1...v1.2.0) (2023-01-12)

🔆 Highlights


Data labelling and curation with similarity search

Since 1.2.0 Argilla supports adding vectors to Argilla records which can then be used for finding the most similar records to a given one. This feature uses vector or semantic search combined with more traditional search (keyword and filter based).

<img width="1792" alt="4" src="https://user-images.githubusercontent.com/1107111/212332160-426d1d91-17c9-4648-992f-861a3f1e4603.png">

View record info
You can now find all record details and fields which can be useful for bookmarking, copy/pasting, and making ES queries

<img width="1055" alt="Screenshot 2023-01-13 at 14 36 07" src="https://user-images.githubusercontent.com/1107111/212332688-c72a32b5-8bf9-4770-8ae5-8572345399a4.png">

View record timestamp

You can now see the timestamp associated with the record timestamp (event timestamp) which corresponds to the moment when the record was uploaded or a custom timestamp passed when logging the data (e.g., when the prediction was made when using it for monitoring)

Configure the base path of your Argilla UI (useful for proxies)

See: https://docs.argilla.io/en/latest/getting_started/installation/server_configuration.html#using-a-proxy

Features

* Allow to launch the argilla server in a different base_url ([2080](https://github.com/recognai/rubrix/issues/2080)) ([63d624d](https://github.com/recognai/rubrix/commit/63d624d061c3f0f48cc7f24d19b08b5697e7f63d)), closes [#1914](https://github.com/recognai/rubrix/issues/1914) [#1899](https://github.com/recognai/rubrix/issues/1899)
* Check es connection on startup with retries ([2141](https://github.com/recognai/rubrix/issues/2141)) ([7a63bea](https://github.com/recognai/rubrix/commit/7a63bea91d38079746bedb5a9543cd06034ccbaf))
* enable partial record update ([2118](https://github.com/recognai/rubrix/issues/2118)) ([4ed0d95](https://github.com/recognai/rubrix/commit/4ed0d9536ed4fe491d6f8928d81afe65862da40c))
* Improve the `dataset_labels` metric processing ([1978](https://github.com/recognai/rubrix/issues/1978)) ([1c3235e](https://github.com/recognai/rubrix/commit/1c3235e29ca237fd3bc971aeec6b35c19bf169cb)), closes [#1818](https://github.com/recognai/rubrix/issues/1818)
* Include record event_timestamp ([2156](https://github.com/recognai/rubrix/issues/2156)) ([5b75ade](https://github.com/recognai/rubrix/commit/5b75ade80d8f7a3f1bf340f5b3bb62ef8d3214a4)), closes [#1911](https://github.com/recognai/rubrix/issues/1911)
* Include record info view and remove metadata filter ([2079](https://github.com/recognai/rubrix/issues/2079)) ([901d45a](https://github.com/recognai/rubrix/commit/901d45a7591d3a31e603b41b0de9939f393038ed)), closes [#1927](https://github.com/recognai/rubrix/issues/1927) [#1849](https://github.com/recognai/rubrix/issues/1849)
* Raw records scan endpoint ([2102](https://github.com/recognai/rubrix/issues/2102)) ([1b63d95](https://github.com/recognai/rubrix/commit/1b63d95523bc29faade911f920f728daafdd3858))
* reuse the same `httpx` async client instance ([1958](https://github.com/recognai/rubrix/issues/1958)) ([a70cb6c](https://github.com/recognai/rubrix/commit/a70cb6ce4be4750405b9b17932f685d4f4ef7eed)), closes [#1886](https://github.com/recognai/rubrix/issues/1886)
* **Search:** Allow passing raw es query in search query ([2098](https://github.com/recognai/rubrix/issues/2098)) ([0541798](https://github.com/recognai/rubrix/commit/05417987e9df1e36ca5607ed49337a99841cd10c))
* set record timestamp by default ([1970](https://github.com/recognai/rubrix/issues/1970)) ([309fd9f](https://github.com/recognai/rubrix/commit/309fd9fcd7b17a20872031c52301396975386a76)), closes [#1892](https://github.com/recognai/rubrix/issues/1892)
* Similarity vector search ([1768](https://github.com/recognai/rubrix/issues/1768)) ([#1998](https://github.com/recognai/rubrix/issues/1998)) ([32958f4](https://github.com/recognai/rubrix/commit/32958f4da0e668d5f21b5fa8b78900f19ae3ad49)), closes [#1757](https://github.com/recognai/rubrix/issues/1757)
* **UI:** remove mixins to hide scroll bar in drop down ([2000](https://github.com/recognai/rubrix/issues/2000)) ([95ad9b8](https://github.com/recognai/rubrix/commit/95ad9b845e429df96a9b9716ea1717d6d2f1c418)), closes [#1928](https://github.com/recognai/rubrix/issues/1928)


Bug Fixes

* [1912](https://github.com/recognai/rubrix/issues/1912) hide empty menu dropdown ([#1981](https://github.com/recognai/rubrix/issues/1981)) ([d90390b](https://github.com/recognai/rubrix/commit/d90390bb386523a68c563b11dbbed2ffdb064a0b))
* Avoid manipulating DOM ([1895](https://github.com/recognai/rubrix/issues/1895)) ([6939b28](https://github.com/recognai/rubrix/commit/6939b28fdea38fd617eb73eaeac4f2da3f3052ae)), closes [#1765](https://github.com/recognai/rubrix/issues/1765)
* catch ImportError for telemetry module ([1989](https://github.com/recognai/rubrix/issues/1989)) ([25513b7](https://github.com/recognai/rubrix/commit/25513b7cca07fc72f57de2babd2777c66010cf6a))
* **Client:** check url underscore only for hostnames ([2185](https://github.com/recognai/rubrix/issues/2185)) ([ec5726a](https://github.com/recognai/rubrix/commit/ec5726a4d8e6cbf1dcd3b858ae849486eef74397))
* **client:** prevent python client response json parse error ([2186](https://github.com/recognai/rubrix/issues/2186)) ([5549ab0](https://github.com/recognai/rubrix/commit/5549ab09418738f710f140a32e7f514dae0e3805))
* Compute predicted properly for token classification [REINDEX_DATASET_REF] ([1975](https://github.com/recognai/rubrix/issues/1975)) ([a29a198](https://github.com/recognai/rubrix/commit/a29a198c3aa5319cee260393fdc6a88f83eb08b7)), closes [#1955](https://github.com/recognai/rubrix/issues/1955)
* Disable shortcuts for pagination when focus is on an input tag ([1995](https://github.com/recognai/rubrix/issues/1995)) ([af07f3e](https://github.com/recognai/rubrix/commit/af07f3ee939eb1f33f1d9c0a017444eea0866635)), closes [#1976](https://github.com/recognai/rubrix/issues/1976)
* **Migration:** Set dynamic to false for old indices ([2167](https://github.com/recognai/rubrix/issues/2167)) ([15a18d7](https://github.com/recognai/rubrix/commit/15a18d7fd5cd7fd068966e5b946e06999ed5ca23))
* Prevent show "No result" before data is loaded ([2014](https://github.com/recognai/rubrix/issues/2014)) ([0799425](https://github.com/recognai/rubrix/commit/0799425781a4a9f829b6a0a07bebba857eafc6e2)), closes [#1936](https://github.com/recognai/rubrix/issues/1936)


Documentation

* Add new tutorial about zeroshot sentiment analysis with GPT-3 ([2011](https://github.com/recognai/rubrix/issues/2011)) ([d3c43ab](https://github.com/recognai/rubrix/commit/d3c43abe6460f6f1b02208bedf1bee1141d5a036))
* added additional explanation for datetime ranges ([2120](https://github.com/recognai/rubrix/issues/2120)) ([c8c3dc9](https://github.com/recognai/rubrix/commit/c8c3dc91c540bf7b16b4877926b047dc30ae0039)), closes [#2119](https://github.com/recognai/rubrix/issues/2119)
* Adds Hugging Face Space deployment guide ([2109](https://github.com/recognai/rubrix/issues/2109)) ([a7a47c4](https://github.com/recognai/rubrix/commit/a7a47c4d761bdd652911695928d55361579a22ac))
* changed DatasetForTextGeneration to DatasetForText2Text ([2090](https://github.com/recognai/rubrix/issues/2090)) ([8cde28b](https://github.com/recognai/rubrix/commit/8cde28b21f213bcc088c16d99898b9fc6e9a59fa)), closes [#2089](https://github.com/recognai/rubrix/issues/2089)
* Fix load docstring example ([2050](https://github.com/recognai/rubrix/issues/2050)) ([7e2af7f](https://github.com/recognai/rubrix/commit/7e2af7f0025b50c323454d28fe5991b5dbc2a2b4)), closes [#1951](https://github.com/recognai/rubrix/issues/1951)
* fixed typo errors for terminology section ([2025](https://github.com/recognai/rubrix/issues/2025)) ([1056736](https://github.com/recognai/rubrix/commit/10567365f2fa14a0f4f1f028631afd4444c8281e))
* include new OG image ([2017](https://github.com/recognai/rubrix/issues/2017)) ([710ab3f](https://github.com/recognai/rubrix/commit/710ab3f1b884eacca8fd9ad18e785ce04b8fc287))
* Include og image ([2016](https://github.com/recognai/rubrix/issues/2016)) ([85442e4](https://github.com/recognai/rubrix/commit/85442e438caf94297784f9970ee75e20e020987f))
* Maintain menu position during navigation ([1935](https://github.com/recognai/rubrix/issues/1935)) ([82c6e08](https://github.com/recognai/rubrix/commit/82c6e08e6b105effe9ae5db65fb15f949212ad13)), closes [#1864](https://github.com/recognai/rubrix/issues/1864)
* New setfit tutorial ([2002](https://github.com/recognai/rubrix/issues/2002)) ([43c66b2](https://github.com/recognai/rubrix/commit/43c66b2a99ee7ccad15ce2c633fc7c1ed2e46459))
* Replace OG image ([2018](https://github.com/recognai/rubrix/issues/2018)) ([894b273](https://github.com/recognai/rubrix/commit/894b2739faed722407fd95d07475d83777f8de1a))
* Replace video with image ([1990](https://github.com/recognai/rubrix/issues/1990)) ([359b637](https://github.com/recognai/rubrix/commit/359b637d6d27aaa3d61ee80ed4b96445aefe19f4))
* reverted to correct apikey reference ([2136](https://github.com/recognai/rubrix/issues/2136)) ([f32f2b8](https://github.com/recognai/rubrix/commit/f32f2b8e56680e117e85c6205e5aec9497747fea)), closes [#2074](https://github.com/recognai/rubrix/issues/2074)


As always, thanks to our amazing contributors!
- Add Azure deployment tutorial (2124) by burtenshaw
- Create training-textclassification-activelearning-with-GPU.ipynb (2020) by MoritzLaurer