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

Refer to Hub docs in dataset-viewer docs #2845

Closed
severo opened this issue May 21, 2024 · 3 comments · Fixed by #3013
Closed

Refer to Hub docs in dataset-viewer docs #2845

severo opened this issue May 21, 2024 · 3 comments · Fixed by #3013
Labels
documentation Improvements or additions to documentation P1 Not as needed as P0, but still important/wanted

Comments

@severo
Copy link
Collaborator

severo commented May 21, 2024

See https://www.reddit.com/r/huggingface/comments/1csdrfn/comment/l50jfkx/

It would be useful if the "dataset viewer" doc page referenced the one you gave.

From https://huggingface.co/docs/datasets-server, it's not easy to see the docs for https://huggingface.co/docs/hub/datasets-data-files-configuration or https://huggingface.co/docs/hub/datasets-adding#file-formats or https://huggingface.co/collections/datasets-examples/image-dataset-6568e7cf28639db76eb92d65.

We should make it a lot clearer in https://huggingface.co/docs/datasets-server that we document the API while https://huggingface.co/docs/hub/datasets documents the Datasets Hub, including how to configure the dataset.

What do you think @julien-c @stevhliu @huggingface/dataset-viewer?

@severo severo added documentation Improvements or additions to documentation P1 Not as needed as P0, but still important/wanted labels May 21, 2024
@ppbrown
Copy link

ppbrown commented May 21, 2024

More specifically,
https://huggingface.co/docs/hub/en/datasets-viewer-configure

really needs to reference https://huggingface.co/docs/hub/datasets-image

In particular, the ability to add metadata for the images, that gets displayed by the viewer, was something I had difficulty finding up til now.

@julien-c
Copy link
Member

What do you think @julien-c @stevhliu @huggingface/dataset-viewer?

yes agreed, let's improve it

@stevhliu
Copy link
Member

To make it clearer, maybe you can add something like the below to Dataset viewer's index.md?

The dataset viewer is a lightweight web API for visualizing and exploring all types of datasets - computer vision, speech, text, and tabular - stored on the Hugging Face Hub.
Look at the Hub's Datasets documentation to learn more about managing datasets from the Hub's web-based interface.

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 P1 Not as needed as P0, but still important/wanted
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants