Skip to content

Commit

Permalink
Move notice in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Anush008 authored May 24, 2024
1 parent 8ce8f86 commit 98bb32d
Showing 1 changed file with 17 additions and 17 deletions.
34 changes: 17 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,23 @@ Run the following Go CLI command in your project directory:
go get -u github.com/anush008/fastembed-go
```

## ℹ︎ Notice:

The Onnx runtime path is automatically loaded on most environments. However, if you encounter
```sh
panic: Platform-specific initialization failed: Error loading ONNX shared library
```
Set the `ONNX_PATH` env to your Onnx installation.
For eg, on MacOS:
```sh
export ONNX_PATH="/path/to/onnx/lib/libonnxruntime.dylib"
```
On Linux:
```sh
export ONNX_PATH="/path/to/onnx/lib/libonnxruntime.so"
```
You can find the Onnx runtime releases [here](https://github.com/microsoft/onnxruntime/releases).

## 📖 Usage

```go
Expand Down Expand Up @@ -107,23 +124,6 @@ if err != nil {
}
```

## ℹ︎ Notice:

The Onnx runtime path is automatically loaded on most environments. However, if you encounter
```sh
panic: Platform-specific initialization failed: Error loading ONNX shared library
```
Set the `ONNX_PATH` env to your Onnx installation.
For eg, on MacOS:
```sh
export ONNX_PATH="/path/to/onnx/lib/libonnxruntime.dylib"
```
On Linux:
```sh
export ONNX_PATH="/path/to/onnx/lib/libonnxruntime.so"
```
You can find the Onnx runtime releases [here](https://github.com/microsoft/onnxruntime/releases).

## 🚒 Under the hood

### Why fast?
Expand Down

0 comments on commit 98bb32d

Please sign in to comment.