Skip to content

Commit

Permalink
add documentation page for api playground
Browse files Browse the repository at this point in the history
  • Loading branch information
cfahlgren1 committed Sep 12, 2024
1 parent ecfcada commit 7f6e9b0
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/source/_toctree.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
title: Quickstart
- local: analyze_data
title: Analyze a dataset on the Hub
- local: api_playground
title: API Playground
- title: Guides
sections:
- local: valid
Expand Down
20 changes: 20 additions & 0 deletions docs/source/api_playground.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Dataset Viewer API Playground

The Dataset Viewer API is a powerful tool for exploring and interacting with datasets on the HuggingFace Hub.

It includes a set of endpoints for querying, filtering, and analyzing data from various datasets.

The base URL for the Dataset Viewer API is `https://datasets-server.huggingface.co/`.

## Try it out

Use the [API Playground](https://github.com/huggingface/dataset-viewer/tree/main/api_playground) to make requests to the Dataset Viewer API and visualize the results.

<div class="flex justify-center">
<a href="https://huggingface.co/spaces/cfahlgren1/datasets-api-playground" target="_blank">
<img
src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/datasets-server/datasets-api-playground.png"
alt="Dataset API Playground"
/>
</a>
</div>

0 comments on commit 7f6e9b0

Please sign in to comment.