Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

describe model load and convertion to IR #2175

Merged
Show file tree
Hide file tree
Changes from 15 commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
ddef294
unify label files names (#2172)
eaidova Mar 4, 2021
307e6a2
camvid classes description (#2173)
vladimir-dudnik Mar 4, 2021
dd7c1ed
describe model load and convertion to IR
vladimir-dudnik Mar 5, 2021
5048c26
also in index
vladimir-dudnik Mar 5, 2021
5dca8b0
Update demos/interactive_face_detection_demo/cpp/README.md
vladimir-dudnik Mar 9, 2021
5d776b4
Update demos/interactive_face_detection_demo/cpp/README.md
vladimir-dudnik Mar 9, 2021
1c65c53
Update demos/interactive_face_detection_demo/cpp/README.md
vladimir-dudnik Mar 9, 2021
9986e14
Update demos/interactive_face_detection_demo/cpp/README.md
vladimir-dudnik Mar 9, 2021
134368c
Update models/public/aclnet/aclnet.md
vladimir-dudnik Mar 9, 2021
d142341
Update models/public/aclnet/aclnet.md
vladimir-dudnik Mar 9, 2021
c99e644
Update models/public/aclnet/aclnet.md
vladimir-dudnik Mar 9, 2021
d5f75c4
Update models/public/aclnet/aclnet.md
vladimir-dudnik Mar 9, 2021
7964585
Update models/public/index.md
vladimir-dudnik Mar 9, 2021
eac9fa1
Update models/public/index.md
vladimir-dudnik Mar 9, 2021
b98b610
extend wording to all public models
vladimir-dudnik Mar 9, 2021
5c8b26b
Update demos/interactive_face_detection_demo/cpp/README.md
vladimir-dudnik Mar 11, 2021
d47f7b0
update follow by review
vladimir-dudnik Mar 12, 2021
dfc474d
fix punctuation
vladimir-dudnik Mar 12, 2021
fe42c00
Update models/public/forward-tacotron/description/forward-tacotron.md
vladimir-dudnik Mar 15, 2021
95330b4
Update models/public/human-pose-estimation-3d-0001/description/human-…
vladimir-dudnik Mar 15, 2021
521c541
Update models/public/open-closed-eye-0001/description/open-closed-eye…
vladimir-dudnik Mar 15, 2021
54bc00b
Update models/public/single-human-pose-estimation-0001/description/si…
vladimir-dudnik Mar 15, 2021
0b9f5b0
Update models/public/vehicle-license-plate-detection-barrier-0123/des…
vladimir-dudnik Mar 15, 2021
a2366cc
Update models/public/wavernn/description/wavernn.md
vladimir-dudnik Mar 15, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
File renamed without changes.
20 changes: 20 additions & 0 deletions data/dataset_classes/voc_20cl.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
aeroplane
bicycle
bird
boat
bottle
bus
car
cat
chair
cow
diningtable
dog
horse
motorbike
person
pottedplant
sheep
sofa
train
tvmonitor
File renamed without changes.
14 changes: 12 additions & 2 deletions demos/interactive_face_detection_demo/cpp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,9 +94,19 @@ Options:

Running the application with an empty list of options yields the usage message given above and an error message.

To run the demo, you can use public or pre-trained models. To download the pre-trained models, use the OpenVINO [Model Downloader](../../../tools/downloader/README.md). The list of models supported by the demo is in [models.lst](./models.lst).
To run the demo, you can use public or Intel pre-trained models. You can download models and if necessary convert them into Inference Engine format using the OpenVINO [Model Downloader and other automation tools](../../../tools/downloader/README.md) as shown in the examples below. The models which are supported by the demo are listed in the [models.lst](./models.lst) file.
vladimir-dudnik marked this conversation as resolved.
Show resolved Hide resolved

> **NOTE**: Before running the demo with a trained model, make sure the model is converted to the Inference Engine format (\*.xml + \*.bin) using the [Model Optimizer tool](https://docs.openvinotoolkit.org/latest/_docs_MO_DG_Deep_Learning_Model_Optimizer_DevGuide.html).
An example of using the Model Downloader:
```
python3 downloader.py --list models.lst
IRDonch marked this conversation as resolved.
Show resolved Hide resolved
```

An example of using the Model Converter:
```
python3 converter.py --list models.lst
```

> **NOTE**: Before running the demo with a trained model, make sure the model is downloaded and converted to the Inference Engine format (\*.xml + \*.bin) using OpenVINO™ [Model Downloader and other automation tools](../../../tools/downloader/README.md).
IRDonch marked this conversation as resolved.
Show resolved Hide resolved

For example, to do inference on a GPU with the OpenVINO™ toolkit pre-trained models, run the following command:

Expand Down
12 changes: 11 additions & 1 deletion demos/interactive_face_detection_demo/cpp_gapi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,17 @@ Options:

Running the application with an empty list of options yields the usage message given above and an error message.

To run the demo, you can use public or pre-trained models. To download the pre-trained models, use the OpenVINO [Model Downloader](../../../tools/downloader/README.md). The list of models supported by the demo is in [models.lst](models.lst).
To run the demo, you can use public or Intel pre-trained models. You can download models and if necessary convert them into Inference Engine format using the OpenVINO™ [Model Downloader and other automation tools](../../../tools/downloader/README.md) as shown in the examples below. The models which are supported by the demo are listed in the [models.lst](./models.lst) file.

An example of using the Model Downloader:
```
python3 downloader.py --list models.lst
```

An example of using the Model Converter:
```
python3 converter.py --list models.lst
```

> **NOTE**: Before running the demo with a trained model, make sure the model is converted to the Inference Engine format (\*.xml + \*.bin) using the [Model Optimizer tool](https://docs.openvinotoolkit.org/latest/_docs_MO_DG_Deep_Learning_Model_Optimizer_DevGuide.html).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,19 @@ A trained model of ICNet for fast semantic segmentation, trained on the CamVid\*

The model input is a blob that consists of a single image of `1x3x720x960` in the BGR order. The pixel values are integers in the [0, 255] range.

The model output for `icnet-camvid-ava-0001` is the predicted class index of each input pixel belonging to one of the 12 classes of the CamVid dataset.
The model output for `icnet-camvid-ava-0001` is the predicted class index of each input pixel belonging to one of the 12 classes of the CamVid dataset:
- Sky
- Building
- Pole
- Road
- Pavement
- Tree
- SignSymbol
- Fence
- Vehicle
- Pedestrian
- Bike
- Unlabeled
IRDonch marked this conversation as resolved.
Show resolved Hide resolved

## Specification

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,19 @@ A trained model of ICNet for fast semantic segmentation, trained on the CamVid\*

The model input is a blob that consists of a single image of `1x3x720x960` in the BGR order. The pixel values are integers in the [0, 255] range.

The model output for `icnet-camvid-ava-sparse-30-0001` is the predicted class index of each input pixel belonging to one of the 12 classes of the CamVid dataset.
The model output for `icnet-camvid-ava-sparse-30-0001` is the predicted class index of each input pixel belonging to one of the 12 classes of the CamVid dataset:
- Sky
- Building
- Pole
- Road
- Pavement
- Tree
- SignSymbol
- Fence
- Vehicle
- Pedestrian
- Bike
- Unlabeled

## Specification

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,19 @@ A trained model of ICNet for fast semantic segmentation, trained on the CamVid\*

The model input is a blob that consists of a single image of `1x3x720x960` in the BGR order. The pixel values are integers in the [0, 255] range.

The model output for `icnet-camvid-ava-sparse-60-0001` is the predicted class index of each input pixel belonging to one of the 12 classes of the CamVid dataset.
The model output for `icnet-camvid-ava-sparse-60-0001` is the predicted class index of each input pixel belonging to one of the 12 classes of the CamVid dataset:
- Sky
- Building
- Pole
- Road
- Pavement
- Tree
- SignSymbol
- Fence
- Vehicle
- Pedestrian
- Bike
- Unlabeled

## Specification

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,19 @@ This is a U-Net model that is designed to perform semantic segmentation. The mod

The model input is a blob that consists of a single image of `1x3x368x480` in the BGR order. The pixel values are integers in the [0, 255] range.

The model output for `unet-camvid-onnx-0001` is the per-pixel probabilities of each input pixel belonging to one of the 12 classes of the CamVid dataset.
The model output for `unet-camvid-onnx-0001` is the per-pixel probabilities of each input pixel belonging to one of the 12 classes of the CamVid dataset:
- Sky
- Building
- Pole
- Road
- Pavement
- Tree
- SignSymbol
- Fence
- Vehicle
- Pedestrian
- Bike
- Unlabeled

## Specification

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ where each number corresponds to [`num_anchors`, `cls_reg_obj_params`, `y_loc`,
- `cls_reg_obj_params`: parameters for classification and regression. The values are made up of the following:
* Regression parameters (4)
* Objectness score (1)
* Class score (20)
* Class score (20), mapping to class names provided by `<omz_dir>/data/dataset_classes/voc_20cl.txt` file.
- `y_loc` and `x_loc`: spatial location of each grid

## Legal Information
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ where each number corresponds to [`num_anchors`, `cls_reg_obj_params`, `y_loc`,
- `cls_reg_obj_params`: parameters for classification and regression. The values are made up of the following:
* Regression parameters (4)
* Objectness score (1)
* Class score (20)
* Class score (20), mapping to class names provided by `<omz_dir>/data/dataset_classes/voc_20cl.txt` file.
- `y_loc` and `x_loc`: spatial location of each grid

## Legal Information
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ where each number corresponds to [`num_anchors`, `cls_reg_obj_params`, `y_loc`,
- `cls_reg_obj_params`: parameters for classification and regression. The values are made up of the following:
* Regression parameters (4)
* Objectness score (1)
* Class score (20)
* Class score (20), mapping to class names provided by `<omz_dir>/data/dataset_classes/voc_20cl.txt` file.
- `y_loc` and `x_loc`: spatial location of each grid

## Legal Information
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ where each number corresponds to [`num_anchors`, `cls_reg_obj_params`, `y_loc`,
- `cls_reg_obj_params`: parameters for classification and regression. The values are made up of the following:
* Regression parameters (4)
* Objectness score (1)
* Class score (20)
* Class score (20), mapping to class names provided by `<omz_dir>/data/dataset_classes/voc_20cl.txt` file.
- `y_loc` and `x_loc`: spatial location of each grid

## Legal Information
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ where each number corresponds to [`num_anchors`, `cls_reg_obj_params`, `y_loc`,
- `cls_reg_obj_params`: parameters for classification and regression. The values are made up of the following:
* Regression parameters (4)
* Objectness score (1)
* Class score (20)
* Class score (20), mapping to class names provided by `<omz_dir>/data/dataset_classes/voc_20cl.txt` file.
- `y_loc` and `x_loc`: spatial location of each grid

## Legal Information
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ where each number corresponds to [`num_anchors`, `cls_reg_obj_params`, `y_loc`,
- `cls_reg_obj_params`: parameters for classification and regression. The values are made up of the following:
* Regression parameters (4)
* Objectness score (1)
* Class score (20)
* Class score (20), mapping to class names provided by `<omz_dir>/data/dataset_classes/voc_20cl.txt` file.
- `y_loc` and `x_loc`: spatial location of each grid

## Legal Information
Expand Down
14 changes: 14 additions & 0 deletions models/public/Sphereface/Sphereface.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,20 @@ Face embeddings, name - `fc5`, shape - `1,512`, output data format - `B,C`, wh

The net outputs on different images are comparable in cosine distance.

## Download a Model and Convert it into OpenVINO™ Inference Engine Format

You can download models and if necessary convert them into Inference Engine format using the OpenVINO™ [Model Downloader and other automation tools](../../../tools/downloader/README.md) as shown in the examples below.

An example of using the Model Downloader:
```
python3 downloader.py --name <model_name>
```

An example of using the Model Converter:
```
python3 converter.py --name <model_name>
```

## Legal Information

The original model is distributed under the following
Expand Down
18 changes: 16 additions & 2 deletions models/public/aclnet-int8/aclnet-int8.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,18 +50,32 @@ Audio, name - `result.1`, shape - `1,1,1,L`, format is `N,C,1,L` where:

### Original Model

Sound classifier (see labels file, `<omz_dir>/data/dataset_classes/aclnet.txt`), name - `486`, shape - `1,53`, output data format is `N,C` where:
Sound classifier (see labels file, `<omz_dir>/data/dataset_classes/aclnet_53cl.txt`), name - `486`, shape - `1,53`, output data format is `N,C` where:

- `N` - batch size
- `C` - Predicted softmax scores for each class in [0, 1] range

### Converted Model

Sound classifier (see labels file, `<omz_dir>/data/dataset_classes/aclnet.txt`), name - `486`, shape - `1,53`, output data format is `N,C` where:
Sound classifier (see labels file, `<omz_dir>/data/dataset_classes/aclnet_53cl.txt`), name - `486`, shape - `1,53`, output data format is `N,C` where:

- `N` - batch size
- `C` - Predicted softmax scores for each class in [0, 1] range

## Download a Model and Convert it into OpenVINO™ Inference Engine Format

You can download models and if necessary convert them into Inference Engine format using the OpenVINO™ [Model Downloader and other automation tools](../../../tools/downloader/README.md) as shown in the examples below.

An example of using the Model Downloader:
```
python3 downloader.py --name <model_name>
```

An example of using the Model Converter:
```
python3 converter.py --name <model_name>
```

## Legal Information

The original model is distributed under [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0.html).
18 changes: 16 additions & 2 deletions models/public/aclnet/aclnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,18 +49,32 @@ Audio, name - `input`, shape - `1,1,1,L`, format is `N,C,1,L` where:

### Original Model

Sound classifier (see labels file, `<omz_dir>/data/dataset_classes/aclnet.txt`), name - `203`, shape - `1,53`, output data format is `N,C` where:
Sound classifier (see labels file, `<omz_dir>/data/dataset_classes/aclnet_53cl.txt`), name - `203`, shape - `1,53`, output data format is `N,C` where:

- `N` - batch size
- `C` - Predicted softmax scores for each class in [0, 1] range

### Converted Model

Sound classifier (see labels file, `<omz_dir>/data/dataset_classes/aclnet.txt`), name - `203`, shape - `1,53`, output data format is `N,C` where:
Sound classifier (see labels file, `<omz_dir>/data/dataset_classes/aclnet_53cl.txt`), name - `203`, shape - `1,53`, output data format is `N,C` where:

- `N` - batch size
- `C` - Predicted softmax scores for each class in [0, 1] range

## Download a Model and Convert it into OpenVINO™ Inference Engine Format

You can download models and if necessary convert them into Inference Engine format using the OpenVINO™ [Model Downloader and other automation tools](../../../tools/downloader/README.md) as shown in the examples below.

An example of using the Model Downloader:
```
python3 downloader.py --name <model_name>
```

An example of using the Model Converter:
```
python3 converter.py --name <model_name>
```
IRDonch marked this conversation as resolved.
Show resolved Hide resolved

## Legal Information

The original model is distributed under [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0.html).
14 changes: 14 additions & 0 deletions models/public/alexnet/alexnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,20 @@ Object classifier according to ImageNet classes, name - `prob`, shape - `1,1000`
- `C` - Predicted probabilities for each class in [0, 1] range


## Download a Model and Convert it into OpenVINO™ Inference Engine Format

You can download models and if necessary convert them into Inference Engine format using the OpenVINO™ [Model Downloader and other automation tools](../../../tools/downloader/README.md) as shown in the examples below.

An example of using the Model Downloader:
```
python3 downloader.py --name <model_name>
```

An example of using the Model Converter:
```
python3 converter.py --name <model_name>
```

## Legal Information

The original model is distributed under the following
Expand Down
20 changes: 17 additions & 3 deletions models/public/anti-spoof-mn3/anti-spoof-mn3.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ For details see original [repository](https://github.com/kirillProkofiev/light-w
| Metric | Value |
|---------------------------------|-------------------------------------------|
| Type | Classification |
| GFlops | 0.15 |
| MParams | 3.02 |
| Source framework | PyTorch\* |
| GFlops | 0.15 |
| MParams | 3.02 |
| Source framework | PyTorch\* |

## Accuracy

Expand Down Expand Up @@ -63,6 +63,20 @@ Probabilities for two classes (0 class is a real person, 1 - is a spoof image).
- B - batch size
- C - vector of probabilities.

## Download a Model and Convert it into OpenVINO™ Inference Engine Format

You can download models and if necessary convert them into Inference Engine format using the OpenVINO™ [Model Downloader and other automation tools](../../../tools/downloader/README.md) as shown in the examples below.

An example of using the Model Downloader:
```
python3 downloader.py --name <model_name>
```

An example of using the Model Converter:
```
python3 converter.py --name <model_name>
```

## Legal Information

The original model is distributed under the
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,20 @@ Probabilities of the given voxel to be in the corresponding class, name - `softm

With the following channels: `background`, `necrotic core`, `edema` and `enhancing tumor`.

## Download a Model and Convert it into OpenVINO™ Inference Engine Format

You can download models and if necessary convert them into Inference Engine format using the OpenVINO™ [Model Downloader and other automation tools](../../../tools/downloader/README.md) as shown in the examples below.

An example of using the Model Downloader:
```
python3 downloader.py --name <model_name>
```

An example of using the Model Converter:
```
python3 converter.py --name <model_name>
```

## Legal Information

The original model is distributed under the
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,20 @@ Probabilities of the given voxel to be in the corresponding class, name - `304`,

The channels are ordered as `whole tumor`, `tumor core`, and `enhancing tumor`.

## Download a Model and Convert it into OpenVINOâ„¢ Inference Engine Format

You can download models and if necessary convert them into Inference Engine format using the OpenVINOâ„¢ [Model Downloader and other automation tools](../../../tools/downloader/README.md) as shown in the examples below.

An example of using the Model Downloader:
```
python3 downloader.py --name <model_name>
```

An example of using the Model Converter:
```
python3 converter.py --name <model_name>
```

## Legal Information

The original model is distributed under the
Expand Down
Loading