Before you download a dataset from the Hub, it is helpful to know which datasets are available or if a specific dataset you’re interested in is available. Datasets Server provides two endpoints for verifying whether a dataset is valid or not:
/valid
returns a list of all the datasets that work without any errors./is-valid
checks if a specific dataset works without any errors.The API endpoints will return an error for datasets that cannot be loaded with the 🤗 Datasets library, for example, because the data hasn’t been uploaded or the format is not supported.
preview
field in the response of
/valid
to view these partially supported datasets.
This guide shows you how to check dataset validity programmatically, but free to try it out with Postman, RapidAPI, or ReDoc.
The /valid
endpoint returns a list of Hub datasets that are expected to load without any errors. This endpoint takes no query parameters:
import requests
API_URL = "https://datasets-server.huggingface.co/valid"
def query():
response = requests.get(API_URL)
return response.json()
data = query()
The endpoint response is a JSON containing lists of datasets nested under the following keys:
viewer
: the dataset is fully-supported and the Dataset Viewer is working on the Hub dataset page. It also means the dataset has been auto-converted to Parquet.preview
: the dataset is partially supported and the Dataset Viewer on the Hub dataset page shows a preview of the first 100 rows obtained by streaming.{
"viewer": [
"0-hero/OIG-small-chip2",
"000alen/semantic","04-07-22/wep-probes",
"0721boy/nva-pic",
"0Tick/Danbooru-Random-Posts-Scrape",
"0Tick/E621-Random-PostsTag-Scrape",
"0n1xus/codexglue"
"..."
],
"preview": [
"0x7194633/GCRL-flibusta",
"0xJustin/Dungeons_and_Diffusion_uncropped",
"0xaryan/music-classifier","13GP/training",
"..."
]
}
On the other hand, /is-valid
checks whether a specific dataset loads without any error. This endpoint’s query parameter requires you to specify the name of the dataset:
import requests
headers = {"Authorization": f"Bearer {API_TOKEN}"}
API_URL = "https://datasets-server.huggingface.co/is-valid?dataset=rotten_tomatoes"
def query():
response = requests.get(API_URL, headers=headers)
return response.json()
data = query()
The response looks like this if a dataset is valid:
{
"viewer": true,
"preview": true
}
If only the first rows of a dataset are available, then the response looks like:
{
"viewer": false,
"preview": true
}
Finally, if the dataset is not valid at all, then the response is:
{
"viewer": false,
"preview": false
}
Some cases where a dataset is not valid are: