From 24e94cd282e95d787b9175b7b14147356f2a5d0b Mon Sep 17 00:00:00 2001 From: Quentin Lhoest Date: Tue, 24 Jun 2025 17:43:59 +0200 Subject: [PATCH] update hffilesystem docstring --- src/huggingface_hub/hf_file_system.py | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/src/huggingface_hub/hf_file_system.py b/src/huggingface_hub/hf_file_system.py index 4f438edc05..80bd898a4d 100644 --- a/src/huggingface_hub/hf_file_system.py +++ b/src/huggingface_hub/hf_file_system.py @@ -59,13 +59,11 @@ class HfFileSystem(fsspec.AbstractFileSystem): """ Access a remote Hugging Face Hub repository as if were a local file system. - + [`HfFileSystem`] provides fsspec compatibility, which is useful for libraries that require it (e.g., reading + Hugging Face datasets directly with `pandas`). - [`HfFileSystem`] provides fsspec compatibility, which is useful for libraries that require it (e.g., reading - Hugging Face datasets directly with `pandas`). However, it introduces additional overhead due to this compatibility - layer. For better performance and reliability, it's recommended to use `HfApi` methods when possible. - - + It is a thin wrapper over `HfApi` which provides the lower level features of the Hub. Therefore it is recommended + to use `HfApi` methods when possible if you look for more fine-grained operations. Args: token (`str` or `bool`, *optional*):