itlab_2023

Name

Short description

Building a Project

Windows

To build and run this project locally on Windows, follow these steps:

1. Clone the repository:
   Clone this repository to your local machine using the following command:

   git clone https://github.com/embedded-dev-research/itlab_2023.git

2. Update submodules: Navigate to the project directory and update the submodules:

   git submodule update --init --recursive

3. Configure the project: Create a separate directory for configure the project and compile it:

   mkdir build
   cd build
   cmake ..

   Note: Make sure you have CMake installed to build the project.
4. Build the project: Next, to build the project, we will need to enter the command

   cmake --build . --config Release

   If you want to build in a debug, change the release to debug
5. Run the project After building the project, you can find the executable file in the following path from the build folder

   cd app\Release

   and run the file

   Reader.exe

Linux/macOS

To build and run this project locally on Linux or macOS, follow these steps:

1. Clone the repository:
   Clone this repository to your local machine using the following command:

   git clone https://github.com/embedded-dev-research/itlab_2023.git

2. Update submodules: Navigate to the project directory and update the submodules:

   git submodule update --init --recursive

3. Install necessary dependencies:
   1. OpenMP Debian/Ubuntu:

   sudo apt-get install -y libomp-dev

   macOS:

   brew install libomp
   

4. Configure the project: Create a separate directory for configure the project and compile it:

   cmake -S . -B build

   Note: Make sure you have CMake installed to build the project. For macOS need to specify the path to omp.h file:

   cmake -S . -B build -DCMAKE_CXX_FLAGS="-I$(brew --prefix libomp)/include" -DCMAKE_C_FLAGS="-I$(brew --prefix libomp)/include"

5. Build the project: Next, to build the project, we will need to enter the command

   cmake --build build --config Release

   If you want to build in a debug, change the release to debug
6. Run the project After building the project, you can find the executable file in the following path from the build folder

   cd build/app

   and run the file

   ./Reader

Test Process

This project contains tests to verify functionality. To test the project, the Google Test Framework is used as a submodule of the project.

Google Test Framework

Google Test is a powerful framework for unit testing in C++. In this project, Google Test is a submodule. When building the project, you have already updated it, and it is ready for use.

Running tests

Windows

To start the testing process locally, you need to go to the directory

cd test\Release

and run the following files:

run_test.exe

Linux

To start the testing process locally, you need to go to the directory

cd build/test

and run the following files:

chmod +x run_test
./run_test

Some files used to create the library

neural network models

Alexnet-model.h5

How do I get a file with the weights of the model to launch the inference?

You need to run the script parcer.py that is located in app/AlexNet to read weights from a model Alexnet-model.h5 and the json file with the weights will be stored in the docs folder.

Structure of our library