Commit f7ed79db authored by Mitar's avatar Mitar

Updating comments.

parent 6d11fe1b
Pipeline #129840711 passed with stage
in 4 minutes and 11 seconds
......@@ -20,15 +20,18 @@ extend google.protobuf.FileOptions {
option (protocol_version) = "2020.2.12_pre";
message ScoringConfiguration {
// The evaluation method to use. Standard values required
// to be supported for the "ScoreSolution" call are:
// The evaluation method to use. Standard values are required to
// be supported and are:
// * "HOLDOUT"
// * "K_FOLD"
// In addition, "RANKING" evaluation method can be used to ask
// TA2 to rank a solution as part of all found solutions of a given
// "SearchSolutions" call. Invalid to use before the "SearchSolutions"
// call, of which the solution is part of, has successfully completed
// or has been stopped. Only possible with "RANK" performance metric.
//
// In addition, "RANKING" evaluation method should be also supported.
// "RANKING" evaluation method can be used for a rank of a solution
// among all found solutions of a given "SearchSolutions" call.
// Invalid to use before the "SearchSolutions" call, of which the
// solution is part of, has successfully completed or has been stopped.
// Only possible with "RANK" performance metric.
//
// The following additional evaluation methods are defined to allow
// expressing internal evaluation methods used by TA2 during solution
// search. If any method being used is missing, feel free to request
......@@ -38,6 +41,7 @@ message ScoringConfiguration {
// Instead of really scoring, a TA2 might predict the score only.
// * "TRAINING_DATA"
// Training data is reused to test as well.
//
// No standard value will ever start with "_", so if you worry about
// potential conflicts with future standard values, consider starting
// your non-standard values with "_'.
......
......@@ -3,20 +3,22 @@ option go_package = "pipeline";
message ProblemPerformanceMetric {
// The evaluation metric. Standard values are required to be supported
// for the "ScoreSolution" call and are available here:
// and are available here:
// https://metadata.datadrivendiscovery.org/devel/?definitions#definitions.performance_metric
// In addition, "RANK" metric can be used to ask TA2 to rank a solution as part of
// all found solutions of a given "SearchSolutions" call. Rank is a
// floating-point number. Lower numbers represent better solutions.
// Presently evaluation requirements are that ranks should be non-negative
// and that each ranked pipeline have a different rank (for all
// solutions of a given SearchSolutions call). Only possible with
// "RANKING" evaluation method.
//
// In addition, "RANK" metric should be also supported. "RANK" metric
// can be used for a rank of a solution among all found solutions of
// a given "SearchSolutions" call. Rank is a non-negative floating-point number.
// Lower numbers represent better solutions. Each ranked solution should have
// a different rank (for all solutions of a given "SearchSolutions" call).
// Only possible with "RANKING" evaluation method.
//
// The following additional metrics are defined to allow expressing
// internal evaluation scores used by TA2 during pipeline search.
// internal evaluation scores used by TA2 during solution search.
// If any you are using is missing, feel free to request it to be added.
// * "LOSS"
// Average loss of an unspecified loss function.
//
// No standard value will ever start with "_", so if you worry about
// potential conflicts with future standard values, consider starting
// your non-standard values with "_'.
......@@ -27,8 +29,10 @@ message ProblemPerformanceMetric {
}
message Problem {
// Task keyword of the problem. Standard values are available here:
// Task keywords of the problem. Standard values are required
// to be supported and are available here:
// https://metadata.datadrivendiscovery.org/devel/?definitions#definitions.problem.task_keywords
//
// No standard value will ever start with "_", so if you worry about
// potential conflicts with future standard values, consider starting
// your non-standard values with "_'.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment