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

[FEATURE] Add list datasets command python -m argilla datasets list #3591

Closed
Tracked by #3579
gabrielmbmb opened this issue Aug 18, 2023 · 0 comments · Fixed by #3658
Closed
Tracked by #3579

[FEATURE] Add list datasets command python -m argilla datasets list #3591

gabrielmbmb opened this issue Aug 18, 2023 · 0 comments · Fixed by #3658
Assignees
Labels
type: enhancement Indicates new feature requests
Milestone

Comments

@gabrielmbmb
Copy link
Member

No description provided.

@gabrielmbmb gabrielmbmb changed the title Add list datasets command python -m argilla datasets list [FEATURE] Add list datasets command python -m argilla datasets list Aug 22, 2023
@gabrielmbmb gabrielmbmb self-assigned this Aug 22, 2023
@gabrielmbmb gabrielmbmb added type: enhancement Indicates new feature requests client labels Aug 22, 2023
@gabrielmbmb gabrielmbmb added this to the 1.15.0 milestone Aug 22, 2023
alvarobartt added a commit that referenced this issue Aug 23, 2023
…3619)

# 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**

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

**How Has This Been Tested**

- [X] Add integration tests for `FeedbackDataset.list` (producing a list
of `RemoteFeedbackDataset`)

**Checklist**

- [X] 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
- [ ] My changes generate no new warnings
- [X] 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: Gabriel Martín Blázquez <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
@gabrielmbmb gabrielmbmb modified the milestones: v1.15.0, v1.16.0 Aug 28, 2023
gabrielmbmb added a commit that referenced this issue Aug 30, 2023
# Description

This PR adds a new command `python -m argilla datasets list` which
allows to list the datasets from the logged Argilla server in the
terminal.

<img width="1512" alt="image"
src="https://github.com/argilla-io/argilla/assets/29572918/5322b963-66aa-4926-bbb7-8fb9844a3365">

Closes #3591

**Type of change**

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

**How Has This Been Tested**

I've created a custom environment, used the `python -m argilla login`
command to login in it and then list the datasets from this environment
using the new command. All the datasets were listed. Applying workspace
filter worked. Applying dataset kind filter worked. Additionally, I've
added unit tests to cover all the additions.

**Checklist**

- [ ] I added relevant documentation
- [x] I followed 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
- [ ] 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: alvarobartt <[email protected]>
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 a pull request may close this issue.

1 participant