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.

Sign up for GitHub

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 documentation page for api playground #3060

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+13 −0
Open

add documentation page for api playground #3060

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7f6e9b0
add documentation page for api playground
cfahlgren1 Sep 12, 2024
4378aa2
reword
cfahlgren1 Sep 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
reword
@cfahlgren1
cfahlgren1 committed Sep 12, 2024
commit 4378aa274f1973c63190946904d2de557148e952
13 changes: 2 additions & 11 deletions docs/source/api_playground.md
View file
Original file line number Diff line number Diff line change
@@ -1,20 +1,11 @@
# 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.
The [API Playground](https://huggingface.co/spaces/cfahlgren1/datasets-api-playground) is a space that allows you to make requests to the Dataset Viewer API and visualize the results in real-time. It's a great way to explore the capabilities of the API and test different queries.

<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"
Copy link
Member

Choose a reason for hiding this comment

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

potentially you can do a slightly more catchy visual like @enzostvs had done for the API playground: https://huggingface.co/docs/hub/api

(and you can embed it in other doc pages too with a more fun / simpler call to action "want to try out the API?")

alt="Dataset API Playground"
/>
</a>
Copy link
Collaborator

Choose a reason for hiding this comment

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

the opening tag is missing

</div>
</div>