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] Create and end2end examples directory with .ipynb files that align with practical guid usage. #4178

Closed
13 tasks done
davidberenstein1957 opened this issue Nov 9, 2023 · 0 comments · Fixed by #4271
Closed
13 tasks done
Assignees
Labels
team: ml Indicates that the issue or pull request is owned by the Machine Learning (ML) team type: documentation Improvements or additions to documentation type: enhancement Indicates new feature requests
Milestone

Comments

@davidberenstein1957
Copy link
Member

davidberenstein1957 commented Nov 9, 2023

Which page or section is this issue related to?

The idea is to have runnable end2end examples of basic real-life examples for the different task-templates, where we will initially focus on the most common task text-classification.

Things to keep in mind:

  • they need to be executable individually but may require previous examples to be run by referencing them
  • they need to be aligned with the practical guides to ensure maintainability
  • it might be nice to add an optional telemetry module to see the number of usages for tutorials.
  • ideally, an updated version of these tutorial datasets should be available on the Hugging Face hub as imports
image

Tasks

  1. team: ml
    plaguss
  2. 0 of 1
    team: interns team: ml type: documentation
  3. 3 of 3
    plaguss
  4. 0 of 5
    team: interns team: ml type: documentation
    kursathalat
  5. 0 of 2
    team: interns team: ml type: documentation
  6. 0 of 3
    team: interns team: ml type: documentation
    kursathalat
  7. 0 of 4
    team: interns team: ml type: documentation
    kursathalat
  8. 0 of 2
    team: interns team: ml type: documentation
    sdiazlor
  9. 0 of 4
    team: interns team: ml type: documentation
    sdiazlor
  10. 0 of 3
    team: interns team: ml type: documentation
    kursathalat
  11. 0 of 4
    team: interns team: ml type: documentation
    kursathalat
  12. team: ml
    plaguss
  13. team: interns type: documentation
    davidberenstein1957
@davidberenstein1957 davidberenstein1957 added type: documentation Improvements or additions to documentation type: enhancement Indicates new feature requests team: ml Indicates that the issue or pull request is owned by the Machine Learning (ML) team labels Nov 9, 2023
@davidberenstein1957 davidberenstein1957 modified the milestones: v1.21.0, v1.20.0 Nov 28, 2023
@davidberenstein1957 davidberenstein1957 self-assigned this Nov 28, 2023
davidberenstein1957 added a commit that referenced this issue Nov 29, 2023
…aset (#4208)

<!-- 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 includes 2 features towards the #4178 issue.
- A tutorial for the creation of a `FeedbackDataset` for
`text-classification`.
- A new script has been added to run the notebooks automatically, via
end2end.yml workflow.

Closes #4179 and #4220

**Type of change**

(Remember to title the PR according to the type of change)

- [ ] Documentation update

**How Has This Been Tested**

(Please describe the tests that you ran to verify your changes.)

- [ ] `sphinx-autobuild` (read [Developer
Documentation](https://docs.argilla.io/en/latest/community/developer_docs.html#building-the-documentation)
for more details)

**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
- [ ] My changes generate no new warnings
- [ ] 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/)

---------

Co-authored-by: Agustin Piqueres <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: davidberenstein1957 <[email protected]>
Co-authored-by: kursathalat <[email protected]>
Co-authored-by: sdiazlor <[email protected]>
Co-authored-by: Sara Han <[email protected]>
@davidberenstein1957 davidberenstein1957 modified the milestones: v1.20.0, v1.21.0 Nov 30, 2023
@davidberenstein1957 davidberenstein1957 linked a pull request Dec 19, 2023 that will close this issue
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
team: ml Indicates that the issue or pull request is owned by the Machine Learning (ML) team type: documentation Improvements or additions to documentation type: enhancement Indicates new feature requests
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant