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.

For some related components, check out the Hugging Face Hub JS repository

• Utilities to interact with the Hub: huggingface/huggingface.js/packages/hub
• Hub Inference, powered by our Inference Providers: huggingface/huggingface.js/packages/inference
• Hub Tasks (as visible on the page hf.co/tasks): huggingface/huggingface.js/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

# 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

Inference Providers docs generator (optional)

This repo includes a generator to update pages under docs/inference-providers/ from templates. To use it:

cd scripts/inference-providers
pnpm install
pnpm run generate

Templates live under scripts/inference-providers/templates/ and are compiled by scripts/inference-providers/scripts/generate.ts.

Contributing

See CONTRIBUTING.md for guidelines (Hacktoberfest-friendly!), local preview instructions, and PR tips.