xref: /aosp_15_r20/external/federated-compute/fcp/client/fcp_runner.h (revision 14675a029014e728ec732f129a32e299b2da0601)
1 /*
2  * Copyright 2023 Google LLC
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef FCP_CLIENT_FCP_RUNNER_H_
18 #define FCP_CLIENT_FCP_RUNNER_H_
19 
20 #include <string>
21 
22 #include "fcp/client/fl_runner.pb.h"
23 #include "fcp/client/flags.h"
24 #include "fcp/client/interruptible_runner.h"
25 #include "fcp/client/log_manager.h"
26 #include "fcp/client/simple_task_environment.h"
27 #include "fcp/protos/plan.pb.h"
28 
29 namespace fcp {
30 namespace client {
31 
32 // This is exposed for use that only invoke run plan on engine and exclude http
33 // protocol parts.
34 absl::StatusOr<FLRunnerResult> RunFederatedComputation(
35     SimpleTaskEnvironment* env_deps, LogManager* log_manager,
36     const Flags* flags,
37     const google::internal::federated::plan::ClientOnlyPlan& client_plan,
38     const std::string& checkpoint_input_filename,
39     const std::string& checkpoint_output_filename,
40     const std::string& session_name, const std::string& population_name,
41     const std::string& task_name,
42     const fcp::client::InterruptibleRunner::TimingConfig& timing_config);
43 
44 }  // namespace client
45 }  // namespace fcp
46 
47 #endif  // FCP_CLIENT_FCP_RUNNER_H_