Welcome to the documentation repository for Hugging Face Hub. This repository contains the documentation and information hosted on the Hugging Face website.
You can find the Hugging Face Hub documentation in the docs folder. For direct access, visit: hf.co/docs/hub.
Explore these related components for more utilities and features:
- Hugging Face Hub JS Repository:
- Utilities to Interact with the Hub: Contains utilities to interact with the Hugging Face Hub.
- Hub Widgets: Includes widgets for the Hub.
- Hub Tasks: Provides information on tasks visible on hf.co/tasks.
To contribute:
- Edit/Add Markdown Files: Make changes directly to the Markdown files in this repository.
- Commit Changes: Commit your changes and create a Pull Request (PR).
- CI Bot Preview: After creating a PR, the CI bot will build a preview of your changes. You will receive a URL to review the result.
For straightforward edits, you do not need a local build environment.
To preview the documentation changes on your local machine, follow these steps:
-
Install Doc-Builder:
pip install hf-doc-builder
-
Install Additional Dependencies (if needed):
pip install black watchdog
-
Run the Preview Command:
doc-builder preview hub {YOUR_PATH}/hub-docs/docs/hub/ --not_python_module
Replace {YOUR_PATH} with the path to the cloned repository on your local machine.