Skip to content

Conversation

@stevhliu
Copy link
Member

@stevhliu stevhliu commented Jun 9, 2022

This PR updates the tutorials to be more generalizable to all modalities. After reading the tutorials, a user should be able to load any type of dataset, know how to index into and slice a dataset, and do the most basic/common type of preprocessing (tokenization, resampling, applying transforms) depending on their dataset.

Other changes include:

  • Removed the sections about a dataset's metadata, features, and columns because we cover this in an earlier tutorial about inspecting the DatasetInfo through the dataset builder.
  • Separate the sharing dataset tutorial into two sections: (1) uploading via the web interface and (2) using the huggingface_hub library.
  • Renamed some tutorials in the TOC to be more clear and specific.
  • Added more text to nudge users towards joining the community and asking questions on the forums.
  • If it's okay with everyone, I'd also like to remove the section about loading and using metrics since we have the evaluate docs now.

@stevhliu stevhliu added the documentation Improvements or additions to documentation label Jun 9, 2022
@stevhliu stevhliu requested review from lhoestq and mariosasko June 9, 2022 22:00
@HuggingFaceDocBuilderDev
Copy link

HuggingFaceDocBuilderDev commented Jun 9, 2022

The documentation is not available anymore as the PR was closed or merged.

Copy link
Collaborator

@mariosasko mariosasko left a comment

Choose a reason for hiding this comment

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

Looks good already.

Maybe instead of removing the metrics docs abruptly, we can deprecate them for now (with a warning?) and redirect users to the evaluate docs.

Some nits:

Copy link
Member

@lhoestq lhoestq left a comment

Choose a reason for hiding this comment

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

Awesome ! And +1 about deprecating metrics instead of removing them, and redirecting to evaluate

CI fails are unrelated to this PR, you can ignore them

@stevhliu stevhliu merged commit 40553c7 into huggingface:master Jun 14, 2022
@stevhliu stevhliu deleted the fresh-tutorials branch June 14, 2022 16:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants