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: update example in hf spaces page #4571

Merged
merged 5 commits into from
Feb 14, 2024

Conversation

sdiazlor
Copy link
Contributor

@sdiazlor sdiazlor commented Feb 6, 2024

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.

Closes #4567

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

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 filled out the contributor form (see text above)
  • I have added relevant notes to the CHANGELOG.md file (See https://keepachangelog.com/)

@sdiazlor sdiazlor linked an issue Feb 6, 2024 that may be closed by this pull request
@dosubot dosubot bot added size:M This PR changes 30-99 lines, ignoring generated files. team: ml Indicates that the issue or pull request is owned by the Machine Learning (ML) team type: documentation Improvements or additions to documentation labels Feb 6, 2024
@sdiazlor sdiazlor marked this pull request as draft February 6, 2024 13:19
@sdiazlor sdiazlor changed the base branch from develop to main February 6, 2024 13:19
@sdiazlor sdiazlor marked this pull request as ready for review February 6, 2024 13:20
@sdiazlor sdiazlor requested a review from nataliaElv February 6, 2024 13:20
@sdiazlor sdiazlor self-assigned this Feb 6, 2024
Copy link
Member

@nataliaElv nataliaElv left a comment

Choose a reason for hiding this comment

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

It looks good to me, great work @sdiazlor !
I'll ask for @dvsrepo 's review just to have the double-check.

@nataliaElv nataliaElv requested a review from dvsrepo February 6, 2024 15:28
Copy link
Member

@davidberenstein1957 davidberenstein1957 left a comment

Choose a reason for hiding this comment

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

Thanks. I added some comments w.r.t. a small typo and a direct/indirect URL.

```

As a next step, you can check the [Argilla Tutorials](https://docs.argilla.io/en/latest/tutorials/tutorials.html) section. All the tutorials can be run using Colab or local Jupyter Notebooks, so you can start building datasets with Argilla and Spaces!
Congrats! You now have a dataset available from the Argilla UI to start browsing and labeling. I
Copy link
Member

Choose a reason for hiding this comment

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

small typo here


Finally, this is how you can train a SetFit model using data from your Argilla Space:
> You can also use `pandas` or `load_dataset` to [read an existing dataset and create records from it](https://docs.argilla.io/en/latest/practical_guides/create_update_dataset/records.html#add-records).
Copy link
Member

Choose a reason for hiding this comment

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

use a local reference not to the latest direct URL


At this point, you can label your data directly using your Argilla Space and read the training data to train your model of choice.
> To check your workspaces, go to "My settings" on the UI. If you need to create a new one, consult the [docs](https://docs.argilla.io/en/latest/getting_started/installation/configurations/workspace_management.html).
Copy link
Member

Choose a reason for hiding this comment

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

same here w.r.t. URLs

@dosubot dosubot bot added size:L This PR changes 100-499 lines, ignoring generated files. and removed size:M This PR changes 30-99 lines, ignoring generated files. labels Feb 14, 2024
Copy link
Member

@dvsrepo dvsrepo left a comment

Choose a reason for hiding this comment

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

good job, i've did some final edits as we were still referencing setfit

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Feb 14, 2024
@dvsrepo dvsrepo merged commit 77262f5 into main Feb 14, 2024
16 of 17 checks passed
@dvsrepo dvsrepo deleted the docs/4567-docs-update-example-in-hf-spaces-page branch February 14, 2024 19:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lgtm This PR has been approved by a maintainer size:L This PR changes 100-499 lines, ignoring generated files. team: ml Indicates that the issue or pull request is owned by the Machine Learning (ML) team type: documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOCS] Update example in HF Spaces page
4 participants