1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
|
/*
* Copyright 2021 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef FCP_CLIENT_ENGINE_COMMON_H_
#define FCP_CLIENT_ENGINE_COMMON_H_
#include <string>
#include <utility>
#include <vector>
#include "absl/container/flat_hash_set.h"
#include "absl/status/status.h"
#include "fcp/client/engine/engine.pb.h"
#include "fcp/client/stats.h"
#include "fcp/protos/plan.pb.h"
#include "tensorflow/core/framework/tensor.h"
namespace fcp {
namespace client {
namespace engine {
enum class PlanOutcome {
kSuccess,
// A TensorFlow error occurred.
kTensorflowError,
// Computation was interrupted.
kInterrupted,
// The input parameters are invalid.
kInvalidArgument,
// An example iterator error occurred.
kExampleIteratorError,
};
// The result of a call to `SimplePlanEngine::RunPlan` or
// `TfLitePlanEngine::RunPlan`.
struct PlanResult {
explicit PlanResult(PlanOutcome outcome, absl::Status status);
// The outcome of the plan execution.
PlanOutcome outcome;
// Only set if `outcome` is `kSuccess`, otherwise this is empty.
std::vector<tensorflow::Tensor> output_tensors;
// Only set if `outcome` is `kSuccess`, otherwise this is empty.
std::vector<std::string> output_names;
// When the outcome is `kSuccess`, the status is ok. Otherwise, this status
// contain the original error status which leads to the PlanOutcome.
absl::Status original_status;
::fcp::client::ExampleStats example_stats;
PlanResult(PlanResult&&) = default;
PlanResult& operator=(PlanResult&&) = default;
// Disallow copy and assign.
PlanResult(const PlanResult&) = delete;
PlanResult& operator=(const PlanResult&) = delete;
};
// Validates that the input tensors match what's inside the TensorflowSpec.
absl::Status ValidateTensorflowSpec(
const google::internal::federated::plan::TensorflowSpec& tensorflow_spec,
const absl::flat_hash_set<std::string>& expected_input_tensor_names_set,
const std::vector<std::string>& output_names);
PhaseOutcome ConvertPlanOutcomeToPhaseOutcome(PlanOutcome plan_outcome);
absl::Status ConvertPlanOutcomeToStatus(engine::PlanOutcome outcome);
} // namespace engine
} // namespace client
} // namespace fcp
#endif // FCP_CLIENT_ENGINE_COMMON_H_
|
