Use C++ SDK package in the C++ quickstart example (#2545)

.github/workflows/cpp.yml

@@ -60,12 +60,12 @@ jobs:
     - name: Run cppcheck
       run: |
         cd build
-        cppcheck --enable=all --inline-suppr --suppress=missingIncludeSystem -I../src/cc/flwr/include ../src/cc/flwr/src
+        cppcheck --enable=all -I../src/cc/flwr/include ../src/cc/flwr/src
 
     - name: End-to-end test
       run: |
         cd examples/quickstart-cpp
-        cmake -S . -B build
+        cmake -DUSE_LOCAL_FLWR=ON -S . -B build
         cmake --build build
         pip install ../..
         timeout 2m python server.py &

examples/quickstart-cpp/CMakeLists.txt

@@ -3,6 +3,7 @@ project(SimpleCppFlowerClient VERSION 0.10
   DESCRIPTION "Creates a Simple C++ Flower client that trains a linear model on synthetic data."
   LANGUAGES CXX)
 set(CMAKE_CXX_STANDARD 17)
+option(USE_LOCAL_FLWR "Use local Flower directory instead of fetching from GitHub" OFF)
 
 ######################
 ### Download gRPC 
@@ -28,8 +29,24 @@ endif()
 
 ######################
 ### FLWR_LIB
+if(USE_LOCAL_FLWR)
+  set(FLWR_SOURCE_ROOT "${CMAKE_CURRENT_SOURCE_DIR}/../..")
+else()
+  FetchContent_Declare(
+    flwr_repo
+    GIT_REPOSITORY https://github.com/adap/flower.git
+    GIT_TAG        main
+  )
+
+  FetchContent_GetProperties(flwr_repo)
+  if(NOT flwr_repo_POPULATED)
+    FetchContent_Populate(flwr_repo)
+  endif()
+
+  set(FLWR_SOURCE_ROOT "${flwr_repo_SOURCE_DIR}")
+endif()
 
-set(FLWR_SDK_PATH "../../src/cc/flwr")
+set(FLWR_SDK_PATH "${FLWR_SOURCE_ROOT}/src/cc/flwr")
 
 file(GLOB FLWR_SRCS "${FLWR_SDK_PATH}/src/*.cc")
 file(GLOB FLWR_PROTO_SRCS "${FLWR_SDK_PATH}/include/flwr/proto/*.cc")

examples/quickstart-cpp/include/line_fit_model.h

@@ -7,11 +7,11 @@
 
 #include <vector>
 
-#include "synthetic_dataset.h"
 #include "linear_algebra_util.h"
+#include "synthetic_dataset.h"
 #include <cstddef>
 class LineFitModel {
- public:
+public:
   LineFitModel(int num_iterations, double learning_rate, int num_params);
 
   std::vector<double> predict(std::vector<std::vector<double>> X);
@@ -30,7 +30,7 @@ class LineFitModel {
 
   size_t get_model_size();
 
- private:
+private:
   int num_iterations;
   int batch_size;
   double learning_rate;
@@ -41,4 +41,4 @@ class LineFitModel {
   double compute_mse(std::vector<double> true_y, std::vector<double> pred);
 };
 
-#endif //FLOWER_CPP_LINE_FIT_MODEL_H
+#endif // FLOWER_CPP_LINE_FIT_MODEL_H

examples/quickstart-cpp/include/linear_algebra_util.h

@@ -8,17 +8,21 @@
 #include <vector>
 
 class LinearAlgebraUtil {
- public:
-  static std::vector<double> subtract_vector(std::vector<double> v1, std::vector<double> v2);
+public:
+  static std::vector<double> subtract_vector(std::vector<double> v1,
+                                             std::vector<double> v2);
 
-  static std::vector<double> multiply_matrix_vector(std::vector<std::vector<double>> mat, std::vector<double> v);
+  static std::vector<double>
+  multiply_matrix_vector(std::vector<std::vector<double>> mat,
+                         std::vector<double> v);
 
   static std::vector<double> add_vector_scalar(std::vector<double> v, double a);
 
-  static std::vector<double> multiply_vector_scalar(std::vector<double> v, double a);
-
-  static std::vector<std::vector<double>> transpose_vector(std::vector<std::vector<double>> v);
+  static std::vector<double> multiply_vector_scalar(std::vector<double> v,
+                                                    double a);
 
+  static std::vector<std::vector<double>>
+  transpose_vector(std::vector<std::vector<double>> v);
 };
 
-#endif //FLOWER_CPPV2_LINEAR_ALGEBRA_UTIL_H
+#endif // FLOWER_CPPV2_LINEAR_ALGEBRA_UTIL_H

examples/quickstart-cpp/include/simple_client.h

@@ -11,40 +11,40 @@
  * ********************************************************************************************************/
 #pragma once
 #include "client.h"
-#include "synthetic_dataset.h"
 #include "line_fit_model.h"
+#include "synthetic_dataset.h"
 #include <ctime>
+#include <iostream>
+#include <list>
 #include <memory>
+#include <sstream>
 #include <string>
 #include <tuple>
-#include <iostream>
-#include <sstream>
 #include <vector>
-#include <list>
 /**
  * Validate the network on the entire test set
  *
  */
 
 class SimpleFlwrClient : public flwr_local::Client {
- public:
-  SimpleFlwrClient(std::string client_id,
-                   LineFitModel &model,
+public:
+  SimpleFlwrClient(std::string client_id, LineFitModel &model,
                    SyntheticDataset &training_dataset,
                    SyntheticDataset &validation_dataset,
                    SyntheticDataset &test_dataset);
   void set_parameters(flwr_local::Parameters params);
 
   virtual flwr_local::ParametersRes get_parameters() override;
-  virtual flwr_local::PropertiesRes get_properties(flwr_local::PropertiesIns ins) override;
-  virtual flwr_local::EvaluateRes evaluate(flwr_local::EvaluateIns ins) override;
+  virtual flwr_local::PropertiesRes
+  get_properties(flwr_local::PropertiesIns ins) override;
+  virtual flwr_local::EvaluateRes
+  evaluate(flwr_local::EvaluateIns ins) override;
   virtual flwr_local::FitRes fit(flwr_local::FitIns ins) override;
 
- private:
+private:
   int64_t client_id;
   LineFitModel &model;
   SyntheticDataset &training_dataset;
   SyntheticDataset &validation_dataset;
   SyntheticDataset &test_dataset;
-
 };

examples/quickstart-cpp/include/synthetic_dataset.h

@@ -5,11 +5,12 @@
 #ifndef FLOWER_CPP_SYNTHETIC_DATASET_H
 #define FLOWER_CPP_SYNTHETIC_DATASET_H
 
-#include <vector>
 #include <cstddef>
+#include <vector>
 class SyntheticDataset {
- public:
-  // Generates the synthetic dataset of size size around given vector m of size ms_size and given bias b.
+public:
+  // Generates the synthetic dataset of size size around given vector m of size
+  // ms_size and given bias b.
   SyntheticDataset(std::vector<double> ms, double b, size_t size);
 
   // Returns the size of the dataset.
@@ -20,7 +21,7 @@ class SyntheticDataset {
 
   int get_features_count();
 
- private:
+private:
   std::vector<double> ms;
   double b;
 
@@ -30,4 +31,4 @@ class SyntheticDataset {
   std::vector<std::vector<double>> data_points;
 };
 
-#endif //FLOWER_CPP_SYNTHETIC_DATASET_H
+#endif // FLOWER_CPP_SYNTHETIC_DATASET_H