diff --git a/README.md b/README.md index 3c890c42b4..70714a6c5e 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,7 @@ await inference.textToImage({ This is a collection of JS libraries to interact with the Hugging Face API, with TS types included. -- [@huggingface/inference](packages/inference/README.md): Use Inference API (serverless), Inference Endpoints (dedicated) and third-party Inference providers to make calls to 100,000+ Machine Learning models +- [@huggingface/inference](packages/inference/README.md): Use HF Inference API (serverless), Inference Endpoints (dedicated) and third-party Inference Providers to make calls to 100,000+ Machine Learning models - [@huggingface/hub](packages/hub/README.md): Interact with huggingface.co to create or delete repos and commit / download files - [@huggingface/agents](packages/agents/README.md): Interact with HF models through a natural language interface - [@huggingface/gguf](packages/gguf/README.md): A GGUF parser that works on remotely hosted files. diff --git a/docs/_toctree.yml b/docs/_toctree.yml index 948c70e797..06876a026f 100644 --- a/docs/_toctree.yml +++ b/docs/_toctree.yml @@ -4,7 +4,7 @@ isExpanded: true sections: - local: inference/README - title: Use Inference Endpoints + title: Use Inference Client - local: inference/modules title: API reference - title: "@huggingface/hub" diff --git a/packages/inference/README.md b/packages/inference/README.md index d054e1686a..cdf13512b9 100644 --- a/packages/inference/README.md +++ b/packages/inference/README.md @@ -1,6 +1,6 @@ # 🤗 Hugging Face Inference -A Typescript powered wrapper for the Hugging Face Inference API (serverless), Inference Endpoints (dedicated), and third-party Inference Providers. +A Typescript powered wrapper for the HF Inference API (serverless), Inference Endpoints (dedicated), and third-party Inference Providers. It works with [Inference API (serverless)](https://huggingface.co/docs/api-inference/index) and [Inference Endpoints (dedicated)](https://huggingface.co/docs/inference-endpoints/index), and even with supported third-party Inference Providers. Check out the [full documentation](https://huggingface.co/docs/huggingface.js/inference/README).