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 configure the client. In particular, a
token can be passed to be authenticated in all API calls. This is different than
huggingface-cli login
or login() as the token is not persisted on the machine. One
can also specify a different endpoint than the Hugging Face’s Hub (for example to interact
with a Private Hub).
from huggingface_hub import HfApi
hf_api = HfApi(
endpoint="https://huggingface.co", # Can be a Private Hub endpoint.
token="hf_xxx", # Token is not persisted on the machine.
)
( endpoint: typing.Optional[str] = None token: typing.Optional[str] = None library_name: typing.Optional[str] = None library_version: typing.Optional[str] = None user_agent: typing.Union[typing.Dict, str, NoneType] = None )
( 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
str
) —
A namespace (user or an organization) and a repo name separated
by a /
.
int
) —
The number of the Discussion or Pull Request . Must be a strictly positive integer.
str
) —
The new status for the discussion, either "open"
or "closed"
.
str
, optional) —
An optional comment to post with the status change.
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
.
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 invalidprivate
and you do not have access.( repo_id: str discussion_num: int comment: str token: typing.Optional[str] = None repo_type: typing.Optional[str] = None ) → DiscussionComment
Parameters
str
) —
A namespace (user or an organization) and a repo name separated
by a /
.
int
) —
The number of the Discussion or Pull Request . Must be a strictly positive integer.
str
) —
The content of the comment to create. Comments support markdown formatting.
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
.
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 invalidprivate
and you do not have access.( repo_id: str branch: str token: typing.Optional[str] = None repo_type: typing.Optional[str] = None exist_ok: bool = False )
Parameters
str
) —
The repository in which the branch will be created.
Example: "user/my-cool-model"
.
str
) —
The name of the branch to create.
str
, optional) —
Authentication token. Will default to the stored token.
str
, optional) —
Set to "dataset"
or "space"
if creating a branch on a dataset or
space, None
or "model"
if tagging a model. Default is None
.
bool
, optional, defaults to False
) —
If True
, do not raise an error if branch already exists.
Raises
RepositoryNotFoundError or BadRequestError or HfHubHTTPError
refs/pr/5
or ‘refs/foo/bar’.exist_ok
is
set to False
.Create a new branch from main
on a repo on the Hub.
( 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 ) → CommitInfo
Parameters
str
) —
The repository in which the commit will be created, for example:
"username/custom_transformers"
Iterable
of CommitOperation()
) —
An iterable of operations to include in the commit, either:
str
) —
The summary (first line) of the commit that will be created.
str
, optional) —
The description of the commit that will be created
str
, optional) —
Authentication token, obtained with HfApi.login
method. Will
default to the stored token.
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
.
str
, optional) —
The git revision to commit from. Defaults to the head of the "main"
branch.
boolean
, optional) —
Whether or not to create a Pull Request with that commit. Defaults to False
.
If revision
is not set, PR is opened against the "main"
branch. If
revision
is set and is a branch, PR is opened against this branch. If
revision
is set and is not a branch name (example: a commit oid), an
RevisionNotFoundError
is returned by the server.
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.
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
Instance of CommitInfo containing information about the newly created commit (commit hash, commit url, pr url, commit message,…).
Raises
ValueError
or RepositoryNotFoundError
ValueError
—
If commit message is empty.ValueError
—
If parent commit is not a valid commit OID.ValueError
—
If the Hub API returns an HTTP 400 error (bad request)ValueError
—
If create_pr
is True
and revision is neither None
nor "main"
.Creates a commit in the given repo, deleting & uploading files as needed.
create_commit
assumes that the repo already exists on the Hub. If you get a
Client error 404, please make sure you are authenticated and that repo_id
and
repo_type
are set correctly. If repo does not exist, create it first using
create_repo().
create_commit
is limited to 25k LFS files and a 1GB payload for regular files.
( repo_id: str title: str token: typing.Optional[str] = None description: typing.Optional[str] = None repo_type: typing.Optional[str] = None pull_request: bool = False )
Parameters
str
) —
A namespace (user or an organization) and a repo name separated
by a /
.
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.
str
, optional) —
An authentication token (See https://huggingface.co/settings/token)
str
, optional) —
An optional description for the Pull Request.
Defaults to "Discussion opened with the huggingface_hub Python library"
bool
, optional) —
Whether to create a Pull Request or discussion. If True
, creates a Pull Request.
If False
, creates a discussion. Defaults to False
.
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
.
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 invalidprivate
and you do not have access.( repo_id: str title: str token: typing.Optional[str] = None description: typing.Optional[str] = None repo_type: typing.Optional[str] = None )
Parameters
str
) —
A namespace (user or an organization) and a repo name separated
by a /
.
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.
str
, optional) —
An authentication token (See https://huggingface.co/settings/token)
str
, optional) —
An optional description for the Pull Request.
Defaults to "Discussion opened with the huggingface_hub Python library"
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
.
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 invalidprivate
and you do not have access.(
repo_id: str
token: typing.Optional[str] = None
private: bool = False
repo_type: typing.Optional[str] = None
exist_ok: bool = False
space_sdk: typing.Optional[str] = None
)
→
str
Parameters
str
) —
A namespace (user or an organization) and a repo name separated
by a /
.
str
, optional) —
An authentication token (See https://huggingface.co/settings/token)
bool
, optional, defaults to False
) —
Whether the model repo should be private.
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
.
bool
, optional, defaults to False
) —
If True
, do not raise an error if repo already exists.
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.
( repo_id: str tag: str tag_message: typing.Optional[str] = None revision: typing.Optional[str] = None token: typing.Optional[str] = None repo_type: typing.Optional[str] = None exist_ok: bool = False )
Parameters
str
) —
The repository in which a commit will be tagged.
Example: "user/my-cool-model"
.
str
) —
The name of the tag to create.
str
, optional) —
The description of the tag to create.
str
, optional) —
The git revision to tag. It can be a branch name or the OID/SHA of a
commit, as a hexadecimal string. Shorthands (7 first characters) are
also supported. Defaults to the head of the "main"
branch.
str
, optional) —
Authentication token. Will default to the stored token.
str
, optional) —
Set to "dataset"
or "space"
if tagging a dataset or
space, None
or "model"
if tagging a model. Default is
None
.
bool
, optional, defaults to False
) —
If True
, do not raise an error if tag already exists.
Raises
RepositoryNotFoundError or RevisionNotFoundError or HfHubHTTPError
exist_ok
is
set to False
.Tag a given commit of a repo on the Hub.
( repo_id: str revision: typing.Optional[str] = None timeout: typing.Optional[float] = None files_metadata: bool = False token: typing.Union[bool, str, NoneType] = None ) → hf_api.DatasetInfo
Parameters
str
) —
A namespace (user or an organization) and a repo name separated
by a /
.
str
, optional) —
The revision of the dataset repository from which to get the
information.
float
, optional) —
Whether to set a timeout for the request to the Hub.
bool
, optional) —
Whether or not to retrieve metadata for files in the repository
(size, LFS metadata, etc). Defaults to False
.
bool
or str
, optional) —
A valid authentication token (see https://huggingface.co/settings/token).
If None
or True
and machine is logged in (through huggingface-cli login
or login()), token will be retrieved from the cache.
If False
, token is not sent in the request header.
Returns
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:
private
and you do not have access.( repo_id: str branch: str token: typing.Optional[str] = None repo_type: typing.Optional[str] = None )
Parameters
str
) —
The repository in which a branch will be deleted.
Example: "user/my-cool-model"
.
str
) —
The name of the branch to delete.
str
, optional) —
Authentication token. Will default to the stored token.
str
, optional) —
Set to "dataset"
or "space"
if creating a branch on a dataset or
space, None
or "model"
if tagging a model. Default is None
.
Raises
main
cannot be deleted.Delete a branch from a repo on the Hub.
( 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
str
) —
Relative filepath in the repo, for example:
"checkpoints/1fec34a/weights.bin"
str
) —
The repository from which the file will be deleted, for example:
"username/custom_transformers"
str
, optional) —
Authentication token, obtained with HfApi.login
method. Will
default to the stored token.
str
, optional) —
Set to "dataset"
or "space"
if the file is in a dataset or
space, None
or "model"
if in a model. Default is None
.
str
, optional) —
The git revision to commit from. Defaults to the head of the "main"
branch.
str
, optional) —
The summary / title / first line of the generated commit. Defaults to
f"Delete {path_in_repo} with huggingface_hub"
.
str
optional) —
The description of the generated commit
boolean
, optional) —
Whether or not to create a Pull Request with that commit. Defaults to False
.
If revision
is not set, PR is opened against the "main"
branch. If
revision
is set and is a branch, PR is opened against this branch. If
revision
is set and is not a branch name (example: a commit oid), an
RevisionNotFoundError
is returned by the server.
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.
Deletes a file in the given repo.
Raises the following errors:
HTTPError
if the HuggingFace API returned an errorValueError
if some parameter value is invalidprivate
and you do not have access.( 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
str
) —
Relative folder path in the repo, for example: "checkpoints/1fec34a"
.
str
) —
The repository from which the folder will be deleted, for example:
"username/custom_transformers"
str
, optional) —
Authentication token, obtained with HfApi.login
method. Will default
to the stored token.
str
, optional) —
Set to "dataset"
or "space"
if the folder is in a dataset or
space, None
or "model"
if in a model. Default is None
.
str
, optional) —
The git revision to commit from. Defaults to the head of the "main"
branch.
str
, optional) —
The summary / title / first line of the generated commit. Defaults to
f"Delete folder {path_in_repo} with huggingface_hub"
.
str
optional) —
The description of the generated commit.
boolean
, optional) —
Whether or not to create a Pull Request with that commit. Defaults to False
.
If revision
is not set, PR is opened against the "main"
branch. If
revision
is set and is a branch, PR is opened against this branch. If
revision
is set and is not a branch name (example: a commit oid), an
RevisionNotFoundError
is returned by the server.
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.
Deletes a folder in the given repo.
Simple wrapper around create_commit() method.
( repo_id: str token: typing.Optional[str] = None repo_type: typing.Optional[str] = None )
Parameters
str
) —
A namespace (user or an organization) and a repo name separated
by a /
.
str
, optional) —
An authentication token (See https://huggingface.co/settings/token)
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:
private
and you do not have access.( repo_id: str tag: str token: typing.Optional[str] = None repo_type: typing.Optional[str] = None )
Parameters
str
) —
The repository in which a tag will be deleted.
Example: "user/my-cool-model"
.
str
) —
The name of the tag to delete.
str
, optional) —
Authentication token. Will default to the stored token.
str
, optional) —
Set to "dataset"
or "space"
if tagging a dataset or space, None
or
"model"
if tagging a model. Default is None
.
Raises
Delete a tag from a repo on the Hub.
( 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
str
) —
A namespace (user or an organization) and a repo name separated
by a /
.
int
) —
The number of the Discussion or Pull Request . Must be a strictly positive integer.
str
) —
The ID of the comment to edit.
str
) —
The new content of the comment. Comments support markdown formatting.
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
.
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 invalidprivate
and you do not have access.Gets all valid dataset tags as a nested namespace object.
( repo_id: str discussion_num: int repo_type: typing.Optional[str] = None token: typing.Optional[str] = None )
Parameters
str
) —
A namespace (user or an organization) and a repo name separated
by a /
.
int
) —
The number of the Discussion or Pull Request . Must be a strictly positive integer.
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
.
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 invalidprivate
and you do not have access.(
model_id: str
organization: typing.Optional[str] = None
token: typing.Union[bool, str, NoneType] = None
)
→
str
Parameters
str
) —
The name of the model.
str
, optional) —
If passed, the repository name will be in the organization
namespace instead of the user namespace.
bool
or str
, optional) —
A valid authentication token (see https://huggingface.co/settings/token).
If None
or True
and machine is logged in (through huggingface-cli login
or login()), token will be retrieved from the cache.
If False
, token is not sent in the request header.
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
(
repo_id: str
repo_type: typing.Optional[str] = None
token: typing.Optional[str] = None
)
→
Iterator[Discussion]
Parameters
str
) —
A namespace (user or an organization) and a repo name separated
by a /
.
str
, optional) —
Set to "dataset"
or "space"
if fetching from a dataset or
space, None
or "model"
if fetching from a model. Default is
None
.
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:
( repo_id: str discussion_num: int comment_id: str token: typing.Optional[str] = None repo_type: typing.Optional[str] = None ) → DiscussionComment
Parameters
str
) —
A namespace (user or an organization) and a repo name separated
by a /
.
int
) —
The number of the Discussion or Pull Request . Must be a strictly positive integer.
str
) —
The ID of the comment to edit.
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
.
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 invalidprivate
and you do not have access.(
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
token: typing.Optional[str] = None
)
→
List[DatasetInfo]
Parameters
str
or Iterable
, optional) —
A string or DatasetFilter which can be used to identify
datasets on the hub.
str
, optional) —
A string which identify the author of the returned datasets.
str
, optional) —
A string that will be contained in the returned datasets.
Literal["lastModified"]
or str
, optional) —
The key with which to sort the resulting datasets. Possible
values are the properties of the huggingface_hub.hf_api.DatasetInfo class.
Literal[-1]
or int
, optional) —
Direction in which to sort. The value -1
sorts by descending
order while all other values sort by ascending order.
int
, optional) —
The limit on the number of datasets fetched. Leaving this option
to None
fetches all datasets.
bool
, optional) —
Whether to fetch all dataset data, including the lastModified
and the cardData
. Can contain useful information such as the
PapersWithCode ID.
bool
or str
, optional) —
A valid authentication token (see https://huggingface.co/settings/token).
If None
or True
and machine is logged in (through huggingface-cli login
or login()), token will be retrieved from the cache.
If False
, token is not sent in the request header.
Returns
List[DatasetInfo]
a list of huggingface_hub.hf_api.DatasetInfo objects. To anticipate future pagination, please consider the return value to be a simple iterator.
Get the 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=("language:ru", "task_ids:language-modeling")
... )
>>> # Using the `DatasetFilter`
>>> filt = DatasetFilter(language="ru", task_ids="language-modeling")
>>> # With `DatasetSearchArguments`
>>> filt = DatasetFilter(
... language=args.language.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[MetricInfo]
Returns
List[MetricInfo]
a list of MetricInfo
objects which.
Get the public list of all the metrics on huggingface.co
(
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: bool = False
fetch_config: bool = False
token: typing.Union[bool, str, NoneType] = None
)
→
List[ModelInfo]
Parameters
str
or Iterable
, optional) —
A string or ModelFilter which can be used to identify models
on the Hub.
str
, optional) —
A string which identify the author (user or organization) of the
returned models
str
, optional) —
A string that will be contained in the returned models Example
usage:
Tuple
, optional) —
A tuple of two ints or floats representing a minimum and maximum
carbon footprint to filter the resulting models with in grams.
Literal["lastModified"]
or str
, optional) —
The key with which to sort the resulting models. Possible values
are the properties of the huggingface_hub.hf_api.ModelInfo class.
Literal[-1]
or int
, optional) —
Direction in which to sort. The value -1
sorts by descending
order while all other values sort by ascending order.
int
, optional) —
The limit on the number of models fetched. Leaving this option
to None
fetches all models.
bool
, optional) —
Whether to fetch all model data, including the lastModified
,
the sha
, the files and the tags
. This is set to True
by
default when using a filter.
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.
bool
, optional) —
Whether to fetch the model configs as well. This is not included
in full
due to its size.
bool
or str
, optional) —
A valid authentication token (see https://huggingface.co/settings/token).
If None
or True
and machine is logged in (through huggingface-cli login
or login()), token will be retrieved from the cache.
If False
, token is not sent in the request header.
Returns
List[ModelInfo]
a list of huggingface_hub.hf_api.ModelInfo objects. To anticipate future pagination, please consider the return value to be a simple iterator.
Get the list of all the models on huggingface.co
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)
(
repo_id: str
revision: typing.Optional[str] = None
repo_type: typing.Optional[str] = None
timeout: typing.Optional[float] = None
token: typing.Union[bool, str, NoneType] = None
)
→
List[str]
Parameters
str
) —
A namespace (user or an organization) and a repo name separated
by a /
.
str
, optional) —
The revision of the model repository from which to get the
information.
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
.
float
, optional) —
Whether to set a timeout for the request to the Hub.
bool
or str
, optional) —
A valid authentication token (see https://huggingface.co/settings/token).
If None
or True
and machine is logged in (through huggingface-cli login
or login()), token will be retrieved from the cache.
If False
, token is not sent in the request header.
Returns
List[str]
the list of files in a given repository.
Get the list of files in a given repo.
(
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: bool = False
full: typing.Optional[bool] = None
token: typing.Optional[str] = None
)
→
List[SpaceInfo]
Parameters
str
or Iterable
, optional) —
A string tag or list of tags that can be used to identify Spaces on the Hub.
str
, optional) —
A string which identify the author of the returned Spaces.
str
, optional) —
A string that will be contained in the returned Spaces.
Literal["lastModified"]
or str
, optional) —
The key with which to sort the resulting Spaces. Possible
values are the properties of the huggingface_hub.hf_api.SpaceInfo` class.
Literal[-1]
or int
, optional) —
Direction in which to sort. The value -1
sorts by descending
order while all other values sort by ascending order.
int
, optional) —
The limit on the number of Spaces fetched. Leaving this option
to None
fetches all Spaces.
str
or Iterable
, optional) —
Whether to return Spaces that make use of a dataset.
The name of a specific dataset can be passed as a string.
str
or Iterable
, optional) —
Whether to return Spaces that make use of a model.
The name of a specific model can be passed as a string.
bool
, optional) —
Whether to return Spaces that make use of either a model or a dataset.
bool
, optional) —
Whether to fetch all Spaces data, including the lastModified
and the cardData
.
bool
or str
, optional) —
A valid authentication token (see https://huggingface.co/settings/token).
If None
or True
and machine is logged in (through huggingface-cli login
or login()), token will be retrieved from the cache.
If False
, token is not sent in the request header.
Returns
List[SpaceInfo]
a list of huggingface_hub.hf_api.SpaceInfo objects. To anticipate future pagination, please consider the return value to be a simple iterator.
Get the public list of all Spaces on huggingface.co
( repo_id: str discussion_num: int token: typing.Optional[str] = None comment: typing.Optional[str] = None repo_type: typing.Optional[str] = None ) → DiscussionStatusChange
Parameters
str
) —
A namespace (user or an organization) and a repo name separated
by a /
.
int
) —
The number of the Discussion or Pull Request . Must be a strictly positive integer.
str
, optional) —
An optional comment to post with the status change.
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
.
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 invalidprivate
and you do not have access.( repo_id: str revision: typing.Optional[str] = None timeout: typing.Optional[float] = None securityStatus: typing.Optional[bool] = None files_metadata: bool = False token: typing.Union[bool, str, NoneType] = None ) → huggingface_hub.hf_api.ModelInfo
Parameters
str
) —
A namespace (user or an organization) and a repo name separated
by a /
.
str
, optional) —
The revision of the model repository from which to get the
information.
float
, optional) —
Whether to set a timeout for the request to the Hub.
bool
, optional) —
Whether to retrieve the security status from the model
repository as well.
bool
, optional) —
Whether or not to retrieve metadata for files in the repository
(size, LFS metadata, etc). Defaults to False
.
bool
or str
, optional) —
A valid authentication token (see https://huggingface.co/settings/token).
If None
or True
and machine is logged in (through huggingface-cli login
or login()), token will be retrieved from the cache.
If False
, token is not sent in the request header.
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:
private
and you do not have access.( from_id: str to_id: str repo_type: typing.Optional[str] = None token: typing.Optional[str] = None )
Parameters
str
) —
A namespace (user or an organization) and a repo name separated
by a /
. Original repository identifier.
str
) —
A namespace (user or an organization) and a repo name separated
by a /
. Final repository identifier.
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
.
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:
private
and you do not have access.( repo_id: str discussion_num: int new_title: str token: typing.Optional[str] = None repo_type: typing.Optional[str] = None ) → DiscussionTitleChange
Parameters
str
) —
A namespace (user or an organization) and a repo name separated
by a /
.
int
) —
The number of the Discussion or Pull Request . Must be a strictly positive integer.
str
) —
The new title for the discussion
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
.
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 invalidprivate
and you do not have access.(
repo_id: str
revision: typing.Optional[str] = None
repo_type: typing.Optional[str] = None
timeout: typing.Optional[float] = None
files_metadata: bool = False
token: typing.Union[bool, str, NoneType] = None
)
→
Union[SpaceInfo, DatasetInfo, ModelInfo]
Parameters
str
) —
A namespace (user or an organization) and a repo name separated
by a /
.
str
, optional) —
The revision of the repository from which to get the
information.
float
, optional) —
Whether to set a timeout for the request to the Hub.
bool
, optional) —
Whether or not to retrieve metadata for files in the repository
(size, LFS metadata, etc). Defaults to False
.
bool
or str
, optional) —
A valid authentication token (see https://huggingface.co/settings/token).
If None
or True
and machine is logged in (through huggingface-cli login
or login()), token will be retrieved from the cache.
If False
, token is not sent in the request header.
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:
private
and you do not have access.( access_token: str )
Saves the passed access token so git can correctly authenticate the user.
( repo_id: str revision: typing.Optional[str] = None timeout: typing.Optional[float] = None files_metadata: bool = False token: typing.Union[bool, str, NoneType] = None ) → SpaceInfo
Parameters
str
) —
A namespace (user or an organization) and a repo name separated
by a /
.
str
, optional) —
The revision of the space repository from which to get the
information.
float
, optional) —
Whether to set a timeout for the request to the Hub.
bool
, optional) —
Whether or not to retrieve metadata for files in the repository
(size, LFS metadata, etc). Defaults to False
.
bool
or str
, optional) —
A valid authentication token (see https://huggingface.co/settings/token).
If None
or True
and machine is logged in (through huggingface-cli login
or login()), token will be retrieved from the cache.
If False
, token is not sent in the request header.
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:
private
and you do not have access.Resets the user’s access token.
( repo_id: str private: bool = False token: typing.Optional[str] = None organization: typing.Optional[str] = None repo_type: typing.Optional[str] = None name: typing.Optional[str] = None )
Parameters
str
, optional) —
A namespace (user or an organization) and a repo name separated
by a /
.
bool
, optional, defaults to False
) —
Whether the model repo should be private.
str
, optional) —
An authentication token (See https://huggingface.co/settings/token)
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
.
Update the visibility setting of a repository.
Raises the following errors:
private
and you do not have access.(
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
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
str
, bytes
, or IO
) —
Path to a file on the local machine or binary data stream /
fileobj / buffer.
str
) —
Relative filepath in the repo, for example:
"checkpoints/1fec34a/weights.bin"
str
) —
The repository to which the file will be uploaded, for example:
"username/custom_transformers"
str
, optional) —
Authentication token, obtained with HfApi.login
method. Will
default to the stored token.
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
.
str
, optional) —
The git revision to commit from. Defaults to the head of the "main"
branch.
str
, optional) —
The summary / title / first line of the generated commit
str
optional) —
The description of the generated commit
boolean
, optional) —
Whether or not to create a Pull Request with that commit. Defaults to False
.
If revision
is not set, PR is opened against the "main"
branch. If
revision
is set and is a branch, PR is opened against this branch. If
revision
is set and is not a branch name (example: a commit oid), an
RevisionNotFoundError
is returned by the server.
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
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 invalidprivate
and you do not have access.upload_file
assumes that the repo already exists on the Hub. If you get a
Client error 404, please make sure you are authenticated and that repo_id
and
repo_type
are set correctly. If repo does not exist, create it first using
create_repo().
Example:
>>> 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="dataset",
... 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"
(
repo_id: str
folder_path: typing.Union[str, pathlib.Path]
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
str
) —
The repository to which the file will be uploaded, for example:
"username/custom_transformers"
str
or Path
) —
Path to the folder to upload on the local file system
str
, optional) —
Relative path of the directory in the repo, for example:
"checkpoints/1fec34a/results"
. Will default to the root folder of the repository.
str
, optional) —
Authentication token, obtained with HfApi.login
method. Will
default to the stored token.
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
.
str
, optional) —
The git revision to commit from. Defaults to the head of the "main"
branch.
str
, optional) —
The summary / title / first line of the generated commit. Defaults to:
f"Upload {path_in_repo} with huggingface_hub"
str
optional) —
The description of the generated commit
boolean
, optional) —
Whether or not to create a Pull Request with that commit. Defaults to False
.
If revision
is not set, PR is opened against the "main"
branch. If
revision
is set and is a branch, PR is opened against this branch. If
revision
is set and is not a branch name (example: a commit oid), an
RevisionNotFoundError
is returned by the server.
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.
List[str]
or str
, optional) —
If provided, only files matching at least one pattern are uploaded.
List[str]
or str
, 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 invalidupload_folder
assumes that the repo already exists on the Hub. If you get a
Client error 404, please make sure you are authenticated and that repo_id
and
repo_type
are set correctly. If repo does not exist, create it first using
create_repo().
Example:
>>> 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"
( token: typing.Optional[str] = None )
Call HF API to know “whoami”.
( 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: bool = False author: typing.Optional[str] = None config: typing.Optional[typing.Dict] = None securityStatus: typing.Optional[typing.Dict] = None **kwargs )
Parameters
str
, optional) —
ID of model repository.
str
, optional) —
repo sha at this particular revision
str
, optional) —
date of last commit to repo
List[str]
, optional) —
List of tags.
str
, optional) —
Pipeline tag to identify the correct widget.
List[RepoFile]
, optional) —
list of (huggingface_hub.hf_api.RepoFile) objects that constitute the model.
bool
, optional, defaults to False
) —
is the repo private
str
, optional) —
repo author
Dict
, optional) —
Model configuration information
Dict
, optional) —
Security status of the model.
Example: {"containsInfected": False}
Dict
, optional) —
Kwargs that will be become attributes of the class.
Info about a model accessible from huggingface.co
( 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: bool = False author: typing.Optional[str] = None description: typing.Optional[str] = None citation: typing.Optional[str] = None cardData: typing.Optional[dict] = None **kwargs )
Parameters
str
, optional) —
ID of dataset repository.
str
, optional) —
repo sha at this particular revision
str
, optional) —
date of last commit to repo
Listr[str]
, optional) —
List of tags.
List[RepoFile]
, optional) —
list of huggingface_hub.hf_api.RepoFile objects that constitute the dataset.
bool
, optional, defaults to False
) —
is the repo private
str
, optional) —
repo author
str
, optional) —
Description of the dataset
str
, optional) —
Dataset citation
Dict
, optional) —
Metadata of the model card as a dictionary.
Dict
, optional) —
Kwargs that will be become attributes of the class.
Info about a dataset accessible from huggingface.co
( id: typing.Optional[str] = None sha: typing.Optional[str] = None lastModified: typing.Optional[str] = None siblings: typing.Optional[typing.List[typing.Dict]] = None private: bool = False author: typing.Optional[str] = None **kwargs )
Parameters
str
, optional) —
id of space
str
, optional) —
repo sha at this particular revision
str
, optional) —
date of last commit to repo
List[RepoFile]
, optional) —
list of huggingface_hub.hf_api.RepoFIle
objects that constitute the Space
bool
, optional, defaults to False
) —
is the repo private
str
, optional) —
repo author
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.
( rfilename: str size: typing.Optional[int] = None blobId: typing.Optional[str] = None lfs: typing.Optional[huggingface_hub.hf_api.BlobLfsInfo] = None **kwargs )
Parameters
int
, optional) —
The file’s size, in bytes. This attribute is present when files_metadata
argument
of repo_info
is set to True
. It’s None
otherwise.
str
, optional) —
The file’s git OID. This attribute is present when files_metadata
argument
of repo_info
is set to True
. It’s None
otherwise.
BlobLfsInfo
, optional) —
The file’s LFS metadata. This attribute is present whenfiles_metadata
argument
of repo_info
is set to True
and the file is stored with Git LFS. It’s None
otherwise.
Data structure that represents a public file inside a repo, accessible from huggingface.co
( commit_url: str commit_message: str commit_description: str oid: str pr_url: typing.Optional[str] = None )
Parameters
str
) —
Url where to find the commit.
str
) —
The summary (first line) of the commit that has been created.
str
) —
Description of the commit that has been created. Can be empty.
str
) —
Commit hash id. Example: "91c54ad1727ee830252e457677f467be0bfd8a57"
.
str
, optional) —
Url to the PR that has been created, if any. Populated when create_pr=True
is passed.
str
, optional) —
Revision of the PR that has been created, if any. Populated when
create_pr=True
is passed. Example: "refs/pr/1"
.
int
, optional) —
Number of the PR discussion that has been created, if any. Populated when
create_pr=True
is passed. Can be passed as discussion_num
in
get_discussion_details(). Example: 1
.
Data structure containing information about a newly created commit.
Returned by create_commit().
create_commit
API
Below are the supported values for CommitOperation()
:
( path_in_repo: str path_or_fileobj: typing.Union[str, bytes, typing.BinaryIO] )
Parameters
str
) —
Relative filepath in the repo, for example: "checkpoints/1fec34a/weights.bin"
str
, bytes
, or BinaryIO
) —
Either:bytes
) holding the content of the file to uploadio.BufferedIOBase
), typically obtained
with open(path, "rb")
. It must support seek()
and tell()
methods.Raises
ValueError
ValueError
—
If path_or_fileobj
is not one of str
, bytes
or io.BufferedIOBase
.ValueError
—
If path_or_fileobj
is a str
but not a path to an existing file.ValueError
—
If path_or_fileobj
is a io.BufferedIOBase
but it doesn’t support both
seek()
and tell()
.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
.
( path_in_repo: str is_folder: typing.Union[bool, typing.Literal['auto']] = 'auto' )
Parameters
str
) —
Relative filepath in the repo, for example: "checkpoints/1fec34a/weights.bin"
for a file or "checkpoints/1fec34a/"
for a folder.
bool
or Literal["auto"]
, optional) —
Whether the Delete Operation applies to a folder or not. If “auto”, the path
type (file or folder) is guessed automatically by looking if path ends with
a ”/” (folder) or not (file). To explicitly set the path type, you can set
is_folder=True
or is_folder=False
.
Data structure holding necessary info to delete a file or a folder from a repository on the Hub.
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.
Some helpers to filter repositories on the Hub are available in the huggingface_hub
package.
( author: typing.Optional[str] = None benchmark: typing.Union[typing.List[str], str, NoneType] = None dataset_name: typing.Optional[str] = None language_creators: typing.Union[typing.List[str], str, NoneType] = None language: typing.Union[typing.List[str], str, NoneType] = None multilinguality: typing.Union[typing.List[str], str, NoneType] = None size_categories: typing.Union[typing.List[str], str, NoneType] = None task_categories: typing.Union[typing.List[str], str, NoneType] = None task_ids: typing.Union[typing.List[str], str, NoneType] = None )
Parameters
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 as
facebook
or huggingface
.
str
or List
, optional) —
A string or list of strings that can be used to identify datasets on
the Hub by their official benchmark.
str
, optional) —
A string or list of strings that can be used to identify datasets on
the Hub by its name, such as SQAC
or wikineural
str
or List
, optional) —
A string or list of strings that can be used to identify datasets on
the Hub with how the data was curated, such as crowdsourced
or
machine_generated
.
str
or List
, optional) —
A string or list of strings representing a two-character language to
filter datasets by on the Hub.
str
or List
, optional) —
A string or list of strings representing a filter for datasets that
contain multiple languages.
str
or List
, optional) —
A string or list of strings that can be used to identify datasets on
the Hub by the size of the dataset such as 100K<n<1M
or
1M<n<10M
.
str
or List
, optional) —
A string or list of strings that can be used to identify datasets on
the Hub by the designed task, such as audio_classification
or
named_entity_recognition
.
str
or List
, optional) —
A string or list of strings that can be used to identify datasets on
the Hub by the specific task such as speech_emotion_recognition
or
paraphrase
.
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")
( author: typing.Optional[str] = None library: typing.Union[typing.List[str], str, NoneType] = None language: typing.Union[typing.List[str], str, NoneType] = None model_name: typing.Optional[str] = None task: typing.Union[typing.List[str], str, NoneType] = None trained_dataset: typing.Union[typing.List[str], str, NoneType] = None tags: typing.Union[typing.List[str], str, NoneType] = None )
Parameters
str
, optional) —
A string that can be used to identify models on the Hub by the
original uploader (author or organization), such as facebook
or
huggingface
.
str
or List
, optional) —
A string or list of strings of foundational libraries models were
originally trained from, such as pytorch, tensorflow, or allennlp.
str
or List
, optional) —
A string or list of strings of languages, both by name and country
code, such as “en” or “English”
str
, optional) —
A string that contain complete or partial names for models on the
Hub, such as “bert” or “bert-base-cased”
str
or List
, optional) —
A string or list of strings of tasks models were designed for, such
as: “fill-mask” or “automatic-speech-recognition”
str
or List
, optional) —
A string tag or a list of tags to filter models on the Hub by, such
as text-generation
or spacy
.
str
or List
, 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")
( api: typing.Optional[ForwardRef('HfApi')] = None )
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
( api: typing.Optional[ForwardRef('HfApi')] = None )
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