[Inference Providers] revamp documentation #1457
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
hanouticelina
commented
May 16, 2025
| 2. [Inference Endpoints](https://huggingface.co/docs/inference-endpoints/index): a product to easily deploy models to production. Inference is run by Hugging Face in a dedicated, fully managed infrastructure on a cloud provider of your choice. | ||
| 3. Local endpoints: you can also run inference with local inference servers like [llama.cpp](https://github.com/ggerganov/llama.cpp), [Ollama](https://ollama.com/), [vLLM](https://github.com/vllm-project/vllm), [LiteLLM](https://docs.litellm.ai/docs/simple_proxy), or [Text Generation Inference (TGI)](https://github.com/huggingface/text-generation-inference) by connecting the client to these local endpoints. | ||
|
|
||
| You can also try out a live [interactive notebook](https://observablehq.com/@huggingface/hello-huggingface-js-inference), see some demos on [hf.co/huggingfacejs](https://huggingface.co/huggingfacejs), or watch a [Scrimba tutorial that explains how Inference Endpoints works](https://scrimba.com/scrim/cod8248f5adfd6e129582c523). |
There was a problem hiding this comment.
I removed broken/outdated demos link
hanouticelina
commented
May 16, 2025
| This task reads some text and outputs raw float values, that are usually consumed as part of a semantic database/semantic search. | ||
|
|
||
| ```typescript | ||
| const openai = new InferenceClient(OPENAI_TOKEN).endpoint("https://api.openai.com"); |
There was a problem hiding this comment.
no need for this imo + i added a tip line 635
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
julien-c
approved these changes
May 16, 2025
Comment on lines
+612
to
+639
| ## Using local endpoints | ||
|
|
||
| You can use `InferenceClient` to run chat completion with local inference servers (llama.cpp, vllm, litellm server, TGI, mlx, etc.) running on your own machine. The API should be OpenAI API-compatible. | ||
|
|
||
| ```typescript | ||
| import { InferenceClient } from '@huggingface/inference'; | ||
|
|
||
| const hf = new InferenceClient(undefined, { | ||
| endpointUrl: "http://localhost:8080", | ||
| }); | ||
|
|
||
| const response = await hf.chatCompletion({ | ||
| messages: [ | ||
| { | ||
| role: "user", | ||
| content: "What is the capital of France?", | ||
| }, | ||
| ], | ||
| }); | ||
|
|
||
| console.log(response.choices[0].message.content); | ||
| ``` | ||
|
|
||
| <Tip> | ||
|
|
||
| Similarily to the OpenAI JS client, `InferenceClient` can be used to run Chat Completion inference with any OpenAI REST API-compatible endpoint. | ||
|
|
||
| </Tip> |
SBrandeis
approved these changes
May 16, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Similar to huggingface/huggingface_hub#3085.