Update Hugging Face Hub documentation README and Endpoints #527
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Also cc @stevhliu |
osanseviero
reviewed
Dec 9, 2021
LysandreJik
reviewed
Dec 9, 2021
julien-c
reviewed
Dec 9, 2021
docs/hub/endpoints.md
Outdated
| | /api/datasets/{repo_id} <br/> /api/datasets/{repo_id}/revision/{revision} <br/> GET | Get all information for a specific dataset. <br/>- `full`: Whether to fetch most dataset data, such as all tags, the files, etc. | `dataset_info(repo_id, revision)` | ```headers = { "authorization" : "Bearer $token", "full" : "full" }``` | | ||
| | /api/metrics <br/> GET | Get information from all metrics in the Hub. | `list_metrics()` || |
There was a problem hiding this comment.
not sure we really need this to be honest (no strong opinion), as metrics are not user-generated (unlike models and datasets and spaces) I wouldn't consider them a first class citizen of the hub
(that method is documented in datasets though, where it's relevant to have it)
There was a problem hiding this comment.
My motivation with exposing it here is since there is a functional api within HfApi for it (e.g. list_metrics), it's in the docs that it doesn't take in params and just grabs them all.
There was a problem hiding this comment.
@julien-c kept it in for final, if we want it removed let me know
stevhliu
reviewed
Dec 9, 2021
Co-authored-by: Omar Sanseviero <osanseviero@users.noreply.github.com>
LysandreJik
approved these changes
Dec 14, 2021
|
Feel free to merge when the code quality passes :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Started updating the documentation to include the latest API information.
README:
cached_downloadHfApiquery methods and link to endpoint documentationEndpoints:
/api/modelsand/api/datasetsto includeauthorfilter/api/metricsmain:
cc @osanseviero @LysandreJik @julien-c