summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorChristoph Helma <helma@in-silico.ch>2017-01-11 09:57:36 +0100
committerChristoph Helma <helma@in-silico.ch>2017-01-11 09:57:36 +0100
commitf522a1089af8775798450b3f9f0aa4b579a3e1b5 (patch)
treeae6527b4d5fd303173bc600e7332b26c57576fd9 /lib
parentfa4abf3dfc04abcd8bf21f29f73555a5090bc6eb (diff)
training test set validation documentation
Diffstat (limited to 'lib')
-rw-r--r--lib/train-test-validation.rb12
1 files changed, 12 insertions, 0 deletions
diff --git a/lib/train-test-validation.rb b/lib/train-test-validation.rb
index 71abad2..034ae3a 100644
--- a/lib/train-test-validation.rb
+++ b/lib/train-test-validation.rb
@@ -2,11 +2,17 @@ module OpenTox
module Validation
+ # Training test set validation
class TrainTest < Validation
field :training_dataset_id, type: BSON::ObjectId
field :test_dataset_id, type: BSON::ObjectId
+ # Create a training test set validation
+ # @param [OpenTox::Model::Lazar]
+ # @param [OpenTox::Dataset] training dataset
+ # @param [OpenTox::Dataset] test dataset
+ # @return [OpenTox::Validation::TrainTest]
def self.create model, training_set, test_set
validation_model = model.class.create prediction_feature: model.prediction_feature, training_dataset: training_set, algorithms: model.algorithms
@@ -32,16 +38,21 @@ module OpenTox
validation
end
+ # Get test dataset
+ # @return [OpenTox::Dataset]
def test_dataset
Dataset.find test_dataset_id
end
+ # Get training dataset
+ # @return [OpenTox::Dataset]
def training_dataset
Dataset.find training_dataset_id
end
end
+ # Training test set validation for classification models
class ClassificationTrainTest < TrainTest
include ClassificationStatistics
field :accept_values, type: Array
@@ -54,6 +65,7 @@ module OpenTox
field :probability_plot_id, type: BSON::ObjectId
end
+ # Training test set validation for regression models
class RegressionTrainTest < TrainTest
include RegressionStatistics
field :rmse, type: Float, default:0