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

Docs: Migration notebook suggestions #4996

Closed

Conversation

nataliaElv
Copy link
Member

Argilla Community Growers

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.

Pull Request Templates

Please go the the Preview tab and select the appropriate sub-template:

Generic Pull Request Template

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.

Closes #<issue_number>

Type of change

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

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Refactor (change restructuring the codebase without changing functionality)
  • Improvement (change adding some improvement to an existing functionality)
  • Documentation update

How Has This Been Tested

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

  • Test A
  • Test B

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/)

frascuchon and others added 24 commits June 6, 2024 11:26
…gilla/define-new-argilla-package-and-move-argilla-to-argilla-v1
…ine-new-argilla-package-and-move-argilla-to-argilla-v1
<!-- 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

This PR is part of the work to tackle
#4889. The current package
`argilla-sdk` has been renamed to `argilla`. Once the rest of the open
PRs are merged, I will bring all those changes here and rename the
project folder `argilla-sdk` to `argilla`

**Type of change**

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

- [ ] New feature (non-breaking change which adds functionality)
- [ ] Refactor (change restructuring the codebase without changing
functionality)
- [ ] Improvement (change adding some improvement to an existing
functionality)

**How Has This Been Tested**

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

- [ ] Test A
- [ ] Test B

**Checklist**

- [ ] I added relevant documentation
- [ ] I followed 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](https://tally.so/r/n9XrxK)
(see text above)
- [ ] I have added relevant notes to the `CHANGELOG.md` file (See
https://keepachangelog.com/)
@nataliaElv
Copy link
Member Author

We probably want to do something better for the predictions -> suggestions in map_to_record_for_multi_label or else one could be selecting all labels as suggestions.

@nataliaElv
Copy link
Member Author

I see we're not providing a solution for TokenClassification > SpanQuestion and Text2Text > TextQuestion. I assume that's because of their minimal use @frascuchon ?

@burtenshaw
Copy link
Contributor

@frascuchon @nataliaElv I would like to move this notebook into a markdown based guide like the other how-to?. That would allow me to do these steps:

  • simplify the sections so that it is 'importing from v1' , 'wrangling' , 'exporting to v2' (with better titles)
  • add the processing functions to tabs with explanation about each
  • reference the existing API documentation and guides to save explanation.

@nataliaElv If that's ok for you, I'll create a PR off this?

@nataliaElv
Copy link
Member Author

@frascuchon @nataliaElv I would like to move this notebook into a markdown based guide like the other how-to?. That would allow me to do these steps:

  • simplify the sections so that it is 'importing from v1' , 'wrangling' , 'exporting to v2' (with better titles)
  • add the processing functions to tabs with explanation about each
  • reference the existing API documentation and guides to save explanation.

@nataliaElv If that's ok for you, I'll create a PR off this?

Sure! Go ahead. Or you can even use this PR to make those changes if that's easier for branch/PR management.

Base automatically changed from feat/argilla/define-new-argilla-package-and-move-argilla-to-argilla-v1 to feat/rename-argilla-2-argilla-v1 June 13, 2024 09:12
@frascuchon
Copy link
Member

Thanks for this @nataliaElv. I will close this PR in favor of #5002

@frascuchon frascuchon closed this Jun 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants