Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 27 additions & 25 deletions docs/api-inference/_toctree.yml
Original file line number Diff line number Diff line change
@@ -1,27 +1,37 @@
- sections:
- title: Get Started
sections:
- local: index
title: Serverless Inference API
- local: getting-started
title: Getting Started
- local: supported-models
title: Supported Models
title: Inference Providers API
- local: pricing
title: Pricing and Rate limits
title: Pricing and Billing
- local: hub-integration
title: Hub integration
- local: providers
title: Providers
- local: security
title: Security
title: Getting Started
- sections:
- local: parameters
title: Parameters
- sections:
- local: tasks/audio-classification
title: Audio Classification
- local: tasks/automatic-speech-recognition
title: Automatic Speech Recognition
- title: API Reference
sections:
- local: tasks/index
title: Index
- local: hub-api
title: Hub API
- title: Popular Tasks
sections:
- local: tasks/chat-completion
title: Chat Completion
- local: tasks/feature-extraction
title: Feature Extraction
- local: tasks/text-generation
title: Text Generation
- local: tasks/text-to-image
title: Text to Image
- title: Other Tasks
sections:
- local: tasks/audio-classification
title: Audio Classification
- local: tasks/automatic-speech-recognition
title: Automatic Speech Recognition
- local: tasks/fill-mask
title: Fill Mask
- local: tasks/image-classification
Expand All @@ -30,8 +40,6 @@
title: Image Segmentation
- local: tasks/image-to-image
title: Image to Image
- local: tasks/image-text-to-text
title: Image-Text to Text
- local: tasks/object-detection
title: Object Detection
- local: tasks/question-answering
Expand All @@ -42,15 +50,9 @@
title: Table Question Answering
- local: tasks/text-classification
title: Text Classification
- local: tasks/text-generation
title: Text Generation
- local: tasks/text-to-image
title: Text to Image
- local: tasks/token-classification
title: Token Classification
- local: tasks/translation
title: Translation
- local: tasks/zero-shot-classification
title: Zero Shot Classification
title: Detailed Task Parameters
title: API Reference
title: Zero Shot Classification
95 changes: 0 additions & 95 deletions docs/api-inference/getting-started.md

This file was deleted.

9 changes: 9 additions & 0 deletions docs/api-inference/hub-api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Hub API

**TODO**
- search for models (API): https://huggingface.co/api/models?inference_provider=fireworks-ai
- get warm models (any provider): https://huggingface.co/api/models?inference=warm
- get warm status for a model: https://huggingface.co/api/models/google/gemma-3-27b-it?expand[]=inference
- get providers for a model: https://huggingface.co/api/models/Qwen/QwQ-32B?expand[]=inferenceProviderMapping

Document raw HTTP requests + JS/Python equivalent in SDKs
17 changes: 17 additions & 0 deletions docs/api-inference/hub-integration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Hub Integration

**TODO:**
- search for models (UI): https://huggingface.co/models?inference_provider=fireworks-ai&sort=trending
- search all models (UI): https://huggingface.co/models?inference_provider=all&sort=trending
- set custom API key from provider (optional)
- order providers by preference (apply to widget and code snippets)

### Features using Inference Providers

Several Hugging Face features utilize the Inference Providers API and count towards your monthly credits:

- Inference Widgets: Interactive widgets available on model pages.
- [Inference Playground](https://huggingface.co/playground): A comprehensive chat interface supporting various models and providers.
- Data Studio AI: Converts text to SQL queries for datasets.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you can "delegate" to e.g. @mishig25, @cfahlgren1 etc to wrap a small blurb about those (with a screenshot)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wouldn't mind some help 🙏

For now I've taken screenshots from the website but can't say it looks so nice: https://moon-ci-docs.huggingface.co/docs/api-inference/pr_1652/en/hub-integration 😬


The included monthly credits for PRO and Enterprise should cover moderate usage of these features for most users.
Loading