/
README.windows.txt
163 lines (116 loc) · 6.98 KB
/
README.windows.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
Originally by Chris Quirk <chrisq@microsoft.com>
**************************************************************************************************************
Notes for building VW under Visual Studio 2013 on Windows 8.1
9/02/2014 Nick Nussbaum nickn@seanet.com
Replace source dependencies with Nuget
04/29/2015 Sharat Chikkerur sharat.chikkerur@gmail.com
Added ANTLR based unit test
10/2/2015 Markus Cozowicz marcozo@microsoft.com
**************************************************************************************************************
(1) Get Tools
You'll need a Visual Studio 2013 (or 2015) installed that includes c# and c++
You should install Visual Studio 2013 Update 5: https://www.microsoft.com/en-us/download/details.aspx?id=48129
You'll also need the Windows SDK which you can download from Microsoft at
http://msdn.microsoft.com/en-us/windows/desktop/bg162891.aspx
You'll need Nuget integration with visual studio
http://docs.nuget.org/consume
You'll need Java to run unit tests
http://www.oracle.com/technetwork/java/javase/downloads/jre8-downloads-2133155.html
**************************************************************************************************************
(2) open a copy various command shells
(a) Open an x86 command shell: run the Visual Studio 2013 Tools / VS2013 x86 Native Tools Command Prompt
or
cmd.exe /k "C:\Program Files (x86)\Microsoft Visual Studio 12.0\VC\vcvarsall.bat" x86
(b) Open an x64 command shell: run the Visual Studio 2013 Tools / VS2013 x64 Cross Tools Command Prompt
or
cmd.exe /k "C:\Program Files (x86)\Microsoft Visual Studio 12.0\VC\vcvarsall.bat" x86_amd64
(c) Open the Git bash shell
"C:\Program Files (x86)\Git\bin\sh.exe" --login -i
or some other bash shell
**************************************************************************************************************
(3) Setup Directories
I use c:\src\vw as my %ROOT% directory;
(a) mkdir c:\src
(b) mkdir c:\src\vw
**************************************************************************************************************
(4) Get Vowpal Wabbit
(a) In a command shell to %ROOT% : "cd c:\src\vw"
(b) run "git clone https://github.com/JohnLangford/vowpal_wabbit.git"
details of the changes are in bottom of this file.
**************************************************************************************************************
(5) Restore nugets
(a) In a command shell to %ROOT%\vowpalwabbit : "cd c:\src\vw\vowpalwabbit"
(b) run ".nuget\NuGet.exe restore vw.sln"
This will restore the ANTLR nuget which is needed before Visual Studio loads the solution.
**************************************************************************************************************
(5) Build Vowpal Wabbit
(a) Using visual studio
Open %ROOT%\vowpal_wabbit\vowpalwabbit\vw.sln in Visual Studio 2013
Set startup project as vw (or the test project)
Select x64 platform (Configuration Manager \ Active solution platfrom)
Select x64 as test platform (Test \ Test settings \ Default Processor Architecture)
run build>rebuild solution
or run batch build
Binaries will be in one of these four directories, based on whether you built DEBUG or RELEASE bits and whether you are building x64.
%ROOT%\vowpal_wabbit\vowpalwabbit\x64\Debug\vw.exe
%ROOT%\vowpal_wabbit\vowpalwabbit\x64\Release\vw.exe
Missing nugets will be installed during the build.
(b) Using command line (available configurations are "Release" and "Debug". Available platforms are "x64" and "Win32")
run>msbuild /p:Configuration="Release" /p:Platform="x64" vw.sln
Note: If you failed to do so before opening the solution, the cs_unittest
project is in a "not loaded" state. After executing the above you'll have to
hit "Reload" (Project / Context Menu) in Visual Studio.
**************************************************************************************************************
(8) Test
There's a new test batch file that runs a quick test on all four configurations
(a) go to a windows command shell
(a) cd c:\src\vw\test
(b) run test\test_2_winvw.bat
**************************************************************************************************************
(9) Appendix: The Gory Details of the patch and VW upgrades
(a) misc files
adds this content to this file ReadMe.Windows.txt
adds the file vowpal_wabbit\zlibpatch.txt a patch for xlib
adds the file test\test_2_winvw.bat a simple test of x86 and x64 training and prediction
(b) Changes to Zlib
This Zlib patch includes the following fixes;
Convert to Visual Studio 2013 solution
The fix in the prior section to correctly use DLL versions of the runtime for 32bit platforms
Changes to use only two fields in zlibvc.def VERSTION
- VERSION 1.2.8
+ VERSION 1.28
since otherwise the compiler will complain about more than 2 fields and ignore them.
add /safeseh to the x86 assembler so Visual Studio will not generate an error "unable to generate SAFESSH image"
This is not need for x64 since it happens by default
In the properties sheet for zlibvc
The pre build command line for x64 release should be fixed
-cd ..\..\contrib\masmx64
+cd ..\..\masmx64
Code generation: Runtime Library for windows release set to Multi-threaded DLL (/MD) not /MT for zlibvc and zlibstat
Otherwise VS13 will complain about multiple runtime specification while trying to autolink
(c) Change to Boost 1.56.0
(d) Changes to VowpalWabbit
changes vw projects and solutions to run under Visual Studio 2013 rather than Visual Studio 2012
change vw projects to redefine $(BoostIncludeDir) to refer to Boost 1.56.0
change vw projects to define $(BoostLibDir) to refer to Boost 1.56.0
vowpalwabbit/vw_static.vcxproj
Define $(IncludePath)
change $(ZlibDir) to use \contrib\vstudio\vc11 rather than vc10
change x64 version DebugInformationFormat to use "ProgramDatabase" and not the invalid "EditAndContinue"
change IntermediateFolderPath to include ProjectName so two projects aren't trying to build in the same folder
add searn_multiclasstask.cc to the project
change include path to all use macros $(VC_IncludePath);$(WindowsSDK_IncludePath)
change additional dependencies to use $(SolutionDir)$(PlatformShortName)\$(Configuration)\vw_static.lib
adds a reference to the WindowsSDKDir Include\um
change vw_static properties for debug 64bit to /Zi from /Zl to shut up some warnings.
change the vw and static_vw to use n intermediate directories that appends the $(ProjectName).
this avoid various conflicts and warnings caused by dumping into the same directory.
change link build copies to use PlatformShortName rather than PlatformName to use x86 rather than Win32
Change the anycpu confuuration for problems with cs_test
vowpalwabbit/vw.sln
change configurations to use Debug|x86 from Debug|AnyCpu
c_test/c_test.vcxproj
change to VS 12
change configurations to use Debug|x86 from Debug|AnyCpu
change cs_test to use x86 and x64 rather than anycpu
change test file specs to reference the .../../... test directory