Skip to content

Commit

Permalink
Readme fix (#562)
Browse files Browse the repository at this point in the history
  • Loading branch information
valentina-kustikova authored Dec 15, 2024
1 parent 40c3036 commit 7864b7b
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 27 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ as well as regularly publishing the obtained measurements.
The main advantage of DLI from the existing benchmarks
is the availability of performance results for a large number
of deep models inferred on Intel-platforms (Intel CPUs, Intel
Processor Graphics, Intel Movidius Neural Compute Stick).
Processor Graphics). In addition, there are benchmarking results
for several models inferred on RISC-V platform.

DLI supports inference using the following frameworks:

Expand Down Expand Up @@ -45,8 +46,7 @@ This project is licensed under the terms of the [Apache 2.0 license](LICENSE).
Please consider citing the following papers.

1. Kustikova V., Vasilyev E., Khvatov A., Kumbrasiev P., Rybkin R.,
Kogteva N. DLI: Dee
p Learning Inference Benchmark //
Kogteva N. DLI: Deep Learning Inference Benchmark //
Communications in Computer and Information Science.
V.1129. 2019. P. 542-553.

Expand All @@ -73,6 +73,10 @@ p Learning Inference Benchmark //
and Programming. - 2024. - Vol. 25(2). - P. 127-141. -
[https://num-meth.ru/index.php/journal/article/view/1332/1264][nummeth2023].
(In Russian)
1. Mukhin I., Rodimkov Y., Vasiliev E., Volokitin V., Sidorova A.,
Kozinov E., Meyerov I., Kustikova V. Benchmarking Deep Learning
Inference on RISC-V CPUs // Springer Lecture Notes in Computer
Science. – 2024. – Accepted.

## Repo structure

Expand All @@ -87,6 +91,7 @@ p Learning Inference Benchmark //
- `Dockerfile` is the main Dockerfile.
- `Caffe` is a directory of Dockerfiles for Intel® Optimization
for Caffe.
- `DGL` is a directory of Dockerfiles for Deep Graph Library (DGL).
- `MXNet` is a directory of Dockerfiles for MXNet.
- `ONNXRuntime` is a directory of Dockerfiles for ONNX Runtime.
- `OpenCV` is a directory of Dockerfiles for OpenCV.
Expand All @@ -96,6 +101,7 @@ p Learning Inference Benchmark //
- `TVM` is a directory of Dockerfiles for Apache TVM.
- `TensorFlow` is a directory of Dockerfiles for Intel® Optimizations
for TensorFlow.
- `TensorFlowLite` is a directory of Dockerfiles for TensorFlow Lite.
- `PaddlePaddle` is a directory of Dockerfiles for PaddlePaddle.

- `docs` directory contains auxiliary documentation. Please, find
Expand Down
55 changes: 31 additions & 24 deletions demo/README.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,50 @@
# Демонистрационное приложение
# Demo

## Описание приложения
## Description

### Основная информация
### Basic information

Скрипт позволяет запускать полный цикл работы системы DLI Benchmark, демонстрируя работоспособность всей системы целиком,
начиная от развертывания системы и заканчивая конвертацией таблиц с результатами.
На данный момент реализована версия для Linux систем с развертыванием системы DLI Benchmark с помощью Docker-контейнеров.
The script allows you to run the full cycle of the DLI
Benchmark system, demonstrating the operability of the entire
system, from system deployment to conversion of tables with
results. At the moment, a version for Linux systems with
the deployment of the DLI Benchmark using Docker containers
has been implemented.

### Алгоритм работы приложения
### Algorithm

Приложение создает на локальной машине две директории `server` и `client`, которые представляют собой
окружения для FTP-сервера и клиента соответственно. Результатом работы приложения являются CSV, HTML и XLSX таблицы с
результатами экспериментов измерения производительности и оценки качества работы глубокой модели `SampleNet`,
которая является тестовой моделью для инструмента [AccuracyChecker][accuracy-checker]
в составе пакета [Intel® Distribution of OpenVINO™ Toolkit][openvino-toolkit].
The application creates two directories on the local machine,
`server` and `client`, which represent the environments
for the FTP server and client, respectively. The output
of the application is CSV, HTML, and XLSX tables with
the results of the experiments measuring the performance
and assessing the quality of the deep `SampleNet` model,
which is a test model for the [AccuracyChecker][accuracy-checker]
tool in [Intel® Distribution of OpenVINO™ Toolkit][openvino-toolkit].

### Результаты работы приложения
### Application results

Результатом работы приложения является набор CSV, HTML и XLSX таблиц с результатами
экспериментов измерения производительности и оценки качества работы.
The output of the application is a set of CSV, HTML and XLSX
tables with the results of the experiments on measuring performance
and assessing the quality of the test model.

## Использование скрипта
## Usage

```bash
chmod a+x linux.sh
./linux.sh -l <login> -p <password> -d <benchmark_datasets>
```

Аргументы командной строки:
Command line arguments:

- `-l` - логин для подключения к текущей машине.
- `-p` - пароль для подключения к текущей машине.
- `-d` - адрес до GitHub-репозитория, который содержит в себе наборы данных для бенчмаркинга.
Требуется, чтобы в репозитории была создана директория `Datasets/ImageNET/`, в которой
хранится, по крайней мере, одно изображение.
Необходим для развертывания системы.
- `-l` corresponds to the login to connect to the current machine.
- `-p` corresponds to the password to connect to the current machine.
- `-d` corresponds to the GitHub repository that contains
the benchmarking datasets. It is required that the repository
contains the directory `Datasets/ImageNET/`, in which at least
one image is stored. It is necessary for system deployment.

Пример запуска в текущем окружении:
Example:

```bash
chmod a+x linux.sh
Expand Down

0 comments on commit 7864b7b

Please sign in to comment.