summaryrefslogtreecommitdiff
path: root/creg/README
diff options
context:
space:
mode:
authorPatrick Simianer <simianer@cl.uni-heidelberg.de>2012-05-14 17:00:45 +0200
committerPatrick Simianer <simianer@cl.uni-heidelberg.de>2012-05-14 17:00:45 +0200
commitfb42639b433d2fc0c68f300666be1192dc3b4f59 (patch)
treebbce7fffa8c28ade217cf331e357ba65e64235b3 /creg/README
parent670a8f984fc6d8342180c59ae9e96b0b76f34d3d (diff)
parent0f1e696690b18259acd79c3469d00a72aca00161 (diff)
Merge remote-tracking branch 'upstream/master'
Diffstat (limited to 'creg/README')
-rw-r--r--creg/README17
1 files changed, 17 insertions, 0 deletions
diff --git a/creg/README b/creg/README
new file mode 100644
index 00000000..28a71d11
--- /dev/null
+++ b/creg/README
@@ -0,0 +1,17 @@
+creg is a fast tool for training linear and logistic regression models with
+l_1 and l_2 regularization. Its data (feature and response) format is
+compatible with ARKRegression.
+
+EXAMPLES
+
+Logistic regression example (training only):
+ $ ./creg -x test_data/iris.trainfeat -y test_data/iris.trainresp --l1 1.0 > weights.txt
+
+Logistic regression example (training and testing):
+ $ ./creg -x test_data/iris.trainfeat -y test_data/iris.trainresp --l1 1.0 \
+ -t test_data/iris.testfeat -s test_data/iris.testresp > weights.txt
+
+Linear regression example (training and testing):
+ $ ./creg -n -x test_data/auto-mpg.trainfeat -y test_data/auto-mpg.trainresp --l2 1000 \
+ -t test_data/auto-mpg.testfeat -s test_data/auto-mpg.testresp > weights.txt
+