Hugging Face Hub API
Below is the documentation for the HfApi
class, which serves as a Python wrapper for the Hugging Face
Hub’s API.
All methods from the HfApi
are also accessible from the package’s root directly, both approaches are detailed
below.
The following approach uses the method from the root of the package:
from huggingface_hub import list_models
models = list_models()
The following approach uses the HfApi
class:
from huggingface_hub import HfApi
hf_api = HfApi()
models = hf_api.list_models()
Using the HfApi
class directly enables you to set a different endpoint to that of the Hugging Face’s Hub.
change_discussion_status
< source >( repo_id: str discussion_num: int new_status: typing.Literal['open', 'closed'] token: typing.Optional[str] = None comment: typing.Optional[str] = None repo_type: typing.Optional[str] = None ) → DiscussionStatusChange
Parameters
-
repo_id (
str
) — A namespace (user or an organization) and a repo name separated by a/
. -
discussion_num (
int
) — The number of the Discussion or Pull Request . Must be a strictly positive integer. -
new_status (
str
) — The new status for the discussion, either"open"
or"closed"
. -
comment (
str
, optional) — An optional comment to post with the status change. -
repo_type (
str
, optional) — Set to"dataset"
or"space"
if uploading to a dataset or space,None
or"model"
if uploading to a model. Default isNone
. -
token (
str
, optional) — An authentication token (See https://huggingface.co/settings/token)
Returns
the status change event
Closes or re-opens a Discussion or Pull Request.
Examples:
>>> new_title = "New title, fixing a typo"
>>> HfApi().rename_discussion(
... repo_id="username/repo_name",
... discussion_num=34
... new_title=new_title
... )
# DiscussionStatusChange(id='deadbeef0000000', type='status-change', ...)
Raises the following errors:
HTTPError
if the HuggingFace API returned an errorValueError
if some parameter value is invalid- RepositoryNotFoundError
If the repository to download from cannot be found. This may be because it doesn’t exist,
or because it is set to
private
and you do not have access.
comment_discussion
< source >( repo_id: str discussion_num: int comment: str token: typing.Optional[str] = None repo_type: typing.Optional[str] = None ) → DiscussionComment
Parameters
-
repo_id (
str
) — A namespace (user or an organization) and a repo name separated by a/
. -
discussion_num (
int
) — The number of the Discussion or Pull Request . Must be a strictly positive integer. -
comment (
str
) — The content of the comment to create. Comments support markdown formatting. -
repo_type (
str
, optional) — Set to"dataset"
or"space"
if uploading to a dataset or space,None
or"model"
if uploading to a model. Default isNone
. -
token (
str
, optional) — An authentication token (See https://huggingface.co/settings/token)
Returns
the newly created comment
Creates a new comment on the given Discussion.
Examples:
>>> comment = """
... Hello @otheruser!
...
... # This is a title
...
... **This is bold**, *this is italic* and ~this is strikethrough~
... And [this](http://url) is a link
... """
>>> HfApi().comment_discussion(
... repo_id="username/repo_name",
... discussion_num=34
... comment=comment
... )
# DiscussionComment(id='deadbeef0000000', type='comment', ...)
Raises the following errors:
HTTPError
if the HuggingFace API returned an errorValueError
if some parameter value is invalid- RepositoryNotFoundError
If the repository to download from cannot be found. This may be because it doesn’t exist,
or because it is set to
private
and you do not have access.
create_commit
< source >( repo_id: str operations: typing.Iterable[typing.Union[huggingface_hub._commit_api.CommitOperationAdd, huggingface_hub._commit_api.CommitOperationDelete]] commit_message: str commit_description: typing.Optional[str] = None token: typing.Optional[str] = None repo_type: typing.Optional[str] = None revision: typing.Optional[str] = None create_pr: typing.Optional[bool] = None num_threads: int = 5 parent_commit: typing.Optional[str] = None ) → str or None
Parameters
- repo_id (str) — The repository in which the commit will be created, for example: “username/custom_transformers”
-
operations (Iterable of [~huggingface_hub.hf_api.CommitOperation]) —
An iterable of operations to include in the commit, either:
- [~huggingface_hub.hf_api.CommitOperationAdd] to upload a file
- [~huggingface_hub.hf_api.CommitOperationDelete] to delete a file
- commit_message (str) — The summary (first line) of the commit that will be created.
- commit_description (str, optional) — The description of the commit that will be created
- token (str, optional) — Authentication token, obtained with HfApi.login method. Will default to the stored token.
- repo_type (str, optional) — Set to “dataset” or “space” if uploading to a dataset or space, None or “model” if uploading to a model. Default is None.
- revision (str, optional) — The git revision to commit from. Defaults to the head of the “main” branch.
- create_pr (boolean, optional) — Whether or not to create a Pull Request from revision with that commit. Defaults to False. If set to True, this function will return the URL to the newly created Pull Request on the Hub.
- num_threads (int, optional) — Number of concurrent threads for uploading files. Defaults to 5. Setting it to 2 means at most 2 files will be uploaded concurrently.
- parent_commit (str, optional) — The OID / SHA of the parent commit, as a hexadecimal string. Shorthands (7 first characters) are also supported.If specified and create_pr is False, the commit will fail if revision does not point to parent_commit. If specified and create_pr is True, the pull request will be created from parent_commit. Specifying parent_commit ensures the repo has not changed before committing the changes, and can be especially useful if the repo is updated / committed to concurrently.
Returns
str or None
If create_pr is True, returns the URL to the newly created Pull Request on the Hub. Otherwise returns None.
Creates a commit in the given repo, deleting & uploading files as needed.
create_discussion
< source >( repo_id: str title: str token: str description: typing.Optional[str] = None repo_type: typing.Optional[str] = None pull_request: bool = False )
Parameters
-
repo_id (
str
) — A namespace (user or an organization) and a repo name separated by a/
. -
title (
str
) — The title of the discussion. It can be up to 200 characters long, and must be at least 3 characters long. Leading and trailing whitespaces will be stripped. -
token (
str
) — An authentication token (See https://huggingface.co/settings/token) -
description (
str
, optional) — An optional description for the Pull Request. Defaults to"Discussion opened with the huggingface_hub Python library"
-
pull_request (
bool
, optional) — Whether to create a Pull Request or discussion. IfTrue
, creates a Pull Request. IfFalse
, creates a discussion. Defaults toFalse
. -
repo_type (
str
, optional) — Set to"dataset"
or"space"
if uploading to a dataset or space,None
or"model"
if uploading to a model. Default isNone
.
Creates a Discussion or Pull Request.
Pull Requests created programmatically will be in "draft"
status.
Creating a Pull Request with changes can also be done at once with HfApi.create_commit().
Returns: DiscussionWithDetails
Raises the following errors:
HTTPError
if the HuggingFace API returned an errorValueError
if some parameter value is invalid- RepositoryNotFoundError
If the repository to download from cannot be found. This may be because it doesn’t exist,
or because it is set to
private
and you do not have access.
create_pull_request
< source >( repo_id: str title: str token: str description: typing.Optional[str] = None repo_type: typing.Optional[str] = None )
Parameters
-
repo_id (
str
) — A namespace (user or an organization) and a repo name separated by a/
. -
title (
str
) — The title of the discussion. It can be up to 200 characters long, and must be at least 3 characters long. Leading and trailing whitespaces will be stripped. -
token (
str
) — An authentication token (See https://huggingface.co/settings/token) -
description (
str
, optional) — An optional description for the Pull Request. Defaults to"Discussion opened with the huggingface_hub Python library"
-
repo_type (
str
, optional) — Set to"dataset"
or"space"
if uploading to a dataset or space,None
or"model"
if uploading to a model. Default isNone
.
Creates a Pull Request . Pull Requests created programmatically will be in "draft"
status.
Creating a Pull Request with changes can also be done at once with HfApi.create_commit();
This is a wrapper around HfApi.create_discusssion
.
Returns: DiscussionWithDetails
Raises the following errors:
HTTPError
if the HuggingFace API returned an errorValueError
if some parameter value is invalid- RepositoryNotFoundError
If the repository to download from cannot be found. This may be because it doesn’t exist,
or because it is set to
private
and you do not have access.
create_repo
< source >(
repo_id: str = None
token: typing.Optional[str] = None
organization: typing.Optional[str] = None
private: typing.Optional[bool] = None
repo_type: typing.Optional[str] = None
exist_ok: typing.Optional[bool] = False
space_sdk: typing.Optional[str] = None
name: typing.Optional[str] = None
)
→
str
Parameters
-
repo_id (
str
) — A namespace (user or an organization) and a repo name separated by a/
.Version added: 0.5
-
token (
str
, optional) — An authentication token (See https://huggingface.co/settings/token) -
private (
bool
, optional) — Whether the model repo should be private. -
repo_type (
str
, optional) — Set to"dataset"
or"space"
if uploading to a dataset or space,None
or"model"
if uploading to a model. Default isNone
. -
exist_ok (
bool
, optional, defaults toFalse
) — IfTrue
, do not raise an error if repo already exists. -
space_sdk (
str
, optional) — Choice of SDK to use if repo_type is “space”. Can be “streamlit”, “gradio”, or “static”.
Returns
str
URL to the newly created repo.
Create an empty repo on the HuggingFace Hub.
dataset_info
< source >( repo_id: str revision: typing.Optional[str] = None token: typing.Optional[str] = None timeout: typing.Optional[float] = None files_metadata: bool = False ) → huggingface_hub.hf_api.DatasetInfo
Parameters
-
repo_id (
str
) — A namespace (user or an organization) and a repo name separated by a/
. -
revision (
str
, optional) — The revision of the dataset repository from which to get the information. -
token (
str
, optional) — An authentication token (See https://huggingface.co/settings/token) -
timeout (
float
, optional) — Whether to set a timeout for the request to the Hub. -
files_metadata (
bool
, optional) — Whether or not to retrieve metadata for files in the repository (size, LFS metadata, etc). Defaults toFalse
.
The dataset repository information.
Get info on one specific dataset on huggingface.co.
Dataset can be private if you pass an acceptable token.
Raises the following errors:
- RepositoryNotFoundError
If the repository to download from cannot be found. This may be because it doesn’t exist,
or because it is set to
private
and you do not have access. - RevisionNotFoundError If the revision to download from cannot be found.
delete_file
< source >( path_in_repo: str repo_id: str token: typing.Optional[str] = None repo_type: typing.Optional[str] = None revision: typing.Optional[str] = None commit_message: typing.Optional[str] = None commit_description: typing.Optional[str] = None create_pr: typing.Optional[bool] = None parent_commit: typing.Optional[str] = None )
Parameters
-
path_in_repo (
str
) — Relative filepath in the repo, for example:"checkpoints/1fec34a/weights.bin"
-
repo_id (
str
) — The repository from which the file will be deleted, for example:"username/custom_transformers"
-
token (
str
, optional) — Authentication token, obtained withHfApi.login
method. Will default to the stored token. -
repo_type (
str
, optional) — Set to"dataset"
or"space"
if the file is in a dataset or space,None
or"model"
if in a model. Default isNone
. -
revision (
str
, optional) — The git revision to commit from. Defaults to the head of the"main"
branch. -
commit_message (
str
, optional) — The summary / title / first line of the generated commit. Defaults tof"Delete {path_in_repo} with huggingface_hub"
. -
commit_description (
str
optional) — The description of the generated commit -
create_pr (
boolean
, optional) — Whether or not to create a Pull Request fromrevision
with the changes. Defaults toFalse
. -
parent_commit (
str
, optional) — The OID / SHA of the parent commit, as a hexadecimal string. Shorthands (7 first characters) are also supported. If specified andcreate_pr
isFalse
, the commit will fail ifrevision
does not point toparent_commit
. If specified andcreate_pr
isTrue
, the pull request will be created fromparent_commit
. Specifyingparent_commit
ensures the repo has not changed before committing the changes, and can be especially useful if the repo is updated / committed to concurrently.
Deletes a file in the given repo.
Raises the following errors:
HTTPError
if the HuggingFace API returned an errorValueError
if some parameter value is invalid- RepositoryNotFoundError
If the repository to download from cannot be found. This may be because it doesn’t exist,
or because it is set to
private
and you do not have access. - RevisionNotFoundError If the revision to download from cannot be found.
- EntryNotFoundError If the file to download cannot be found.
delete_repo
< source >( repo_id: str = None token: typing.Optional[str] = None repo_type: typing.Optional[str] = None )
Parameters
-
repo_id (
str
) — A namespace (user or an organization) and a repo name separated by a/
.Version added: 0.5
-
token (
str
, optional) — An authentication token (See https://huggingface.co/settings/token) -
repo_type (
str
, optional) — Set to"dataset"
or"space"
if uploading to a dataset or space,None
or"model"
if uploading to a model.
Delete a repo from the HuggingFace Hub. CAUTION: this is irreversible.
Raises the following errors:
- RepositoryNotFoundError
If the repository to download from cannot be found. This may be because it doesn’t exist,
or because it is set to
private
and you do not have access.
edit_discussion_comment
< source >( repo_id: str discussion_num: int comment_id: str new_content: str token: typing.Optional[str] = None repo_type: typing.Optional[str] = None ) → DiscussionComment
Parameters
-
repo_id (
str
) — A namespace (user or an organization) and a repo name separated by a/
. -
discussion_num (
int
) — The number of the Discussion or Pull Request . Must be a strictly positive integer. -
comment_id (
str
) — The ID of the comment to edit. -
new_content (
str
) — The new content of the comment. Comments support markdown formatting. -
repo_type (
str
, optional) — Set to"dataset"
or"space"
if uploading to a dataset or space,None
or"model"
if uploading to a model. Default isNone
. -
token (
str
, optional) — An authentication token (See https://huggingface.co/settings/token)
Returns
the edited comment
Edits a comment on a Discussion / Pull Request.
Raises the following errors:
HTTPError
if the HuggingFace API returned an errorValueError
if some parameter value is invalid- RepositoryNotFoundError
If the repository to download from cannot be found. This may be because it doesn’t exist,
or because it is set to
private
and you do not have access.
Gets all valid dataset tags as a nested namespace object.
get_discussion_details
< source >( repo_id: str discussion_num: int repo_type: typing.Optional[str] = None token: typing.Optional[str] = None )
Parameters
-
repo_id (
str
) — A namespace (user or an organization) and a repo name separated by a/
. -
discussion_num (
int
) — The number of the Discussion or Pull Request . Must be a strictly positive integer. -
repo_type (
str
, optional) — Set to"dataset"
or"space"
if uploading to a dataset or space,None
or"model"
if uploading to a model. Default isNone
. -
token (
str
, optional) — An authentication token (See https://huggingface.co/settings/token)
Fetches a Discussion’s / Pull Request ‘s details from the Hub.
Returns: DiscussionWithDetails
Raises the following errors:
HTTPError
if the HuggingFace API returned an errorValueError
if some parameter value is invalid- RepositoryNotFoundError
If the repository to download from cannot be found. This may be because it doesn’t exist,
or because it is set to
private
and you do not have access.
get_full_repo_name
< source >(
model_id: str
organization: typing.Optional[str] = None
token: typing.Optional[str] = None
)
→
str
Parameters
-
model_id (
str
) — The name of the model. -
organization (
str
, optional) — If passed, the repository name will be in the organization namespace instead of the user namespace. -
token (
str
, optional) — The Hugging Face authentication token
Returns
str
The repository name in the user’s namespace ({username}/{model_id}) if no organization is passed, and under the organization namespace ({organization}/{model_id}) otherwise.
Returns the repository name for a given model ID and optional organization.
Gets all valid model tags as a nested namespace object
get_repo_discussions
< source >(
repo_id: str
repo_type: typing.Optional[str] = None
token: typing.Optional[str] = None
)
→
Iterator[Discussion]
Parameters
-
repo_id (
str
) — A namespace (user or an organization) and a repo name separated by a/
. -
repo_type (
str
, optional) — Set to"dataset"
or"space"
if fetching from a dataset or space,None
or"model"
if fetching from a model. Default isNone
. -
token (
str
, optional) — An authentication token (See https://huggingface.co/settings/token).
Returns
Iterator[Discussion]
An iterator of Discussion objects.
Fetches Discussions and Pull Requests for the given repo.
Example:
hide_discussion_comment
< source >( repo_id: str discussion_num: int comment_id: str token: str repo_type: typing.Optional[str] = None ) → DiscussionComment
Parameters
-
repo_id (
str
) — A namespace (user or an organization) and a repo name separated by a/
. -
discussion_num (
int
) — The number of the Discussion or Pull Request . Must be a strictly positive integer. -
comment_id (
str
) — The ID of the comment to edit. -
repo_type (
str
, optional) — Set to"dataset"
or"space"
if uploading to a dataset or space,None
or"model"
if uploading to a model. Default isNone
. -
token (
str
, optional) — An authentication token (See https://huggingface.co/settings/token)
Returns
the hidden comment
Hides a comment on a Discussion / Pull Request.
Raises the following errors:
HTTPError
if the HuggingFace API returned an errorValueError
if some parameter value is invalid- RepositoryNotFoundError
If the repository to download from cannot be found. This may be because it doesn’t exist,
or because it is set to
private
and you do not have access.
list_datasets
< source >( filter: typing.Union[huggingface_hub.utils.endpoint_helpers.DatasetFilter, str, typing.Iterable[str], NoneType] = None author: typing.Optional[str] = None search: typing.Optional[str] = None sort: typing.Union[typing.Literal['lastModified'], str, NoneType] = None direction: typing.Optional[typing.Literal[-1]] = None limit: typing.Optional[int] = None cardData: typing.Optional[bool] = None full: typing.Optional[bool] = None use_auth_token: typing.Optional[str] = None )
Parameters
-
filter (DatasetFilter or
str
orIterable
, optional) — A string or DatasetFilter which can be used to identify datasets on the hub. -
author (
str
, optional) — A string which identify the author of the returned models -
search (
str
, optional) — A string that will be contained in the returned models. -
sort (
Literal["lastModified"]
orstr
, optional) — The key with which to sort the resulting datasets. Possible values are the properties of the huggingface_hub.hf_api.DatasetInfo class. -
direction (
Literal[-1]
orint
, optional) — Direction in which to sort. The value-1
sorts by descending order while all other values sort by ascending order. -
limit (
int
, optional) — The limit on the number of datasets fetched. Leaving this option toNone
fetches all datasets. -
cardData (
bool
, optional) — Whether to grab the metadata for the dataset as well. Can contain useful information such as the PapersWithCode ID. -
full (
bool
, optional) — Whether to fetch all dataset data, including thelastModified
and thecardData
. -
use_auth_token (
bool
orstr
, optional) — Whether to use theauth_token
provided from thehuggingface_hub
cli. If not logged in, a validauth_token
can be passed in as a string.
Get the public list of all the datasets on huggingface.co
Example usage with the filter
argument:
>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> # List all datasets
>>> api.list_datasets()
>>> # Get all valid search arguments
>>> args = DatasetSearchArguments()
>>> # List only the text classification datasets
>>> api.list_datasets(filter="task_categories:text-classification")
>>> # Using the `DatasetFilter`
>>> filt = DatasetFilter(task_categories="text-classification")
>>> # With `DatasetSearchArguments`
>>> filt = DatasetFilter(task=args.task_categories.text_classification)
>>> api.list_models(filter=filt)
>>> # List only the datasets in russian for language modeling
>>> api.list_datasets(
... filter=("languages:ru", "task_ids:language-modeling")
... )
>>> # Using the `DatasetFilter`
>>> filt = DatasetFilter(languages="ru", task_ids="language-modeling")
>>> # With `DatasetSearchArguments`
>>> filt = DatasetFilter(
... languages=args.languages.ru,
... task_ids=args.task_ids.language_modeling,
... )
>>> api.list_datasets(filter=filt)
Example usage with the search
argument:
>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> # List all datasets with "text" in their name
>>> api.list_datasets(search="text")
>>> # List all datasets with "text" in their name made by google
>>> api.list_datasets(search="text", author="google")
list_metrics
< source >(
)
→
List[MetricInfo]
Returns
List[MetricInfo]
a list of MetricInfo
objects which.
Get the public list of all the metrics on huggingface.co
list_models
< source >( filter: typing.Union[huggingface_hub.utils.endpoint_helpers.ModelFilter, str, typing.Iterable[str], NoneType] = None author: typing.Optional[str] = None search: typing.Optional[str] = None emissions_thresholds: typing.Union[typing.Tuple[float, float], NoneType] = None sort: typing.Union[typing.Literal['lastModified'], str, NoneType] = None direction: typing.Optional[typing.Literal[-1]] = None limit: typing.Optional[int] = None full: typing.Optional[bool] = None cardData: typing.Optional[bool] = None fetch_config: typing.Optional[bool] = None use_auth_token: typing.Union[bool, str, NoneType] = None )
Parameters
-
filter (ModelFilter or
str
orIterable
, optional) — A string or ModelFilter which can be used to identify models on the Hub. -
author (
str
, optional) — A string which identify the author (user or organization) of the returned models -
search (
str
, optional) — A string that will be contained in the returned models Example usage: -
emissions_thresholds (
Tuple
, optional) — A tuple of two ints or floats representing a minimum and maximum carbon footprint to filter the resulting models with in grams. -
sort (
Literal["lastModified"]
orstr
, optional) — The key with which to sort the resulting models. Possible values are the properties of the huggingface_hub.hf_api.ModelInfo class. -
direction (
Literal[-1]
orint
, optional) — Direction in which to sort. The value-1
sorts by descending order while all other values sort by ascending order. -
limit (
int
, optional) — The limit on the number of models fetched. Leaving this option toNone
fetches all models. -
full (
bool
, optional) — Whether to fetch all model data, including thelastModified
, thesha
, the files and thetags
. This is set toTrue
by default when using a filter. -
cardData (
bool
, optional) — Whether to grab the metadata for the model as well. Can contain useful information such as carbon emissions, metrics, and datasets trained on. -
fetch_config (
bool
, optional) — Whether to fetch the model configs as well. This is not included infull
due to its size. -
use_auth_token (
bool
orstr
, optional) — Whether to use theauth_token
provided from thehuggingface_hub
cli. If not logged in, a validauth_token
can be passed in as a string.
Get the public list of all the models on huggingface.co
Returns: List of huggingface_hub.hf_api.ModelInfo objects
Example usage with the filter
argument:
>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> # List all models
>>> api.list_models()
>>> # Get all valid search arguments
>>> args = ModelSearchArguments()
>>> # List only the text classification models
>>> api.list_models(filter="text-classification")
>>> # Using the `ModelFilter`
>>> filt = ModelFilter(task="text-classification")
>>> # With `ModelSearchArguments`
>>> filt = ModelFilter(task=args.pipeline_tags.TextClassification)
>>> api.list_models(filter=filt)
>>> # Using `ModelFilter` and `ModelSearchArguments` to find text classification in both PyTorch and TensorFlow
>>> filt = ModelFilter(
... task=args.pipeline_tags.TextClassification,
... library=[args.library.PyTorch, args.library.TensorFlow],
... )
>>> api.list_models(filter=filt)
>>> # List only models from the AllenNLP library
>>> api.list_models(filter="allennlp")
>>> # Using `ModelFilter` and `ModelSearchArguments`
>>> filt = ModelFilter(library=args.library.allennlp)
list_repo_files
< source >(
repo_id: str
revision: typing.Optional[str] = None
repo_type: typing.Optional[str] = None
token: typing.Optional[str] = None
timeout: typing.Optional[float] = None
)
→
List[str]
Parameters
-
repo_id (
str
) — A namespace (user or an organization) and a repo name separated by a/
. -
revision (
str
, optional) — The revision of the model repository from which to get the information. -
repo_type (
str
, optional) — Set to"dataset"
or"space"
if uploading to a dataset or space,None
or"model"
if uploading to a model. Default isNone
. -
token (
str
, optional) — An authentication token (See https://huggingface.co/settings/token) -
timeout (
float
, optional) — Whether to set a timeout for the request to the Hub.
Returns
List[str]
the list of files in a given repository.
Get the list of files in a given repo.
list_spaces
< source >(
filter: typing.Union[str, typing.Iterable[str], NoneType] = None
author: typing.Optional[str] = None
search: typing.Optional[str] = None
sort: typing.Union[typing.Literal['lastModified'], str, NoneType] = None
direction: typing.Optional[typing.Literal[-1]] = None
limit: typing.Optional[int] = None
datasets: typing.Union[str, typing.Iterable[str], NoneType] = None
models: typing.Union[str, typing.Iterable[str], NoneType] = None
linked: typing.Optional[bool] = None
full: typing.Optional[bool] = None
use_auth_token: typing.Optional[str] = None
)
→
List[SpaceInfo]
Parameters
-
filter
str
orIterable
, optional) — A string tag or list of tags that can be used to identify Spaces on the Hub. -
author (
str
, optional) — A string which identify the author of the returned Spaces. -
search (
str
, optional) — A string that will be contained in the returned Spaces. -
sort (
Literal["lastModified"]
orstr
, optional) — The key with which to sort the resulting Spaces. Possible values are the properties of the huggingface_hub.hf_api.SpaceInfo` class. -
direction (
Literal[-1]
orint
, optional) — Direction in which to sort. The value-1
sorts by descending order while all other values sort by ascending order. -
limit (
int
, optional) — The limit on the number of Spaces fetched. Leaving this option toNone
fetches all Spaces. -
datasets (
str
orIterable
, optional) — Whether to return Spaces that make use of a dataset. The name of a specific dataset can be passed as a string. -
models (
str
orIterable
, optional) — Whether to return Spaces that make use of a model. The name of a specific model can be passed as a string. -
linked (
bool
, optional) — Whether to return Spaces that make use of either a model or a dataset. -
full (
bool
, optional) — Whether to fetch all Spaces data, including thelastModified
and thecardData
. -
use_auth_token (
bool
orstr
, optional) — Whether to use theauth_token
provided from thehuggingface_hub
cli. If not logged in, a validauth_token
can be passed in as a string.
Returns
List[SpaceInfo]
a list of huggingface_hub.hf_api.SpaceInfo objects
Get the public list of all Spaces on huggingface.co
merge_pull_request
< source >( repo_id: str discussion_num: int token: str comment: typing.Optional[str] = None repo_type: typing.Optional[str] = None ) → DiscussionStatusChange
Parameters
-
repo_id (
str
) — A namespace (user or an organization) and a repo name separated by a/
. -
discussion_num (
int
) — The number of the Discussion or Pull Request . Must be a strictly positive integer. -
comment (
str
, optional) — An optional comment to post with the status change. -
repo_type (
str
, optional) — Set to"dataset"
or"space"
if uploading to a dataset or space,None
or"model"
if uploading to a model. Default isNone
. -
token (
str
, optional) — An authentication token (See https://huggingface.co/settings/token)
Returns
the status change event
Merges a Pull Request.
Raises the following errors:
HTTPError
if the HuggingFace API returned an errorValueError
if some parameter value is invalid- RepositoryNotFoundError
If the repository to download from cannot be found. This may be because it doesn’t exist,
or because it is set to
private
and you do not have access.
model_info
< source >( repo_id: str revision: typing.Optional[str] = None token: typing.Optional[str] = None timeout: typing.Optional[float] = None securityStatus: typing.Optional[bool] = None files_metadata: bool = False ) → huggingface_hub.hf_api.ModelInfo
Parameters
-
repo_id (
str
) — A namespace (user or an organization) and a repo name separated by a/
. -
revision (
str
, optional) — The revision of the model repository from which to get the information. -
token (
str
, optional) — An authentication token (See https://huggingface.co/settings/token) -
timeout (
float
, optional) — Whether to set a timeout for the request to the Hub. -
securityStatus (
bool
, optional) — Whether to retrieve the security status from the model repository as well. -
files_metadata (
bool
, optional) — Whether or not to retrieve metadata for files in the repository (size, LFS metadata, etc). Defaults toFalse
.
Returns
The model repository information.
Get info on one specific model on huggingface.co
Model can be private if you pass an acceptable token or are logged in.
Raises the following errors:
- RepositoryNotFoundError
If the repository to download from cannot be found. This may be because it doesn’t exist,
or because it is set to
private
and you do not have access. - RevisionNotFoundError If the revision to download from cannot be found.
move_repo
< source >( from_id: str to_id: str repo_type: typing.Optional[str] = None token: typing.Optional[str] = None )
Parameters
-
from_id (
str
) — A namespace (user or an organization) and a repo name separated by a/
. Original repository identifier. -
to_id (
str
) — A namespace (user or an organization) and a repo name separated by a/
. Final repository identifier. -
repo_type (
str
, optional) — Set to"dataset"
or"space"
if uploading to a dataset or space,None
or"model"
if uploading to a model. Default isNone
. -
token (
str
, optional) — An authentication token (See https://huggingface.co/settings/token)
Moving a repository from namespace1/repo_name1 to namespace2/repo_name2
Note there are certain limitations. For more information about moving repositories, please see https://hf.co/docs/hub/main#how-can-i-rename-or-transfer-a-repo.
Raises the following errors:
- RepositoryNotFoundError
If the repository to download from cannot be found. This may be because it doesn’t exist,
or because it is set to
private
and you do not have access.
rename_discussion
< source >( repo_id: str discussion_num: int new_title: str token: typing.Optional[str] = None repo_type: typing.Optional[str] = None ) → DiscussionTitleChange
Parameters
-
repo_id (
str
) — A namespace (user or an organization) and a repo name separated by a/
. -
discussion_num (
int
) — The number of the Discussion or Pull Request . Must be a strictly positive integer. -
new_title (
str
) — The new title for the discussion -
repo_type (
str
, optional) — Set to"dataset"
or"space"
if uploading to a dataset or space,None
or"model"
if uploading to a model. Default isNone
. -
token (
str
, optional) — An authentication token (See https://huggingface.co/settings/token)
Returns
the title change event
Renames a Discussion.
Examples:
>>> new_title = "New title, fixing a typo"
>>> HfApi().rename_discussion(
... repo_id="username/repo_name",
... discussion_num=34
... new_title=new_title
... )
# DiscussionTitleChange(id='deadbeef0000000', type='title-change', ...)
Raises the following errors:
HTTPError
if the HuggingFace API returned an errorValueError
if some parameter value is invalid- RepositoryNotFoundError
If the repository to download from cannot be found. This may be because it doesn’t exist,
or because it is set to
private
and you do not have access.
repo_info
< source >(
repo_id: str
revision: typing.Optional[str] = None
repo_type: typing.Optional[str] = None
token: typing.Optional[str] = None
timeout: typing.Optional[float] = None
files_metadata: bool = False
)
→
Union[SpaceInfo, DatasetInfo, ModelInfo]
Parameters
-
repo_id (
str
) — A namespace (user or an organization) and a repo name separated by a/
. -
revision (
str
, optional) — The revision of the repository from which to get the information. -
token (
str
, optional) — An authentication token (See https://huggingface.co/settings/token) -
timeout (
float
, optional) — Whether to set a timeout for the request to the Hub. -
files_metadata (
bool
, optional) — Whether or not to retrieve metadata for files in the repository (size, LFS metadata, etc). Defaults toFalse
.
Returns
Union[SpaceInfo, DatasetInfo, ModelInfo]
The repository information, as a huggingface_hub.hf_api.DatasetInfo, huggingface_hub.hf_api.ModelInfo or huggingface_hub.hf_api.SpaceInfo object.
Get the info object for a given repo of a given type.
Raises the following errors:
- RepositoryNotFoundError
If the repository to download from cannot be found. This may be because it doesn’t exist,
or because it is set to
private
and you do not have access. - RevisionNotFoundError If the revision to download from cannot be found.
set_access_token
< source >( access_token: str )
Saves the passed access token so git can correctly authenticate the user.
space_info
< source >( repo_id: str revision: typing.Optional[str] = None token: typing.Optional[str] = None timeout: typing.Optional[float] = None files_metadata: bool = False ) → huggingface_hub.hf_api.SpaceInfo
Parameters
-
repo_id (
str
) — A namespace (user or an organization) and a repo name separated by a/
. -
revision (
str
, optional) — The revision of the space repository from which to get the information. -
token (
str
, optional) — An authentication token (See https://huggingface.co/settings/token) -
timeout (
float
, optional) — Whether to set a timeout for the request to the Hub. -
files_metadata (
bool
, optional) — Whether or not to retrieve metadata for files in the repository (size, LFS metadata, etc). Defaults toFalse
.
Returns
The space repository information.
Get info on one specific Space on huggingface.co.
Space can be private if you pass an acceptable token.
Raises the following errors:
- RepositoryNotFoundError
If the repository to download from cannot be found. This may be because it doesn’t exist,
or because it is set to
private
and you do not have access. - RevisionNotFoundError If the revision to download from cannot be found.
Resets the user’s access token.
update_repo_visibility
< source >( repo_id: str = None private: bool = False token: typing.Optional[str] = None organization: typing.Optional[str] = None repo_type: typing.Optional[str] = None name: str = None )
Parameters
-
repo_id (
str
, optional) — A namespace (user or an organization) and a repo name separated by a/
.Version added: 0.5
-
private (
bool
, optional, defaults toFalse
) — Whether the model repo should be private. -
token (
str
, optional) — An authentication token (See https://huggingface.co/settings/token) -
repo_type (
str
, optional) — Set to"dataset"
or"space"
if uploading to a dataset or space,None
or"model"
if uploading to a model. Default isNone
.
Update the visibility setting of a repository.
Raises the following errors:
- RepositoryNotFoundError
If the repository to download from cannot be found. This may be because it doesn’t exist,
or because it is set to
private
and you do not have access.
upload_file
< source >(
path_or_fileobj: typing.Union[str, bytes, typing.BinaryIO]
path_in_repo: str
repo_id: str
token: typing.Optional[str] = None
repo_type: typing.Optional[str] = None
revision: typing.Optional[str] = None
identical_ok: typing.Optional[bool] = None
commit_message: typing.Optional[str] = None
commit_description: typing.Optional[str] = None
create_pr: typing.Optional[bool] = None
parent_commit: typing.Optional[str] = None
)
→
str
Parameters
-
path_or_fileobj (
str
,bytes
, orIO
) — Path to a file on the local machine or binary data stream / fileobj / buffer. -
path_in_repo (
str
) — Relative filepath in the repo, for example:"checkpoints/1fec34a/weights.bin"
-
repo_id (
str
) — The repository to which the file will be uploaded, for example:"username/custom_transformers"
-
token (
str
, optional) — Authentication token, obtained withHfApi.login
method. Will default to the stored token. -
repo_type (
str
, optional) — Set to"dataset"
or"space"
if uploading to a dataset or space,None
or"model"
if uploading to a model. Default isNone
. -
revision (
str
, optional) — The git revision to commit from. Defaults to the head of the"main"
branch. -
identical_ok (
bool
, optional, defaults toTrue
) — Deprecated: will be removed in 0.11.0. Changing this value has no effect. -
commit_message (
str
, optional) — The summary / title / first line of the generated commit -
commit_description (
str
optional) — The description of the generated commit -
create_pr (
boolean
, optional) — Whether or not to create a Pull Request fromrevision
with that commit. Defaults toFalse
. -
parent_commit (
str
, optional) — The OID / SHA of the parent commit, as a hexadecimal string. Shorthands (7 first characters) are also supported. If specified andcreate_pr
isFalse
, the commit will fail ifrevision
does not point toparent_commit
. If specified andcreate_pr
isTrue
, the pull request will be created fromparent_commit
. Specifyingparent_commit
ensures the repo has not changed before committing the changes, and can be especially useful if the repo is updated / committed to concurrently.
Returns
str
The URL to visualize the uploaded file on the hub
Upload a local file (up to 50 GB) to the given repo. The upload is done through a HTTP post request, and doesn’t require git or git-lfs to be installed.
Raises the following errors:
HTTPError
if the HuggingFace API returned an errorValueError
if some parameter value is invalid- RepositoryNotFoundError
If the repository to download from cannot be found. This may be because it doesn’t exist,
or because it is set to
private
and you do not have access. - RevisionNotFoundError If the revision to download from cannot be found.
Example usage:
>>> from huggingface_hub import upload_file
>>> with open("./local/filepath", "rb") as fobj:
... upload_file(
... path_or_fileobj=fileobj,
... path_in_repo="remote/file/path.h5",
... repo_id="username/my-dataset",
... repo_type="datasets",
... token="my_token",
... )
"https://huggingface.co/datasets/username/my-dataset/blob/main/remote/file/path.h5"
>>> upload_file(
... path_or_fileobj=".\\local\\file\\path",
... path_in_repo="remote/file/path.h5",
... repo_id="username/my-model",
... token="my_token",
... )
"https://huggingface.co/username/my-model/blob/main/remote/file/path.h5"
>>> upload_file(
... path_or_fileobj=".\\local\\file\\path",
... path_in_repo="remote/file/path.h5",
... repo_id="username/my-model",
... token="my_token",
... create_pr=True,
... )
"https://huggingface.co/username/my-model/blob/refs%2Fpr%2F1/remote/file/path.h5"
upload_folder
< source >(
repo_id: str
folder_path: str
path_in_repo: typing.Optional[str] = None
commit_message: typing.Optional[str] = None
commit_description: typing.Optional[str] = None
token: typing.Optional[str] = None
repo_type: typing.Optional[str] = None
revision: typing.Optional[str] = None
create_pr: typing.Optional[bool] = None
parent_commit: typing.Optional[str] = None
allow_patterns: typing.Union[typing.List[str], str, NoneType] = None
ignore_patterns: typing.Union[typing.List[str], str, NoneType] = None
)
→
str
Parameters
-
repo_id (
str
) — The repository to which the file will be uploaded, for example:"username/custom_transformers"
-
folder_path (
str
) — Path to the folder to upload on the local file system -
path_in_repo (
str
, optional) — Relative path of the directory in the repo, for example:"checkpoints/1fec34a/results"
. Will default to the root folder of the repository. -
token (
str
, optional) — Authentication token, obtained withHfApi.login
method. Will default to the stored token. -
repo_type (
str
, optional) — Set to"dataset"
or"space"
if uploading to a dataset or space,None
or"model"
if uploading to a model. Default isNone
. -
revision (
str
, optional) — The git revision to commit from. Defaults to the head of the"main"
branch. -
commit_message (
str
, optional) — The summary / title / first line of the generated commit. Defaults to:f"Upload {path_in_repo} with huggingface_hub"
-
commit_description (
str
optional) — The description of the generated commit -
create_pr (
boolean
, optional) — Whether or not to create a Pull Request from the pushed changes. Defaults toFalse
. -
parent_commit (
str
, optional) — The OID / SHA of the parent commit, as a hexadecimal string. Shorthands (7 first characters) are also supported. If specified andcreate_pr
isFalse
, the commit will fail ifrevision
does not point toparent_commit
. If specified andcreate_pr
isTrue
, the pull request will be created fromparent_commit
. Specifyingparent_commit
ensures the repo has not changed before committing the changes, and can be especially useful if the repo is updated / committed to concurrently. -
allow_patterns (
List[str]
orstr
, optional) — If provided, only files matching at least one pattern are uploaded. -
ignore_patterns (
List[str]
orstr
, optional) — If provided, files matching any of the patterns are not uploaded.
Returns
str
A URL to visualize the uploaded folder on the hub
Upload a local folder to the given repo. The upload is done through a HTTP requests, and doesn’t require git or git-lfs to be installed.
The structure of the folder will be preserved. Files with the same name already present in the repository will be overwritten, others will be left untouched.
Use the allow_patterns
and ignore_patterns
arguments to specify which files
to upload. These parameters accept either a single pattern or a list of
patterns. Patterns are Standard Wildcards (globbing patterns) as documented
here. If both
allow_patterns
and ignore_patterns
are provided, both constraints apply. By
default, all files from the folder are uploaded.
Uses HfApi.create_commit
under the hood.
Raises the following errors:
HTTPError
if the HuggingFace API returned an errorValueError
if some parameter value is invalid
Example usage:
>>> upload_folder(
... folder_path="local/checkpoints",
... path_in_repo="remote/experiment/checkpoints",
... repo_id="username/my-dataset",
... repo_type="datasets",
... token="my_token",
... ignore_patterns="**/logs/*.txt",
... )
# "https://huggingface.co/datasets/username/my-dataset/tree/main/remote/experiment/checkpoints"
>>> upload_folder(
... folder_path="local/checkpoints",
... path_in_repo="remote/experiment/checkpoints",
... repo_id="username/my-dataset",
... repo_type="datasets",
... token="my_token",
... create_pr=True,
... )
# "https://huggingface.co/datasets/username/my-dataset/tree/refs%2Fpr%2F1/remote/experiment/checkpoints"
whoami
< source >( token: typing.Optional[str] = None )
Call HF API to know “whoami”.
class huggingface_hub.hf_api.ModelInfo
< source >( modelId: typing.Optional[str] = None sha: typing.Optional[str] = None lastModified: typing.Optional[str] = None tags: typing.Optional[typing.List[str]] = None pipeline_tag: typing.Optional[str] = None siblings: typing.Optional[typing.List[typing.Dict]] = None private: typing.Optional[bool] = None author: typing.Optional[str] = None config: typing.Optional[typing.Dict] = None **kwargs )
Parameters
-
modelId (
str
, optional) — ID of model repository. -
sha (
str
, optional) — repo sha at this particular revision -
lastModified (
str
, optional) — date of last commit to repo -
tags (
Listr[str]
, optional) — List of tags. -
pipeline_tag (
str
, optional) — Pipeline tag to identify the correct widget. -
siblings (
List[RepoFile]
, optional) — list of (huggingface_hub.hf_api.RepoFile) objects that constitute the model. -
private (
bool
, optional) — is the repo private -
author (
str
, optional) — repo author -
config (
Dict
, optional) — Model configuration information -
kwargs (
Dict
, optional) — Kwargs that will be become attributes of the class.
Info about a model accessible from huggingface.co
class huggingface_hub.hf_api.DatasetInfo
< source >( id: typing.Optional[str] = None sha: typing.Optional[str] = None lastModified: typing.Optional[str] = None tags: typing.Optional[typing.List[str]] = None siblings: typing.Optional[typing.List[typing.Dict]] = None private: typing.Optional[bool] = None author: typing.Optional[str] = None description: typing.Optional[str] = None citation: typing.Optional[str] = None cardData: typing.Optional[dict] = None **kwargs )
Parameters
-
id (
str
, optional) — ID of dataset repository. -
sha (
str
, optional) — repo sha at this particular revision -
lastModified (
str
, optional) — date of last commit to repo -
tags (
Listr[str]
, optional) — List of tags. -
siblings (
List[RepoFile]
, optional) — list of huggingface_hub.hf_api.RepoFile objects that constitute the dataset. -
private (
bool
, optional) — is the repo private -
author (
str
, optional) — repo author -
description (
str
, optional) — Description of the dataset -
citation (
str
, optional) — Dataset citation -
cardData (
Dict
, optional) — Metadata of the model card as a dictionary. -
kwargs (
Dict
, optional) — Kwargs that will be become attributes of the class.
Info about a dataset accessible from huggingface.co
class huggingface_hub.hf_api.SpaceInfo
< source >( id: typing.Optional[str] = None sha: typing.Optional[str] = None lastModified: typing.Optional[str] = None siblings: typing.Optional[typing.List[typing.Dict]] = None private: typing.Optional[bool] = None author: typing.Optional[str] = None **kwargs )
Parameters
-
id (
str
, optional) — id of space -
sha (
str
, optional) — repo sha at this particular revision -
lastModified (
str
, optional) — date of last commit to repo -
siblings (
List[RepoFile]
, optional) — list ofhuggingface_hub.hf_api.RepoFIle
objects that constitute the Space -
private (
bool
, optional) — is the repo private -
author (
str
, optional) — repo author -
kwargs (
Dict
, optional) — Kwargs that will be become attributes of the class.
Info about a Space accessible from huggingface.co
This is a “dataclass” like container that just sets on itself any attribute passed by the server.
class huggingface_hub.hf_api.RepoFile
< source >( rfilename: str size: typing.Optional[int] = None blobId: typing.Optional[str] = None lfs: typing.Optional[huggingface_hub.hf_api.BlobLfsInfo] = None **kwargs )
Parameters
- rfilename (str) — file name, relative to the repo root. This is the only attribute that’s guaranteed to be here, but under certain conditions there can certain other stuff.
-
size (
int
, optional) — The file’s size, in bytes. This attribute is present whenfiles_metadata
argument ofrepo_info
is set toTrue
. It’sNone
otherwise. -
blob_id (
str
, optional) — The file’s git OID. This attribute is present whenfiles_metadata
argument ofrepo_info
is set toTrue
. It’sNone
otherwise. -
lfs (
BlobLfsInfo
, optional) — The file’s LFS metadata. This attribute is present whenfiles_metadata
argument ofrepo_info
is set toTrue
and the file is stored with Git LFS. It’sNone
otherwise.
Data structure that represents a public file inside a repo, accessible from huggingface.co
create_commit
API
Below are the supported values for CommitOperation()
:
class huggingface_hub.CommitOperationAdd
< source >( path_in_repo: str path_or_fileobj: typing.Union[str, bytes, typing.BinaryIO] )
Parameters
-
path_in_repo (
str
) — Relative filepath in the repo, for example:"checkpoints/1fec34a/weights.bin"
-
path_or_fileobj (
str
,bytes
, orBinaryIO
) — Either:- a path to a local file (as str) to upload
- a buffer of bytes (
bytes
) holding the content of the file to upload - a “file object” (subclass of
io.BufferedIOBase
), typically obtained withopen(path, "rb")
. It must supportseek()
andtell()
methods.
Data structure holding necessary info to upload a file to a repository on the Hub
A context manager that yields a file-like object allowing to read the underlying
data behind path_or_fileobj
.
Triggers self.validate
.
Raises: ValueError
if self.validate fails
Example:
>>> operation = CommitOperationAdd(
... path_in_repo="remote/dir/weights.h5",
... path_or_fileobj="./local/weights.h5",
... )
CommitOperationAdd(path_in_repo='remote/dir/weights.h5', path_or_fileobj='./local/weights.h5', _upload_info=None)
>>> with operation.as_file() as file:
... content = file.read()
Ensures path_or_fileobj
is valid:
- Ensures it is either a
str
,bytes
or an instance ofio.BufferedIOBase
- If it is a
str
, ensure that it is a file path and that the file exists - If it is an instance of
io.BufferedIOBase
, ensures it supportsseek()
andtell()
Raises: ValueError
if path_or_fileobj
is not valid
class huggingface_hub.CommitOperationDelete
< source >( path_in_repo: str )
Data structure holding necessary info to delete a file from a repository on the Hub
Hugging Face local storage
huggingface_hub
stores the authentication information locally so that it may be re-used in subsequent
methods.
It does this using the HfFolder utility, which saves data at the root of the user.
Deletes the token from storage. Does not fail if token does not exist.
Get token or None if not existent.
Note that a token can be also provided using the
HUGGING_FACE_HUB_TOKEN
environment variable.
Save token, creating folder as needed.
Filtering helpers
Some helpers to filter repositories on the Hub are available in the huggingface_hub
package.
class huggingface_hub.DatasetFilter
< source >( author: str = None benchmark: typing.Union[str, typing.List[str]] = None dataset_name: str = None language_creators: typing.Union[str, typing.List[str]] = None languages: typing.Union[str, typing.List[str]] = None multilinguality: typing.Union[str, typing.List[str]] = None size_categories: typing.Union[str, typing.List[str]] = None task_categories: typing.Union[str, typing.List[str]] = None task_ids: typing.Union[str, typing.List[str]] = None )
Parameters
-
author (
str
, optional) — A string or list of strings that can be used to identify datasets on the Hub by the original uploader (author or organization), such asfacebook
orhuggingface
. -
benchmark (
str
orList
, optional) — A string or list of strings that can be used to identify datasets on the Hub by their official benchmark. -
dataset_name (
str
, optional) — A string or list of strings that can be used to identify datasets on the Hub by its name, such asSQAC
orwikineural
-
language_creators (
str
orList
, optional) — A string or list of strings that can be used to identify datasets on the Hub with how the data was curated, such ascrowdsourced
ormachine_generated
. -
languages (
str
orList
, optional) — A string or list of strings representing a two-character language to filter datasets by on the Hub. -
multilinguality (
str
orList
, optional) — A string or list of strings representing a filter for datasets that contain multiple languages. -
size_categories (
str
orList
, optional) — A string or list of strings that can be used to identify datasets on the Hub by the size of the dataset such as100K<n<1M
or1M<n<10M
. -
task_categories (
str
orList
, optional) — A string or list of strings that can be used to identify datasets on the Hub by the designed task, such asaudio_classification
ornamed_entity_recognition
. -
task_ids (
str
orList
, optional) — A string or list of strings that can be used to identify datasets on the Hub by the specific task such asspeech_emotion_recognition
orparaphrase
.
A class that converts human-readable dataset search parameters into ones compatible with the REST API. For all parameters capitalization does not matter.
Examples:
>>> from huggingface_hub import DatasetFilter
>>> # Using author
>>> new_filter = DatasetFilter(author="facebook")
>>> # Using benchmark
>>> new_filter = DatasetFilter(benchmark="raft")
>>> # Using dataset_name
>>> new_filter = DatasetFilter(dataset_name="wikineural")
>>> # Using language_creator
>>> new_filter = DatasetFilter(language_creator="crowdsourced")
>>> # Using language
>>> new_filter = DatasetFilter(language="en")
>>> # Using multilinguality
>>> new_filter = DatasetFilter(multilinguality="multilingual")
>>> # Using size_categories
>>> new_filter = DatasetFilter(size_categories="100K<n<1M")
>>> # Using task_categories
>>> new_filter = DatasetFilter(task_categories="audio_classification")
>>> # Using task_ids
>>> new_filter = DatasetFilter(task_ids="paraphrase")
class huggingface_hub.ModelFilter
< source >( author: str = None library: typing.Union[str, typing.List[str]] = None language: typing.Union[str, typing.List[str]] = None model_name: str = None task: typing.Union[str, typing.List[str]] = None trained_dataset: typing.Union[str, typing.List[str]] = None tags: typing.Union[str, typing.List[str]] = None )
Parameters
-
author (
str
, optional) — A string that can be used to identify models on the Hub by the original uploader (author or organization), such asfacebook
orhuggingface
. -
library (
str
orList
, optional) — A string or list of strings of foundational libraries models were originally trained from, such as pytorch, tensorflow, or allennlp. -
language (
str
orList
, optional) — A string or list of strings of languages, both by name and country code, such as “en” or “English” -
model_name (
str
, optional) — A string that contain complete or partial names for models on the Hub, such as “bert” or “bert-base-cased” -
task (
str
orList
, optional) — A string or list of strings of tasks models were designed for, such as: “fill-mask” or “automatic-speech-recognition” -
tags (
str
orList
, optional) — A string tag or a list of tags to filter models on the Hub by, such astext-generation
orspacy
. -
trained_dataset (
str
orList
, optional) — A string tag or a list of string tags of the trained dataset for a model on the Hub.
A class that converts human-readable model search parameters into ones compatible with the REST API. For all parameters capitalization does not matter.
>>> from huggingface_hub import ModelFilter
>>> # For the author_or_organization
>>> new_filter = ModelFilter(author_or_organization="facebook")
>>> # For the library
>>> new_filter = ModelFilter(library="pytorch")
>>> # For the language
>>> new_filter = ModelFilter(language="french")
>>> # For the model_name
>>> new_filter = ModelFilter(model_name="bert")
>>> # For the task
>>> new_filter = ModelFilter(task="text-classification")
>>> # Retrieving tags using the `HfApi.get_model_tags` method
>>> from huggingface_hub import HfApi
>>> api = HfApi()
# To list model tags
>>> api.get_model_tags()
# To list dataset tags
>>> api.get_dataset_tags()
>>> new_filter = ModelFilter(tags="benchmark:raft")
>>> # Related to the dataset
>>> new_filter = ModelFilter(trained_dataset="common_voice")
A nested namespace object holding all possible values for properties of datasets currently hosted in the Hub with tab-completion. If a value starts with a number, it will only exist in the dictionary
A nested namespace object holding all possible values for properties of models currently hosted in the Hub with tab-completion. If a value starts with a number, it will only exist in the dictionary