docs: ✏️ add links to the Datasets API #4984
Conversation
|
The documentation is not available anymore as the PR was closed or merged. |
| @@ -303,6 +303,8 @@ def get_dataset_config_names( | |||
| 'rte', | |||
| 'wnli', | |||
| 'ax'] | |||
|
|
|||
| Note that you can fetch the list of configs for a dataset on the Hugging Face Hub via an HTTP request with the [Datasets REST API endpoint /splits](https://huggingface.co/docs/datasets-server/splits). | |||
There was a problem hiding this comment.
I don't think adding this here would bring a lot of users. Maybe prefer adding some links in the actual docs
|
|
||
| Are you looking for the [Datasets REST API](https://huggingface.co/docs/datasets-server)? Integrate into your apps over 10,000 datasets via simple **HTTP requests**, with pre-processed responses and scalability built-in. | ||
|
|
||
| </Tip> |
There was a problem hiding this comment.
Adding this tip will bring the four blocks "tutorials" "how-to guides" etc. at the very bottom of the page and users will have to scroll. As it is the first page, it must also be minimal and straight to the point. Therefore I'm not a big fan of changing this page.
datasets users will probably mostly be interested in having the preview working. I think we can have a dedicated page in the "Dataset Repository" section about "Dataset Preview" that explains how it works, and possibly redirect to the REST API
|
OK, thanks @lhoestq. I'll close this PR, and come back to it with @stevhliu once we work on huggingface/dataset-viewer#568 |
I added some links to the Datasets API in the docs. See huggingface/dataset-viewer#566 for a companion PR in the datasets-server. The idea is to improve the discovery of the API through the docs.
I'm a bit shy about pasting a lot of links to the API in the docs, so it's minimal for now. I'm interested in ideas to integrate the API better in these docs without being too much. cc @lhoestq @julien-c @albertvillanova @stevhliu.