README
1Algorithm::SVM version 0.12
2===========================
3
4TABLE OF CONTENTS
5-----------------
6
71) DESCRIPTION
82) INSTALLATION
93) DEPENDENCIES
104) BUGS
115) Algorithm::SVM COPYRIGHT AND LICENCE
126) libsvm COPYRIGHT AND LICENCE
137) AUTHOR INFORMATION
148) ACKNOWLEDGEMENTS
15
16
171) DESCRIPTION
18--------------
19
20Algorithm::SVM was originally written by Cory Spencer of the Simon Fraser
21University Brinkman Laboratory and provides Perl bindings for a Support
22Vector Machine. It is currently maintained by Matthew Laird and all
23inquiries, patches and comments should be sent to him.
24
25Algorithm::SVM is based on the libsvm library written by Chih-Chung Chang
26and Chih-Jen Lin.
27
28To read about the latest features, see the Changes file.
29
30The author invites feedback on SVM. If you find a bug, please send the
31information described in the BUGS section below.
32
33
342) INSTALLATION
35---------------
36
37For Solaris installation instructions please see README.solaris
38
39To install this module type the following:
40
41 perl Makefile.PL
42 make
43 make test
44 make install
45
46
473) DEPENDENCIES
48---------------
49
50Algorithm::SVM does not require any additional packages or libraries to be
51installed.
52
53
544) BUGS
55-------
56
57If you find a bug, please report it to the author along with the
58following information:
59
60 * version of Perl (output of 'perl -V' is best)
61 * version of Algorithm::SVM
62 * operating system type and version
63 * exact text of error message or description of problem
64 * example model files/data being classified
65
66If we don't have access to a system similar to yours, you may be asked
67to insert some debugging lines and report back on the results.
68The more help and information you can provide, the better.
69
70
715) SVM COPYRIGHT AND LICENCE
72----------------------------
73The Perl Algorithm::SVM module is Copyright (C) 2002 Cory Spencer and
74Fiona Brinkman. All rights reserved.
75
76This program is free software; you can redistribute it and/or modify it
77under the same terms as Perl itself.
78
79
806) libsvm COPYRIGHT AND LICENCE
81-------------------------------
82
83libsvm is Copyright (c) 2000-2002 Chih-Chung Chang and Chih-Jen Lin.
84All rights reserved.
85
86Redistribution and use in source and binary forms, with or without
87modification, are permitted provided that the following conditions
88are met:
89
901. Redistributions of source code must retain the above copyright
91notice, this list of conditions and the following disclaimer.
92
932. Redistributions in binary form must reproduce the above copyright
94notice, this list of conditions and the following disclaimer in the
95documentation and/or other materials provided with the distribution.
96
973. Neither name of copyright holders nor the names of its contributors
98may be used to endorse or promote products derived from this software
99without specific prior written permission.
100
101THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
102``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
103LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
104A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR
105CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
106EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
107PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
108PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
109LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
110NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
111SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
112
113
1147) AUTHOR INFORMATION
115---------------------
116
117The Perl Algorithm::SVM module was originally written by Cory Spencer but is
118currently maintained by Matthew Laird <matt@brinkman.mbb.sfu.ca> of the
119Brinkman Laboratory at Simon Fraser University, Burnaby, BC, Canada.
120
121 http://www.pathogenomics.sfu.ca/brinkman
122
123Any questions related to the underlying library, libsvm, should be directed
124to the authors of the libsvm package (Email contact: lincj@ccms.ntu.edu.tw).
125The libsvm homepage is currently located at:
126
127 http://www.csie.ntu.edu.tw/~cjlin/libsvm/
128
129
1308) ACKNOWLEDGEMENTS
131-------------------
132
133Thanks go to Chih-Jen Lin, one of the libsvm authors, for being particularly
134helpful during the development process of this module.
135
136As well to Dr. Alexander K. Seewald of Seewald Solutions for many bug fixes,
137new test cases, and lowering the memory footprint by a factor of 20. Thank
138you very much!
139
README.solaris
1We have been alerted to some differences in how different Perl releases
2build modules under Solaris depending if one uses the Sun distribution
3or builds it from source using GNU gcc.
4
5For this reason we've created some instructions that seem to work for
6both cases, if you experience any problems please email us and let us
7know the source of your perl distribution.
8
9Installation of the Algorithm::SVM module is then as follows:
10
11 perl Makefile.PL.solaris
12
13You will then need to edit the resulting Makefile, search for the
14word 'static' and find the sections titled "MakeMaker static section"
15and "MakeMaker static_lib section."
16
17Comment out the lines which under each of these sections should look
18something like:
19# --- MakeMaker static section:
20
21## $(INST_PM) has been moved to the all: target.
22## It remains here for awhile to allow for old usage: "make static"
23#static :: Makefile $(INST_STATIC) $(INST_PM)
24static :: Makefile $(INST_STATIC)
25 @$(NOOP)
26
27# --- MakeMaker static_lib section:
28
29$(INST_STATIC): $(OBJECT) $(MYEXTLIB) $(INST_ARCHAUTODIR)/.exists
30 $(RM_RF) $@
31 $(FULL_AR) $(AR_STATIC_ARGS) $@ $(OBJECT) && $(RANLIB) $@
32 $(CHMOD) $(PERM_RWX) $@
33 @echo "$(EXTRALIBS)" > $(INST_ARCHAUTODIR)/extralibs.ld
34
35Then continue with:
36 make
37 make test
38 make install
39