Skip to content

Commit e7ae777

Browse files
authored
docs: readme examples (#180)
1 parent ec04b9d commit e7ae777

File tree

3 files changed

+27
-0
lines changed

3 files changed

+27
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ length of 512 tokens:
3939
- [gRPC](#grpc)
4040
- [Local Install](#local-install)
4141
- [Docker Build](#docker-build)
42+
- [Examples](#examples)
4243

4344
Text Embeddings Inference (TEI) is a toolkit for deploying and serving open source text embeddings and sequence
4445
classification models. TEI enables high-performance extraction for the most popular models, including FlagEmbedding,
@@ -453,3 +454,7 @@ runtime_compute_cap=90
453454

454455
docker build . -f Dockerfile-cuda --build-arg CUDA_COMPUTE_CAP=$runtime_compute_cap
455456
```
457+
458+
## Examples
459+
- [Set up an Inference Endpoint with TEI](https://huggingface.co/learn/cookbook/automatic_embedding_tei_inference_endpoints)
460+
- [RAG containers with TEI](https://github.com/plaggy/rag-containers)

docs/source/en/_toctree.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@
1919
# title: Using TEI CLI
2020
- local: custom_container
2121
title: Build custom container for TEI
22+
- local: examples
23+
title: Example uses
2224
title: Tutorials
2325
- sections:
2426
- local: cli_arguments

docs/source/en/examples.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<!--Copyright 2023 The HuggingFace Team. All rights reserved.
2+
3+
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
4+
the License. You may obtain a copy of the License at
5+
6+
http://www.apache.org/licenses/LICENSE-2.0
7+
8+
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
9+
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
10+
specific language governing permissions and limitations under the License.
11+
12+
⚠️ Note that this file is in Markdown but contain specific syntax for our doc-builder (similar to MDX) that may not be
13+
rendered properly in your Markdown viewer.
14+
15+
-->
16+
17+
# Example uses
18+
19+
- [Set up an Inference Endpoint with TEI](https://huggingface.co/learn/cookbook/automatic_embedding_tei_inference_endpoints)
20+
- [RAG containers with TEI](https://github.com/plaggy/rag-containers)

0 commit comments

Comments
 (0)