diff options
| author | Evan Shelhamer <shelhamer@imaginarynumber.net> | 2016-04-13 16:43:39 -0700 |
|---|---|---|
| committer | Evan Shelhamer <shelhamer@imaginarynumber.net> | 2016-04-13 19:10:33 -0700 |
| commit | 462a688fb8997f87b19c3c51860eb32d5458b246 (patch) | |
| tree | ecbd7c1b2443f8043a6a91df6a7ce655b22116f7 /docs | |
| parent | b265134710d78db4007471ccbe376c2c4221441a (diff) | |
| download | caffe-462a688fb8997f87b19c3c51860eb32d5458b246.tar.gz caffe-462a688fb8997f87b19c3c51860eb32d5458b246.tar.bz2 caffe-462a688fb8997f87b19c3c51860eb32d5458b246.zip | |
[docs] install: include latest versions and platforms, highlight guides
Caffe runs on Ubuntu, OS X, and RHEL (+ company) in master
with branches for OpenCL and Windows.
Docker is a nice route to out-of-the-box brewing.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/installation.md | 22 |
1 files changed, 14 insertions, 8 deletions
diff --git a/docs/installation.md b/docs/installation.md index e6c6886d..9aa83527 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -5,13 +5,23 @@ title: Installation # Installation Prior to installing, have a glance through this guide and take note of the details for your platform. -We install and run Caffe on Ubuntu 14.04 and 12.04, OS X 10.10 / 10.9 / 10.8, and AWS. -The official Makefile and `Makefile.config` build are complemented by an automatic CMake build from the community. +We install and run Caffe on Ubuntu 16.04–12.04, OS X 10.11–10.8, and through Docker and AWS. +The official Makefile and `Makefile.config` build are complemented by a [community CMake build](#cmake-build). + +**Step-by-step Instructions**: + +- [Docker setup](https://github.com/BVLC/caffe/tree/master/docker) *out-of-the-box brewing* +- [Ubuntu installation](install_apt.html) *the standard platform* +- [OS X installation](install_osx.html) +- [RHEL / CentOS / Fedora installation](install_yum.html) +- [Windows](https://github.com/BVLC/caffe/tree/windows) *see the Windows branch led by Microsoft* +- [OpenCL](https://github.com/BVLC/caffe/tree/opencl) *see the OpenCL branch led by Fabian Tschopp* + +**Overview**: - [Prerequisites](#prerequisites) - [Compilation](#compilation) - [Hardware](#hardware) -- Platforms: [Ubuntu guide](install_apt.html), [OS X guide](install_osx.html), and [RHEL / CentOS / Fedora guide](install_yum.html) When updating Caffe, it's best to `make clean` before re-compiling. @@ -82,10 +92,6 @@ Install MATLAB, and make sure that its `mex` is in your `$PATH`. *Caffe's MATLAB interface works with versions 2015a, 2014a/b, 2013a/b, and 2012b.* -#### Windows - -There is an unofficial Windows port of Caffe at [niuzhiheng/caffe:windows](https://github.com/niuzhiheng/caffe). Thanks [@niuzhiheng](https://github.com/niuzhiheng)! - ## Compilation Caffe can be compiled with either Make or CMake. Make is officially supported while CMake is supported by the community. @@ -113,7 +119,7 @@ Be sure to set your MATLAB and Python paths in `Makefile.config` first! Now that you have installed Caffe, check out the [MNIST tutorial](gathered/examples/mnist.html) and the [reference ImageNet model tutorial](gathered/examples/imagenet.html). -### Compilation with CMake +### CMake Build In lieu of manually editing `Makefile.config` to configure the build, Caffe offers an unofficial CMake build thanks to @Nerei, @akosiorek, and other members of the community. It requires CMake version >= 2.8.7. The basic steps are as follows: |