Package: huggingface-hub
The official Python client for the Huggingface Hub.English|Deutsch|हिंदी|한국어|中文（简体）---Documentation:https://hf.co/docs/huggingface_hubSource Code:https://github.com/huggingface/huggingface_hubWelcome to the huggingface_hub libraryThehuggingface_hublibrary allows you to interact with theHugging Face Hub, a platform democratizing open-source Machine Learning for creators and collaborators. Discover pre-trained models and datasets for your projects or play with the thousands of machine learning apps hosted on the Hub. You can also create and share your own models, datasets and demos with the community. Thehuggingface_hublibrary provides a simple way to do all these things with Python.Key featuresDownload filesfrom the Hub.Upload filesto the Hub.Manage your repositories.Run Inferenceon deployed models.Searchfor models, datasets and Spaces.Share Model Cardsto document your models.Engage with the communitythrough PRs and comments.InstallationInstall thehuggingface_hubpackage withpip:pipinstallhuggingface_hubIf you prefer, you can also install it withconda.In order to keep the package minimal by default,huggingface_hubcomes with optional dependencies useful for some use cases. For example, if you want have a complete experience for Inference, run:pipinstallhuggingface_hub[inference]To learn more installation and optional dependencies, check out theinstallation guide.Quick startDownload filesDownload a single filefromhuggingface_hubimporthf_hub_downloadhf_hub_download(repo_id="tiiuae/falcon-7b-instruct",filename="config.json")Or an entire repositoryfromhuggingface_hubimportsnapshot_downloadsnapshot_download("stabilityai/stable-diffusion-2-1")Files will be downloaded in a local cache folder. More details inthis guide.LoginThe Hugging Face Hub uses tokens to authenticate applications (seedocs). To login your machine, run the following CLI:huggingface-clilogin# or using an environment variablehuggingface-clilogin--token$HUGGINGFACE_TOKENCreate a repositoryfromhuggingface_hubimportcreate_repocreate_repo(repo_id="super-cool-model")Upload filesUpload a single filefromhuggingface_hubimportupload_fileupload_file(path_or_fileobj="/home/lysandre/dummy-test/README.md",path_in_repo="README.md",repo_id="lysandre/test-model",)Or an entire folderfromhuggingface_hubimportupload_folderupload_folder(folder_path="/path/to/local/space",repo_id="username/my-cool-space",repo_type="space",)For details in theupload guide.Integrating to the Hub.We're partnering with cool open source ML libraries to provide free model hosting and versioning. You can find the existing integrationshere.The advantages are:Free model or dataset hosting for libraries and their users.Built-in file versioning, even with very large files, thanks to a git-based approach.Hosted inference API for all models publicly available.In-browser widgets to play with the uploaded models.Anyone can upload a new model for your library, they just need to add the corresponding tag for the model to be discoverable.Fast downloads! We use Cloudfront (a CDN) to geo-replicate downloads so they're blazing fast from anywhere on the globe.Usage stats and more features to come.If you would like to integrate your library, feel free to open an issue to begin the discussion. We wrote astep-by-step guidewith ❤️ showing how to do this integration.Contributions (feature requests, bugs, etc.) are super welcome 💙💚💛💜🧡❤️Everyone is welcome to contribute, and we value everybody's contribution. Code is not the only way to help the community.
Answering questions, helping others, reaching out and improving the documentations are immensely valuable to the community.
We wrote acontribution guideto summarize
how to get started to contribute to this repository.