Skip to content

Commit

Permalink
docs: update for README
Browse files Browse the repository at this point in the history
  • Loading branch information
phodal committed Nov 27, 2023
1 parent d2adf6d commit e28a9c2
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 2 deletions.
2 changes: 1 addition & 1 deletion enfer_core/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "enfer_core"
version = "0.1.0"
version = "0.1.1"
authors = ["Phodal <[email protected]>", "CGQAQ <[email protected]>"]
description = "Feakin is a architecture design and visual collaboration tool. This is the parser for Feakin."
repository = "https://github.com/unit-mesh/edge-infer"
Expand Down
23 changes: 22 additions & 1 deletion enfer_core/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,26 @@
# Enfer Core = EdgeInference Core
# Edge Inference Core

> EdgeInfer enables efficient edge intelligence by running small AI models, including embeddings and OnnxModels, on
> resource-constrained devices like Android, iOS, or MCUs for real-time decision-making.
usage:

add to your `Cargo.toml`:

```toml
[dependencies]
edgeinfer = "0.1.1"
```

in your `main.rs`:

```rust
let model = std::fs::read("model/model.onnx").unwrap();
let tokenizer_data = std::fs::read("model/tokenizer.json").unwrap();

let semantic = init_semantic(model, tokenizer_data).unwrap();
let embedding = semantic.embed("hello world").unwrap();
assert_eq!(embedding.len(), 128);
```


0 comments on commit e28a9c2

Please sign in to comment.