// Copyright 2023 Ant Group Co., Ltd.
// 
// 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.
//

syntax = "proto3";

package secretflowapis.v1.sdc.teeapps.params;

option java_package = "com.alipay.secretflow.secretflowapis.v1.sdc.teeapps.params";
option java_outer_classname = "StatsCorrProto";

// Corr 的输出是一个N*N的对称矩阵，N为特征数
// 其中Corr(i, j)含义为i和j之间的corr值为多少
// 也就是下面单个Coefficient所表达的含义

// value正常值为 [-1, 1]，但可能出现以下异常值:
//   (1, 1.02) or (-1.02, -1):
//     数据进出密态导致的精度问题，属于正常现象，可以认为是1 or -1
//     前端可以直接将这个范围内的值显示为1 or -1
//   99:
//     corr全为99的特征列为常量列
//     提示用户检查输入数据集，忽略常量列的值，其他列的结果不受影响可正常使用。
//   其他：
//     目前未知的异常情况，请用户联系值班/客服
message StatsCorrReport {
  message Coefficient {
    string source_feature_name = 1;
    string target_feature_name = 2;
    double value = 3;
  }
  repeated Coefficient coefficients = 1;
}