https://github.com/huggingface/hub-docs
Docs of the Hugging Face Hub
https://github.com/huggingface/hub-docs
hacktoberfest machine-learning
Last synced: 3 months ago
JSON representation
Docs of the Hugging Face Hub
- Host: GitHub
- URL: https://github.com/huggingface/hub-docs
- Owner: huggingface
- License: apache-2.0
- Created: 2022-03-16T13:26:14.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-10-07T14:51:15.000Z (3 months ago)
- Last Synced: 2025-10-07T16:29:28.784Z (3 months ago)
- Topics: hacktoberfest, machine-learning
- Language: Handlebars
- Homepage: http://hf.co/docs/hub
- Size: 20.1 MB
- Stars: 453
- Watchers: 39
- Forks: 367
- Open Issues: 146
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# hub-docs
This repository regroups documentation and information that is hosted on the Hugging Face website.
You can access the Hugging Face Hub documentation in the `docs` folder at [hf.co/docs/hub](https://hf.co/docs/hub).
For some related components, check out the [Hugging Face Hub JS repository](https://github.com/huggingface/huggingface.js)
- Utilities to interact with the Hub: [huggingface/huggingface.js/packages/hub](https://github.com/huggingface/huggingface.js/tree/main/packages/hub)
- Hub Inference, powered by our Inference Providers: [huggingface/huggingface.js/packages/inference](https://github.com/huggingface/huggingface.js/tree/main/packages/inference)
- Hub Tasks (as visible on the page [hf.co/tasks](https://hf.co/tasks)): [huggingface/huggingface.js/packages/tasks](https://github.com/huggingface/huggingface.js/tree/main/packages/tasks)
### How to contribute to the docs
Just add/edit the Markdown files, commit them, and create a PR.
Then the CI bot will build the preview page and provide a url for you to look at the result!
For simple edits, you don't need a local build environment.
### Previewing locally
```bash
# install doc-builder (if not done already)
pip install hf-doc-builder
# you may also need to install some extra dependencies
pip install black watchdog
# run `doc-builder preview` cmd
doc-builder preview hub {YOUR_PATH}/hub-docs/docs/hub/ --not_python_module
```