Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

✨ FEAT : Ranking component #3177

Merged
merged 63 commits into from
Jun 28, 2023
Merged

Conversation

keithCuniah
Copy link
Contributor

@keithCuniah keithCuniah commented Jun 14, 2023

Description

Ranking component

Closes #3176

Type of change

  • Only feeback task

How Has This Been Tested

  • Only feedback task

@keithCuniah keithCuniah added the area: ui Indicates that an issue or pull request is related to the User Interface (UI) label Jun 14, 2023
leiyre and others added 17 commits June 27, 2023 08:01
# Description

- [x]  Multiple-line quotes appear as a single-line quote.
- [x]  Some browsers show scroll lines surrounding code snippets
- [x]  In the TextQuestion, division lines ---- aren't displayed.
- [x]  Division lines don't follow the expected behavior.
- [x] Html tags are removed upon pasting in the `TextQuestion` area.

Closes #3198

**Type of change**

- [x] Bug fix

**Checklist**

- [x] I have merged the original branch into my forked branch
- [ ] I added relevant documentation
- [x] follows the style guidelines of this project
- [x] I did a self-review of my code
- [ ] I made corresponding changes to the documentation
- [x] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [ ] I have added relevant notes to the CHANGELOG.md file (See
https://keepachangelog.com/)
# Description

This PR contains the following linked PRs to update the documentation
before releasing Argilla 1.11.0:
* #3236 
* #3237 

**Type of change**

- [X] Documentation update

---------

Co-authored-by: frascuchon <francis@argilla.io>
Co-authored-by: David Berenstein <david.m.berenstein@gmail.com>
Co-authored-by: Natalia Elvira <126158523+nataliaElv@users.noreply.github.com>
# Description

Corrected a paragraph from the Dolly tutorial.

**Type of change**

- [x] Documentation update
<!-- Thanks for your contribution! As part of our Community Growers
initiative 🌱, we're donating Justdiggit bunds in your name to reforest
sub-Saharan Africa. To claim your Community Growers certificate, please
contact David Berenstein in our Slack community or fill in this form
https://tally.so/r/n9XrxK once your PR has been merged. -->

# Description

I worked ion this and resolved some typos

Closes #3238 

**Type of change**

(Please delete options that are not relevant. Remember to title the PR
according to the type of change)

- [X] Documentation update

**How Has This Been Tested**

(Please describe the tests that you ran to verify your changes. And
ideally, reference `tests`)

N.A.

**Checklist**

- [X] I have added relevant notes to the CHANGELOG.md file (See
https://keepachangelog.com/)
# Description

I've updated the quickstart image to create the `/data` directory which
will be used to store Argilla Server data and Elasticsearch data.

This change is mainly needed so the quickstart is compatible with the
new HF Spaces feature, persistent storage. HF Spaces persistent storage
mounts a volume in the `/data` directory of the container, so
`ARGILLA_HOME_PATH` should be set to `/data/argilla` (or other directory
but within `/data`). Additionally, we need to also change the
`path.data` config parameter of Elasticsearch to `/data/elasticsearch`,
so elastic data is also persisted.

If the HF persistent storage is not used (volume is not mounted), then
the `/data` directory won't exist and the Linux user used in the
quickstart Docker image (`elasticsearch`) won't have the rights needed
to create it. To avoid this from happening, we also create the `/data`
directory in the Dockerimage and we give permissions to the
`elasticsearch` user to manage this directory.

I've also moved the `ENV` in the top of the Dockerfile to the bottom.
This is to take advantage of the Dockerimage layering system, so if we
change one of these `ENV`s the cached layers are not invalidated and we
don't have to reinstall everything again.

**Type of change**

- [x] New feature (non-breaking change which adds functionality)
- [x] Refactor (change restructuring the codebase without changing
functionality)

**How Has This Been Tested**

Running the new `quickstart` image locally.

**Checklist**

- [ ] I added relevant documentation
- [x] follows the style guidelines of this project
- [x] I did a self-review of my code
- [ ] I made corresponding changes to the documentation
- [x] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [ ] I filled out [the contributor form](https://tally.so/r/n9XrxK)
(see text above)
- [ ] I have added relevant notes to the CHANGELOG.md file (See
https://keepachangelog.com/)
# Description

This PR creates the default user with `owner` role instead of `admin` in
`release.Dockerfile`, so that the default user has all the required
permissions matching the ones that the `admin` user had before, to avoid
disruption. Also this PR creates an `owner` user besides the current
`admin` and `annotator` users being created as part of the
`quickstart.Dockerfile`.

Reverts the PR at #3188

**Type of change**

- [X] Refactor (change restructuring the codebase without changing
functionality)

**How Has This Been Tested**

- [X] `docker build` both `quickstart.Dockerfile` and
`release.Dockerfile`

**Checklist**

- [X] I added relevant documentation
- [X] follows the style guidelines of this project
- [X] I did a self-review of my code
- [X] I made corresponding changes to the documentation
- [X] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [ ] I filled out [the contributor form](https://tally.so/r/n9XrxK)
(see text above)
- [X] I have added relevant notes to the CHANGELOG.md file (See
https://keepachangelog.com/)

---------

Co-authored-by: Francisco Aranda <francis@argilla.io>
# Description

This PR adds the required classes to create a Ranking Question and to
validate their responses in the API. Additionally, I've refactor the
`LabelSelectionQuestionSettingsOption` class to be named as
`ValueTextQuestionSettingsOption`, as this same class can be used in the
Ranking Question.

Closes #3230

**Type of change**

- [x] New feature (non-breaking change which adds functionality)
- [x] Refactor

**How Has This Been Tested**

Unit tests have been added covering the creation of the Ranking Question
as well as the validation of the submitted responses for this kind of
question.

**Checklist**

- [x] I have merged the original branch into my forked branch
- [ ] I added relevant documentation
- [x] follows the style guidelines of this project
- [x] I did a self-review of my code
- [ ] I made corresponding changes to the documentation
- [x] My changes generate no new warnings
- [x] I have added tests that prove my fix is effective or that my
feature works
- [x] I have added relevant notes to the CHANGELOG.md file (See
https://keepachangelog.com/)

---------

Co-authored-by: Francisco Aranda <francis@argilla.io>
…2819 (#3255)

<!-- Thanks for your contribution! As part of our Community Growers
initiative 🌱, we're donating Justdiggit bunds in your name to reforest
sub-Saharan Africa. To claim your Community Growers certificate, please
contact David Berenstein in our Slack community or fill in this form
https://tally.so/r/n9XrxK once your PR has been merged. -->

# Description

Please include a summary of the changes and the related issue. Please
also include relevant motivation and context. List any dependencies that
are required for this change.

I fixed the formatting of the libraries on the main tutorial page, so
that it previews all 21 different options. Additionally, there were two
references to OpenAI in the sidebar and on the libraries page, so I
fixed that as well.

Closes #2819

**Type of change**

(Please delete options that are not relevant. Remember to title the PR
according to the type of change)
- [X] Documentation update

**How Has This Been Tested**

(Please describe the tests that you ran to verify your changes. And
ideally, reference `tests`)

N.A.

**Checklist**

- [X] I have merged the original branch into my forked branch
- [X] I have added relevant notes to the CHANGELOG.md file (See
https://keepachangelog.com/)
<!-- Thanks for your contribution! As part of our Community Growers
initiative 🌱, we're donating Justdiggit bunds in your name to reforest
sub-Saharan Africa. To claim your Community Growers certificate, please
contact David Berenstein in our Slack community or fill in this form
https://tally.so/r/n9XrxK once your PR has been merged. -->

# Description

Please include a summary of the changes and the related issue. Please
also include relevant motivation and context. List any dependencies that
are required for this change.

I changed the mention of `master branch` to `main/develop branch`.
(Really minor, but I also just removed the hyphen in the warning for new
versions of `docker-compose`, as it said.
Closes #2324

**Type of change**

(Please delete options that are not relevant. Remember to title the PR
according to the type of change)

- [X] Documentation update

**How Has This Been Tested**

(Please describe the tests that you ran to verify your changes. And
ideally, reference `tests`)

N.A.

**Checklist**
- [X] I have added relevant notes to the CHANGELOG.md file (See
https://keepachangelog.com/)
<!-- Thanks for your contribution! As part of our Community Growers
initiative 🌱, we're donating Justdiggit bunds in your name to reforest
sub-Saharan Africa. To claim your Community Growers certificate, please
contact David Berenstein in our Slack community or fill in this form
https://tally.so/r/n9XrxK once your PR has been merged. -->

# Description

Please include a summary of the changes and the related issue. Please
also include relevant motivation and context. List any dependencies that
are required for this change.
I fixed the hyperlinked URLs in the tutorial, so users would be referred
to the right pages for other relevant tutorials.

Closes #3241 

**Type of change**

(Please delete options that are not relevant. Remember to title the PR
according to the type of change)
- [X] Documentation update

**How Has This Been Tested**

(Please describe the tests that you ran to verify your changes. And
ideally, reference `tests`)

N.A.

**Checklist**

- [X] I have merged the original branch into my forked branch
- [X] I have added relevant notes to the CHANGELOG.md file (See
https://keepachangelog.com/)

---------

Co-authored-by: David Berenstein <david.m.berenstein@gmail.com>
@codecov
Copy link

codecov bot commented Jun 27, 2023

Codecov Report

Patch coverage: 92.16% and project coverage change: -0.65 ⚠️

Comparison is base (51751ac) 90.91% compared to head (ea039af) 90.26%.

❗ Current head ea039af differs from pull request most recent head 26fc63c. Consider uploading reports for the commit 26fc63c to get more accurate results

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #3177      +/-   ##
===========================================
- Coverage    90.91%   90.26%   -0.65%     
===========================================
  Files          215      231      +16     
  Lines        11304    13159    +1855     
===========================================
+ Hits         10277    11878    +1601     
- Misses        1027     1281     +254     
Flag Coverage Δ
pytest 90.26% <92.16%> (-0.65%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
src/argilla/__init__.py 88.23% <ø> (+4.90%) ⬆️
src/argilla/client/datasets.py 95.50% <ø> (+1.65%) ⬆️
src/argilla/server/contexts/datasets.py 96.01% <ø> (ø)
src/argilla/server/seeds.py 0.00% <ø> (ø)
src/argilla/tasks/users/create.py 91.11% <ø> (-4.45%) ⬇️
src/argilla/server/search_engine.py 90.83% <60.00%> (-1.29%) ⬇️
src/argilla/client/apis/datasets.py 92.48% <75.00%> (+2.11%) ⬆️
src/argilla/client/feedback/utils.py 78.94% <78.57%> (+7.51%) ⬆️
src/argilla/client/users.py 84.40% <84.40%> (ø)
src/argilla/client/feedback/dataset.py 85.96% <84.78%> (+3.43%) ⬆️
... and 37 more

... and 19 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@damianpumar damianpumar requested a review from leiyre June 27, 2023 08:01
@damianpumar damianpumar marked this pull request as ready for review June 27, 2023 08:57
@frascuchon frascuchon merged commit 56486d6 into develop Jun 28, 2023
@frascuchon frascuchon deleted the feat/3176-front-ranking-component branch June 28, 2023 15:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: ui Indicates that an issue or pull request is related to the User Interface (UI)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

📈 Front ranking component
10 participants