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: add list classmethod to FeedbackDataset via ArgillaMixin #3619

Merged
merged 11 commits into from
Aug 23, 2023

Conversation

alvarobartt
Copy link
Member

@alvarobartt alvarobartt commented Aug 23, 2023

Description

This PR adds the class method list in ArgillaMixin, also renamed from ArgillaToFromMixin. This way, users can call FeedbackDataset.list() to list all the FeedbackDataset datasets in Argilla.

Additionally, list includes the arg workspace so that users can also specify the workspace that they want to list from, in case those are assigned to more than one workspace.

Closes #3413
Mentioned #3521 #3591

Type of change

  • New feature (non-breaking change which adds functionality)

How Has This Been Tested

  • Add integration tests for FeedbackDataset.list (producing a list of RemoteFeedbackDataset)

Checklist

  • I added relevant documentation
  • follows the style guidelines of this project
  • I did a self-review of my code
  • I made corresponding changes to the documentation
  • 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 (see text above)
  • I have added relevant notes to the CHANGELOG.md file (See https://keepachangelog.com/)

@alvarobartt alvarobartt added type: enhancement Indicates new feature requests client labels Aug 23, 2023
@alvarobartt alvarobartt added this to the v1.15.0 milestone Aug 23, 2023
@alvarobartt alvarobartt self-assigned this Aug 23, 2023
@alvarobartt alvarobartt changed the title Feat/list datasets feat: add list classmethod to FeedbackDataset via ArgillaMixin Aug 23, 2023
@codecov
Copy link

codecov bot commented Aug 23, 2023

Codecov Report

Patch coverage: 85.71% and project coverage change: -0.01% ⚠️

Comparison is base (4bbeb21) 90.59% compared to head (79a8144) 90.59%.
Report is 2 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #3619      +/-   ##
===========================================
- Coverage    90.59%   90.59%   -0.01%     
===========================================
  Files          260      260              
  Lines        13700    13711      +11     
===========================================
+ Hits         12412    12421       +9     
- Misses        1288     1290       +2     
Files Changed Coverage Δ
src/argilla/client/feedback/dataset/mixins.py 79.85% <83.33%> (+0.16%) ⬆️
src/argilla/client/feedback/dataset/local.py 91.66% <100.00%> (ø)

... and 1 file with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@github-actions
Copy link

The URL of the deployed environment for this PR is https://argilla-quickstart-pr-3619-ki24f765kq-no.a.run.app

Copy link
Member

@gabrielmbmb gabrielmbmb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! I think that we can filter the datasets in the client until we add the filter in the API, wdyt?

src/argilla/client/feedback/dataset/mixins.py Outdated Show resolved Hide resolved
src/argilla/client/feedback/dataset/mixins.py Outdated Show resolved Hide resolved
src/argilla/client/feedback/dataset/mixins.py Outdated Show resolved Hide resolved
src/argilla/client/feedback/dataset/mixins.py Show resolved Hide resolved
@alvarobartt alvarobartt merged commit 288df9e into develop Aug 23, 2023
17 of 18 checks passed
@alvarobartt alvarobartt deleted the feat/list-datasets branch August 23, 2023 13:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: enhancement Indicates new feature requests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add delete and list methods for FeedbackDataset in Argilla via the Python client
2 participants