Skip to content

Commit

Permalink
docs: README.md typo fix, refactor
Browse files Browse the repository at this point in the history
  • Loading branch information
Anush008 authored Oct 8, 2023
1 parent 7faaef1 commit e238867
Showing 1 changed file with 18 additions and 18 deletions.
36 changes: 18 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<img src="https://github.com/Anush008/fastembed-rs/assets/46051506/4bd3cefe-12da-48b9-8cc2-7489145c9cb5" style="display: inline-block; vertical-align: middle; width: auto; height: 100px;">
</h1>
<h3>Go implementation of <a href="https://github.com/qdrant/fastembed" target="_blank">@Qdrant/fastembed</a></h3>
<a href="https://pkg.go.dev/github.com/anush009/fastembed-go"><img src="https://pkg.go.dev/badge/github.com/anush009/fastembed-go.svg" alt="Go Reference"></a>
<a href="https://pkg.go.dev/github.com/anush008/fastembed-go"><img src="https://pkg.go.dev/badge/github.com/anush008/fastembed-go.svg" alt="Go Reference"></a>
<a href="https://github.com/Anush008/fastembed-go/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-mit-blue.svg" alt="MIT Licensed"></a>
<a href="https://github.com/Anush008/fastembed-go/actions/workflows/release.yml"><img src="https://github.com/Anush008/fastembed-go/actions/workflows/release.yml/badge.svg?branch=main" alt="Semantic release"></a>
</div>
Expand Down Expand Up @@ -37,23 +37,6 @@ 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 @@ -119,6 +102,23 @@ 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 e238867

Please sign in to comment.