# ExVision
[](https://hex.pm/packages/ex_vision)
[](https://hexdocs.pm/ex_vision)
ExVision is the collection of AI models related to vision delivered with ready to use package and easy to understand API.
ExVision will take care of all necessary input transformations internally and return the result in the sensible format.
ExVision models are powered by [Ortex](https://www.github.com/elixir-nx/ortex).
## Usage
In order to use the model, you need to first load it
```elixir
alias ExVision.Classification.MobileNetV3Small
model = MobileNetV3Small.load() #=> %MobileNetV3{}
```
After that, the model is available for inference.
ExVision will take care of all necessary input transformations and covert output to a format that makes sense.
```elixir
MobileNetV3Small.run(model, "example/files/cat.jpg") #=> %{cat: 0.98, dog: 0.01, car: 0.00, ...}
```
ExVision is also capable of accepting tensors and images on input:
```elixir
cat = Image.open!("example/files/cat.jpg")
{:ok, cat_tensor} = Image.to_nx(cat)
MobileNetV3Small.run(model, cat) #=> %{cat: 0.98, dog: 0.01, car: 0.00, ...}
MobileNetV3Small.run(model, cat_tensor) #=> %{cat: 0.98, dog: 0.01, car: 0.00, ...}
```
### Usage in process workflow
All ExVision models are implemented using `Nx.Serving`.
They are therefore compatible with process workflow.
You can start a model's process:
```elixir
{:ok, pid} = MobileNetV3Small.start_link(name: MyModel)
```
or start it under the supervision tree
```elixir
{:ok, _supervisor_pid} = Supervisor.start_link([
{MobileNetV3Small, name: MyModel}
], strategy: :one_for_one)
```
After starting, it's immediatelly available for inference using `batched_run/2` function.
```elixir
MobileNetV3Small.batched_run(MyModel, cat) #=> %{cat: 0.98, dog: 0.01, car: 0.00, ...}
```
## Installation
The package can be installed by adding `ex_vision` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:ex_vision, "~> 0.3.1"}
]
end
```
In order to compile, ExVision **requires Rust and Cargo** to be installed on your system.
## Current Timeline
We have identified a set of models that we would like to support.
If the model that you would like to use is missing, feel free to open the issue, express interest in an existing one or contribute the model directly.
- [x] Classification
- [x] MobileNetV3 Small
- [x] EfficientNetV2
- [x] SqueezeNet
- [x] Object detection
- [x] SSDLite320 - MobileNetV3 Large backbone
- [x] FasterRCNN ResNet50 FPN
- [x] Semantic segmentation
- [x] DeepLabV3 - MobileNetV3
- [x] Instance segmentation
- [x] Mask R-CNN
- [x] Keypoint Detection
- [x] Keypoint R-CNN
## Copyright and License
Copyright 2024, [Software Mansion](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=ex_vision)
[](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=ex_vision)
Licensed under the [Apache License, Version 2.0](LICENSE)
