From e64b7e74fd9c44258e0381173bf83c1baf90d803 Mon Sep 17 00:00:00 2001 From: Davis King Date: Sat, 3 Dec 2011 23:44:27 -0500 Subject: [PATCH] updated docs --- docs/docs/ml.xml | 120 +++++++++++++++++++++++++++++++++++++-- docs/docs/term_index.xml | 8 +++ 2 files changed, 124 insertions(+), 4 deletions(-) diff --git a/docs/docs/ml.xml b/docs/docs/ml.xml index c3dde8888..ac0fff0df 100644 --- a/docs/docs/ml.xml +++ b/docs/docs/ml.xml @@ -97,14 +97,21 @@ Davis E. King. structural_svm_sequence_labeling_problem structural_svm_object_detection_problem + structural_svm_assignment_problem + + + + Core Tools + + structural_svm_problem + structural_svm_problem_threaded + svm_struct_controller_node + svm_struct_processing_node - structural_svm_problem structural_object_detection_trainer structural_sequence_labeling_trainer - structural_svm_problem_threaded - svm_struct_controller_node - svm_struct_processing_node + structural_assignment_trainer
Unsupervised @@ -153,11 +160,13 @@ Davis E. King. cross_validate_multiclass_trainer cross_validate_regression_trainer cross_validate_sequence_labeler + cross_validate_assignment_trainer test_binary_decision_function test_multiclass_decision_function test_regression_function test_object_detection_function test_sequence_labeler + test_assignment_function
@@ -203,6 +212,7 @@ Davis E. King. multiclass_linear_decision_function one_vs_all_decision_function sequence_labeler + assignment_function
@@ -220,6 +230,8 @@ Davis E. King. randomize_samples is_binary_classification_problem is_sequence_labeling_problem + is_assignment_problem + is_forced_assignment_problem approximate_distance_function is_learning_problem select_all_distinct_labels @@ -1329,6 +1341,19 @@ Davis E. King. + + + + assignment_function + dlib/svm.h + dlib/svm/assignment_function_abstract.h + + This object is a tool for solving the optimal assignment problem given a + user defined method for computing the quality of any particular assignment. + + + + @@ -1562,6 +1587,32 @@ Davis E. King. + + + + is_assignment_problem + dlib/svm.h + dlib/svm/svm_abstract.h + + This function takes a set of training data for an assignment problem + and reports back if it could possibly be a well formed assignment problem. + + + + + + + + is_forced_assignment_problem + dlib/svm.h + dlib/svm/svm_abstract.h + + This function takes a set of training data for a forced assignment problem + and reports back if it could possibly be a well formed forced assignment problem. + + + + @@ -2112,6 +2163,20 @@ Davis E. King. + + + + cross_validate_assignment_trainer + dlib/svm.h + dlib/svm/cross_validate_assignment_trainer_abstract.h + + Performs k-fold cross validation on a user supplied assignment trainer object such + as the structural_assignment_trainer + and returns the fraction of assignments predicted correctly. + + + + @@ -2128,6 +2193,19 @@ Davis E. King. + + + + test_assignment_function + dlib/svm.h + dlib/svm/cross_validate_assignment_trainer_abstract.h + + Tests an assignment_function on a set of data + and returns the fraction of assignments predicted correctly. + + + + @@ -2289,6 +2367,21 @@ Davis E. King. + + + + structural_svm_assignment_problem + dlib/svm_threaded.h + dlib/svm/structural_svm_assignment_problem_abstract.h + + This object is a tool for learning the weight vector needed to use + an assignment_function object. + It learns the parameter vector by + formulating the problem as a structural SVM problem. + + + + @@ -2335,6 +2428,25 @@ Davis E. King. + + + + structural_assignment_trainer + dlib/svm_threaded.h + dlib/svm/structural_assignment_trainer_abstract.h + + This object is a tool for learning to solve the assignment problem based + on a set of training data. The training procedure produces an + assignment_function object + which can be used to predict the assignments of new data. + + Note that this is just a convenience wrapper around the + structural_svm_assignment_problem + to make it look similar to all the other trainers in dlib. + + + + diff --git a/docs/docs/term_index.xml b/docs/docs/term_index.xml index 01e9eb9da..ed700458c 100644 --- a/docs/docs/term_index.xml +++ b/docs/docs/term_index.xml @@ -44,6 +44,14 @@ + + + + + + + +