PlusML is a C++ library that aims to provide implementations of common machine learning algorithms with clean API.

Getting Started

The PlusML library can be installed via git submodule.

Navigate to the project's directory and run

git submodule add https://github.com/hashlag/plusml

then initialize and update submodules

git submodule update --init --recursive

Now you can compose your main CMakeLists.txt to add PlusML to your project.

Example for Windows systems:

cmake_minimum_required(VERSION 3.27)
project(myproject)
 
set(CMAKE_CXX_STANDARD 20)
 
# Add PlusML directory to the project
add_subdirectory(plusml)
 
add_executable(myproject main.cpp)
 
# Link PlusML to your executable
target_link_libraries(myproject PRIVATE plusml)
 
# Include PlusML headers
target_include_directories(myproject PRIVATE plusml/include)
 
# Copy plusml.dll to the directory with your project's executable after building
add_custom_command(TARGET myproject POST_BUILD
        COMMAND ${CMAKE_COMMAND} -E copy_if_different
        $<TARGET_FILE_DIR:plusml>/plusml.dll
        $<TARGET_FILE_DIR:myproject>
        COMMENT "Copying plusml.dll"
)

After configuring CMake you can build your project via CMake CLI or your favourite IDE tools.

Manual building may look like this:

cmake -S . -B ./build-dir

cmake --build ./build-dir

Where . is your project's directory.

Usage

After installing the library you can use provided algorithms by including corresponding headers.

API information is provided in docs.

Basic example:

 ++
#include <iostream>
#include <PlusML/linear_regression.h>
 
int main() {
    plusml::LinearRegression model(2);
 
    std::cout << model.Parameters();
 
    return 0;
}

Returns

0
0
0

since we have two features, bias is enabled by default and parameters are initialized with zeros.

Docs

PlusML provides auto-generated docs via Doxygen.

Feel free to explore it:

Testing

Tests for all implemented algorithms are placed at the test/ directory along with testcase generators.

CMake configuration for tests is also provided, just uncomment the corresponding section in CMakeLists.txt according to the hints.

Dependencies

PlusML depends on Eigen linear algebra library which is installed as a git submodule and does not require any dependencies other than the C++ standard library.

We also use GoogleTest for testing purposes but PlusML does not require it to run.

License