Write the build and test system for the following library:
We want to write an “efficient” python library that takes an array of numbers and sorts them.
We want the “compute” intensive part to be implemented in C/C++ while provide python bindings so that our library can be called by our ML engineer who is not C/C++ experienced
The framework, called AxeleraFramework has C++ function which is sorting the given array, and python bindings to call C++ function from python. The framework has unit tests which are testing the C++ function, and python tests which are testing the python bindings. All of operations in the framework are running in docker container. The framework is also integrated with Github Actions CI/CD pipeline.
In order to build and run the framework, you should have docker installed on your system.
The project is tested on Mac OS Ventura 13.6 (22G120) and Docker version 20.10.23, build 7155243.
The docker image is based on Ubuntu Jammy 22.04.
The framework supports only amd64 architecture. Will be supported other architectures in the future.
To build the framework, you should run the following command in the root directory of the project:
./docker.sh -v ./build.sh --build-dir build_amd64 --build-type ReleaseThe framework will be built in build_amd64 directory, and automatically installed in /usr/lib directory in the docker container.
If you have the same architecture with amd64 and platform Ubuntu Jammy, you can install the framework on your system by running the following command in the root directory of the project after building the framework:
./build.sh --build-dir build_amd64 --only-installTo run tests, you should run the following command in the root directory of the project:
./docker.sh -v ./test.sh --build-dir test_build_amd64 --build-type Release --all-testsAlso, you can run only C++ unit tests or python bindings tests by running the following command in the root directory of the project.
C++ unit tests:
./docker.sh -v ./test.sh --build-dir test_build_amd64 --build-type Release --cpp-testsPython bindings tests:
./docker.sh -v ./test.sh --build-dir test_build_amd64 --build-type Release --python-testsThe documentation of the framework is generated by Doxygen. The documentation will be available in docs in the build directory after building the framework. You can open index.html file in your browser to see the documentation.
Moreover, you can access the documentation when you install the framework on your system. The documentation will be available in /usr/share/doc/axelera_framework directory.
For more information, you can run the following command in the root directory of the project:
./docker.sh --help
./build.sh --help
./test.sh --help