Skip to content

Add repository cloning step for local installation #781

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
smedegaard wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add repository cloning step for local installation #781

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions docs/source/en/local_cpu.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,13 @@ rendered properly in your Markdown viewer.

You can install `text-embeddings-inference` locally to run it on your own machine. Here are the step-by-step instructions for installation:

## Step 0: Clone the repository
We need the source code of the `text-embeddings-inference` repo to install it later. Clone it with:

```shell
git clone git@github.com:huggingface/text-embeddings-inference.git
```

## Step 1: Install Rust

[Install Rust](https://rustup.rs/) on your machine by run the following in your terminal, then following the instructions:
Expand All @@ -28,6 +35,7 @@ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

## Step 2: Install necessary packages

The following assumes you are in the repository folder you cloned in step 0.
Depending on your machine's architecture, run one of the following commands:

### For x86 Machines
Expand Down