Commit 6d11fe1b authored by Mitar's avatar Mitar

Adding language about reserved prefix.

parent 41fcea09
Pipeline #129436735 passed with stage
in 4 minutes and 27 seconds
......@@ -38,6 +38,9 @@ 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 "_'.
string method = 1;
// Number of folds made, if applicable.
int32 folds = 2;
......
......@@ -17,6 +17,9 @@ message ProblemPerformanceMetric {
// 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 "_'.
string metric = 1;
// Additional params used by some metrics.
int32 k = 2;
......@@ -26,6 +29,9 @@ message ProblemPerformanceMetric {
message Problem {
// Task keyword of the problem. Standard values 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 "_'.
repeated string task_keywords = 8;
repeated ProblemPerformanceMetric performance_metrics = 7;
}
......
......@@ -19,7 +19,7 @@ option go_package = "pipeline";
// provided to the other system, the list is traversed in order and the first
// value type which can be used without an error is used. If the list is
// exhausted, then an error is provided instead.
//
// The following value types are those everyone should support.
// * "RAW"
// Raw value. Not all values can be represented as a raw value.
......@@ -33,7 +33,7 @@ option go_package = "pipeline";
// shared file system. CSV URI should point to the file with ".csv" file extension.
// Only tabular container values with numeric and string cell values can be represented
// this way.
//
// The following are additional value types which can be supported by systems,
// but it is not required. If the value cannot be represented with value types your system
// supports and your system is still asked to do so, it should return "ValueError" error instead.
......@@ -49,6 +49,10 @@ option go_package = "pipeline";
// Same as "RAW", but without any size limit.
// * "LARGE_PICKLE_BLOB"
// Same as "PICKLE_BLOB", but without any size limit.
//
// 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 "_'.
message ValueError {
// A error message useful for debugging or logging. Not meant to be very end-user friendly.
......
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