From 062f5a69cd3f6054f05123207c5d6350c58c3a1a Mon Sep 17 00:00:00 2001 From: Ian Barber Date: Sat, 21 Jan 2012 23:07:07 +0000 Subject: [PATCH] Updating SVM extension documentation for 0.1.5 release git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@322552 c90b9560-bf6c-de11-be94-00142212c4b1 --- .../svm/svmmodel/checkprobabilitymodel.xml | 55 ++++++++++++++++ reference/svm/svmmodel/getlabels.xml | 65 +++++++++++++++++++ reference/svm/svmmodel/getnrclass.xml | 55 ++++++++++++++++ reference/svm/svmmodel/getsvmtype.xml | 55 ++++++++++++++++ reference/svm/svmmodel/getsvrprobability.xml | 56 ++++++++++++++++ reference/svm/versions.xml | 5 ++ 6 files changed, 291 insertions(+) create mode 100644 reference/svm/svmmodel/checkprobabilitymodel.xml create mode 100644 reference/svm/svmmodel/getlabels.xml create mode 100644 reference/svm/svmmodel/getnrclass.xml create mode 100644 reference/svm/svmmodel/getsvmtype.xml create mode 100644 reference/svm/svmmodel/getsvrprobability.xml diff --git a/reference/svm/svmmodel/checkprobabilitymodel.xml b/reference/svm/svmmodel/checkprobabilitymodel.xml new file mode 100644 index 0000000000..18a4813927 --- /dev/null +++ b/reference/svm/svmmodel/checkprobabilitymodel.xml @@ -0,0 +1,55 @@ + + + + + + SVMModel::checkProbabilityModel + Returns true if the model has probability information + + + + &reftitle.description; + + public boolSVMModel::checkProbabilityModel + + + + Returns true if the model contains probability information. + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Return a boolean value + + + + + + diff --git a/reference/svm/svmmodel/getlabels.xml b/reference/svm/svmmodel/getlabels.xml new file mode 100644 index 0000000000..cc2cf51351 --- /dev/null +++ b/reference/svm/svmmodel/getlabels.xml @@ -0,0 +1,65 @@ + + + + + + SVMModel::getLabels + Get the labels the model was trained on + + + + &reftitle.description; + + public arraySVMModel::getLabels + + + + Return an array of labels that the model was trained on. For regression and one class + models an empty array is returned. + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Return an array of labels + + + + + &reftitle.seealso; + + + SVMModel::getNrClass + + + + + + + diff --git a/reference/svm/svmmodel/getnrclass.xml b/reference/svm/svmmodel/getnrclass.xml new file mode 100644 index 0000000000..60f2659012 --- /dev/null +++ b/reference/svm/svmmodel/getnrclass.xml @@ -0,0 +1,55 @@ + + + + + + SVMModel::getNrClass + Returns the number of classes the model was trained with + + + + &reftitle.description; + + public intSVMModel::getNrClass + + + + Returns the number of classes the model was trained with, will return 2 for one class and regression models. + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Return an integer number of classes + + + + + + diff --git a/reference/svm/svmmodel/getsvmtype.xml b/reference/svm/svmmodel/getsvmtype.xml new file mode 100644 index 0000000000..aacc53a04d --- /dev/null +++ b/reference/svm/svmmodel/getsvmtype.xml @@ -0,0 +1,55 @@ + + + + + + SVMModel::getSvmType + Get the SVM type the model was trained with + + + + &reftitle.description; + + public intSVMModel::getSvmType + + + + Returns an integer value representing the type of the SVM model used, e.g SVM::C_SVC. + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Return an integer SVM type + + + + + + diff --git a/reference/svm/svmmodel/getsvrprobability.xml b/reference/svm/svmmodel/getsvrprobability.xml new file mode 100644 index 0000000000..22f17cea0c --- /dev/null +++ b/reference/svm/svmmodel/getsvrprobability.xml @@ -0,0 +1,56 @@ + + + + + + SVMModel::getSvrProbability + Get the sigma value for regression types + + + + &reftitle.description; + + public floatSVMModel::getSvrProbability + + + + For regression models, returns a sigma value. If there is no probability + information or the model is not SVR, 0 is returned. + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns a sigma value + + + + + + diff --git a/reference/svm/versions.xml b/reference/svm/versions.xml index f5434d6fb8..b040232e4d 100644 --- a/reference/svm/versions.xml +++ b/reference/svm/versions.xml @@ -16,6 +16,11 @@ + + + + +