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

Add information how to see the features of the dataset #2627

Merged
merged 4 commits into from
Nov 23, 2023

Conversation

adam-narozniak
Copy link
Member

@adam-narozniak adam-narozniak commented Nov 23, 2023

Issue

The feature information (the name of the image label - either "img" or "image" that differs on HF) is needed to make decisions on the transformation of the dataset. Yet, it's not emphasized enough in the docs.

Proposal

Improve the documentation: quickstart + all the how-to-{framework} sections to include this information.

This PR also slightly restructures the TensorFlow example by pulling the common part to the beginning and not repeating it (there not repeating the newly added section neither)

Explanation

It is needed:

  • to apply transforms in PyTorch,
  • divided the dataset into X and y in NumPy,
  • transform into TensorFlow Dataset in TensorFlow

Copy link
Contributor

@jafermarq jafermarq left a comment

Choose a reason for hiding this comment

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

I left some comments!

Although not part of this PR, i think the Use with PyTorch page would benefit from some sections/subsections just like you do for TF and NumPy

datasets/doc/source/how-to-use-with-numpy.rst Outdated Show resolved Hide resolved
datasets/doc/source/how-to-use-with-tensorflow.rst Outdated Show resolved Hide resolved
datasets/doc/source/how-to-use-with-numpy.rst Outdated Show resolved Hide resolved
datasets/doc/source/how-to-use-with-tensorflow.rst Outdated Show resolved Hide resolved
datasets/doc/source/how-to-use-with-tensorflow.rst Outdated Show resolved Hide resolved
datasets/doc/source/tutorial-quickstart.rst Show resolved Hide resolved
@danieljanes danieljanes merged commit 6eca62b into main Nov 23, 2023
30 checks passed
@danieljanes danieljanes deleted the fds-add-info-about-features branch November 23, 2023 12:26
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