Skip to content

Commit

Permalink
Update repo readme
Browse files Browse the repository at this point in the history
  • Loading branch information
hellojwilde committed Jun 11, 2023
1 parent 6689a12 commit ef5048a
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,13 +40,19 @@ import { modelSource } from "@energetic-ai/model-embeddings-en";
})();
```

Here's an example of using the classifiers model:

```js
import { initClassifier } from "@energetic-ai/classifiers";

## Packages

This repository contains the following packages:

| Package | Description |
| ------------------------------------- | -------------------------------------------------------------------- |
| **@energetic-ai/core** | The core EnergeticAI library, comparable to `@tensorflow\tfjs-core`. |
| **@energetic-ai/classifiers** | Classifiers model library. |
| **@energetic-ai/embeddings** | Embeddings model library. |
| **@energetic-ai/model-embeddings-en** | English embeddings model weights. |

Expand All @@ -62,8 +68,9 @@ This repository uses [Lerna](https://lerna.js.org/) to manage packages, and [Vit

## License

[Apache 2.0](LICENSE)
[Apache 2.0](LICENSE), except for dependencies.

## Acknowledgements

This project is derived from [TensorFlow.js](https://github.com/tensorflow/tfjs), the [Universal Sentence Encoder model library](https://github.com/tensorflow/tfjs-models) and [Universal Sentence Encoder Lite model weights](https://tfhub.dev/tensorflow/tfjs-model/universal-sentence-encoder-lite/1/default/1), which are also Apache 2.0 licensed.
```

0 comments on commit ef5048a

Please sign in to comment.