summaryrefslogtreecommitdiffstats
path: root/model-evaluation/src
diff options
context:
space:
mode:
authorJon Bratseth <bratseth@oath.com>2018-08-28 15:34:24 +0200
committerJon Bratseth <bratseth@oath.com>2018-08-28 15:34:24 +0200
commit36d3e44cfc58a9cb4066c8ef65aa06140c8171d2 (patch)
treed22fdf781fae18b96724eb5d1293d997b54d2fad /model-evaluation/src
parenta97182c76ce577535353efcee9ccab0c51ece200 (diff)
Improve Javadoc
Diffstat (limited to 'model-evaluation/src')
-rw-r--r--model-evaluation/src/main/java/ai/vespa/models/evaluation/Model.java2
1 files changed, 2 insertions, 0 deletions
diff --git a/model-evaluation/src/main/java/ai/vespa/models/evaluation/Model.java b/model-evaluation/src/main/java/ai/vespa/models/evaluation/Model.java
index 593387e08bf..95eb923786d 100644
--- a/model-evaluation/src/main/java/ai/vespa/models/evaluation/Model.java
+++ b/model-evaluation/src/main/java/ai/vespa/models/evaluation/Model.java
@@ -126,6 +126,8 @@ public class Model {
* @param names the names identifying the function - this can be from 0 to 2, specifying function or "signature"
* name, and "output", respectively. Names which are unnecessary to determine the desired function
* uniquely (e.g if there is just one function or output) can be omitted.
+ * A two-component name can alternatively be specified as a single argument with components separated
+ * by dot.
* @throws IllegalArgumentException if the function is not present, or not uniquely identified by the names given
*/
public FunctionEvaluator evaluatorOf(String ... names) { // TODO: Parameter overloading?