The HfFileSystem
class provides a pythonic file interface to the Hugging Face Hub based on fsspec
.
HfFileSystem
is based on fsspec, so it is compatible with most of the APIs that it offers. For more details, check out our guide and fsspecās API Reference.
( *args **kwargs )
Parameters
str
, optional) —
The endpoint to use. If not provided, the default one (https://huggingface.co) is used. str
, optional) —
Authentication token, obtained with HfApi.login
method. Will default to the stored token. Access a remote Hugging Face Hub repository as if were a local file system.
Usage:
>>> from huggingface_hub import HfFileSystem
>>> fs = HfFileSystem()
>>> # List files
>>> fs.glob("my-username/my-model/*.bin")
['my-username/my-model/pytorch_model.bin']
>>> fs.ls("datasets/my-username/my-dataset", detail=False)
['datasets/my-username/my-dataset/.gitattributes', 'datasets/my-username/my-dataset/README.md', 'datasets/my-username/my-dataset/data.json']
>>> # Read/write files
>>> with fs.open("my-username/my-model/pytorch_model.bin") as f:
... data = f.read()
>>> with fs.open("my-username/my-model/pytorch_model.bin", "wb") as f:
... f.write(data)
( *args endpoint: typing.Optional[str] = None token: typing.Optional[str] = None **storage_options )
( path: str detail: bool = True refresh: bool = False revision: typing.Optional[str] = None **kwargs )
List the contents of a directory.