Welcome to TeiaCareInferenceClient!
TeiaCareInferenceClient is a C++ inference client library that implements KServe protocol.
Docs Codacy Badge Codacy Badge
This project uses git submodules so it is required to clone it using the --recursive flag in order to retrive the required submodules.
git clone https://github.com/TeiaCare/TeiaCareInferenceClient.git --recursive
In order to setup a development environment it is sufficient to run the script scripts/env/setup.<bat|sh> depending on your operating system.
# Linux/MacOS scripts/env/setup.sh # Windows scripts\env\setup.bat
In order to start the development environment it is sufficient to activate the Python Virtual Environment just created the step above.
# Linux/MacOS source .venv/bin/activate # Windows .venv\Scripts\activate.bat
When building from command line on Windows it is necessary to activate the Visual Studio Developer Command Prompt.
Depending on the version of Visual Studio compiler and on its install location it is required to run vcvars64.bat script the set the development environment properly.
Note: using Visual Studio IDE or the CMake extension for VSCode this step is already managed in the background, so no action is required.
Examples:
# Visual Studio 2022 - Build Tools "C:\Program Files (x86)\Microsoft Visual Studio2022円\BuildTools\VC\Auxiliary\Build\vcvars64.bat" # Visual Studio 2019 - Enterprise "C:\Program Files (x86)\Microsoft Visual Studio2019円\Enterprise\VC\Auxiliary\Build\vcvars64.bat"
This script must be executed in order to setup the 3rd party dependencies using conan packages.
conan remote add teiacare https://artifactory.app.teiacare.com/artifactory/api/conan/teiacare --insert 0 --force conan user <USERNAME> -p <PASSWORD> -r teiacare python scripts/conan/setup.py <Debug|Release|RelWithDebInfo> <COMPILER_NAME> <COMPILER_VERSION>
This script configures, builds and installs the library.
python scripts/cmake.py <Debug|Release|RelWithDebInfo> <COMPILER_NAME> <COMPILER_VERSION>
# Build all the examples python scripts/cmake.py <Debug|Release|RelWithDebInfo> <COMPILER_NAME> <COMPILER_VERSION> --examples --warnings # Run all the examples python scripts/tools/run_examples.py install/examples
Examples are installed in $PWD/install/examples.
# Build Unit Tests with Code Coverage enabled (if supported) python scripts/cmake.py <Debug|Release|RelWithDebInfo> <COMPILER_NAME> <COMPILER_VERSION> --coverage --warnings # Run Unit Tests python scripts/tools/run_unit_tests.py <Debug|Release|RelWithDebInfo> # Run Code Covergae python scripts/tools/run_coverage.py <COMPILER_NAME> <COMPILER_VERSION>
Note that code coverage is not available on Windows.
Unit tests results are available in $PWD/results/unit_tests. Coverage results are available in $PWD/results/coverage.
# Build Unit Tests with Address Sanitizer enabled (if supported) python scripts/cmake.py <Debug|Release|RelWithDebInfo> <COMPILER_NAME> <COMPILER_VERSION> --address_sanitizer --unit_tests # Run Unit Tests with Address Sanitizer python scripts/tools/run_sanitizer.py --address_sanitizer install/unit_tests/teiacare_inference_client_unit_tests
Note that Address Sanitizer is supported only on Linux.
# Build Unit Tests with Thread Sanitizer enabled (if supported) python scripts/cmake.py <Debug|Release|RelWithDebInfo> <COMPILER_NAME> <COMPILER_VERSION> --thread_sanitizer --unit_tests # Run Unit Tests with Thread Sanitizer python scripts/tools/run_sanitizer.py --thread_sanitizer install/unit_tests/teiacare_inference_client_unit_tests
Note that Thread Sanitizer is supported only on Linux.
# Build Benkmarks python scripts/cmake.py <Debug|Release|RelWithDebInfo> <COMPILER_NAME> <COMPILER_VERSION> --benchmarks --warnings # Run Benchmarks python scripts/tools/run_benchmarks.py <COMPILER_NAME> <COMPILER_VERSION>
Benchmarks are installed in $PWD/install/benchmarks.
clang-format can be installed via pip using the provided scripts/requirements.txt
python scripts/tools/run_clang_format.py -r -i inference_client
clang-tidy can be installed via pip using the provided scripts/requirements.txt
python scripts/tools/run_clang_tidy.py -header-filter=.* inference_clientFirst install and setup cppcheck from your OS package manager.
# Linux sudo apt install cppcheck # Windows winget install cppcheck
Then run CppCheck using the provided python script:
python scripts/tools/run_cppcheck.py <Debug|Release|RelWithDebInfo>
First install and setup Doxygen from your OS package manager.
# Linux apt-get install doxygen graphviz # Windows winget install doxygen
Then run Doxygen using the provided python script:
python scripts/tools/run_doxygen.py
Documentation is now installed in $PWD/docs.
Create, test and install local package.
Notes:
- The install directory path must be a valid Conan cache (i.e. ".conan" folder) located in the current directory. So, in order to install the package in a desired repository folder, it is required to run this script from the repository folder directly.
- The Conan package tests are automatically run during package creation. The directory test_package contains a test project that is built to validate the proper package creation.
# Create the Conan package locally python scripts/conan/create.py <Debug|Release|RelWithDebInfo> <COMPILER_NAME> <COMPILER_VERSION> # Build and install the test package executable python test_package/build.py <Debug|Release|RelWithDebInfo> <COMPILER_NAME> <COMPILER_VERSION> # Run the test package executable $PWD/install/test_package/teiacare_inference_client_test_package
In order to upload a Conan package to TeiaCare Artifactory server it is required to setup you local Conan client once with the following commands:
# Add TeiaCare Artifactory remote to local Conan client conan remote add teiacare $(artifactory.url)/teiacare # Authenticate with Artifactory credentials conan user $(artifactory.username) -p $(artifactory.password) -r teiacare
Now it is possible to create and upload a Conan package with the following commands:
# Create the Conan package locally python scripts/conan/create.py <Debug|Release|RelWithDebInfo> <COMPILER_NAME> <COMPILER_VERSION> # Upload the package to Artifactory on the teicare remote python scripts/conan/upload.py teiacare teiacare_inference_client
In order to contribute to TeiaCareInferenceClient, please follow our contribution guidelines.
This project is licensed under the Apache License, Version 2.0. Copyright © 2024 TeiaCare