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

API docs mini tweaks #1075

Merged
merged 2 commits into from
Nov 2, 2023
Merged

API docs mini tweaks #1075

merged 2 commits into from
Nov 2, 2023

Conversation

julien-c
Copy link
Member

@julien-c julien-c commented Nov 2, 2023

very minor tweaks, the main one was that i didn't really like Search API (confusing with the Hub full text search)

@HuggingFaceDocBuilderDev
Copy link

HuggingFaceDocBuilderDev commented Nov 2, 2023

The documentation is not available anymore as the PR was closed or merged.

Copy link
Contributor

@Wauplin Wauplin left a comment

Choose a reason for hiding this comment

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

Looks good. I also pushed a commit to your branch to remove config from /api/spaces route (cc @enzostvs). Hope you don't mind :)

@@ -139,11 +138,6 @@ Get all information for a specific model.

This is equivalent to `huggingface_hub.space_info(repo_id, revision)`.

### GET /api/metrics
Copy link
Contributor

Choose a reason for hiding this comment

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

You don't like https://huggingface.co/api/metrics or just that you don't think it should be listed among the listing APIs ?

Copy link
Member Author

Choose a reason for hiding this comment

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

i think it's not really used anymore (cc @lewtun @lvwerra @lhoestq maybe if they know?)

and the name is a bit confusing (if i'm a user, i'm like "are those metrics about HF?")

so i'd undocument it

Copy link
Member

Choose a reason for hiding this comment

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

no strong opinion. fine with me to remove it there.

Copy link
Member

Choose a reason for hiding this comment

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

I haven't seen it used personally

Copy link
Contributor

Choose a reason for hiding this comment

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

Makes sense. Let's merge this PR then 👍

@Wauplin Wauplin merged commit d58bfa1 into main Nov 2, 2023
1 check passed
@Wauplin Wauplin deleted the api-doc-mini-tweaks branch November 2, 2023 17:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants