Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add debian installation guide #5111

Merged
merged 4 commits into from
Jan 13, 2017
Merged

docs: add debian installation guide #5111

merged 4 commits into from
Jan 13, 2017

Conversation

cdluminate
Copy link
Contributor

This PR closes issue: #2601

@williford
Copy link
Contributor

williford commented Dec 21, 2016

@cdluminate I made a few changes in your PR. I hope they are welcomed. I haven't tried the instructions, but it looks good to me.

@@ -4,10 +4,11 @@ title: "Installation: Debian"

# Debian Installation

Caffe packages are available for `Debian/unstable`. Debian/stable users
should take a look at Ubuntu installation instruction.
Caffe packages are available for `Debian/unstable` (Debian 10). Debian/stable
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think there is no need to refer Debian/unstable such a rolling release as Debian 10. And actually Debian/unstable is currently Stretch (Debian 9).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Stretch is Debian/testing (https://wiki.debian.org/DebianTesting & https://wiki.debian.org/DebianReleases#Current_Releases.2FRepositories), no? Debian/unstable will have the codename "buster", after it gets promoted from being unstable/sid. If the codenames are given later on, I think it is fine to leave it off.

Caffe packages are available for `Debian/unstable`. Debian/stable users
should take a look at Ubuntu installation instruction.
Caffe packages are available for `Debian/unstable` (Debian 10). Debian/stable
(jessie) and Debian/testing (stretch) users should take a look at [Ubuntu
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Currently Debian/testing users should be able to install these caffe packages. With a sources.list like this and a configured apt_preferences(man apt_preferences) :

deb http://mirror/debian testing main contrib non-free
deb http://mirror/debian unstable main contrib non-free

I didn't refer this because this is advanced usage, and it may break after several months.

There is still hope that Caffe can enter Debian/Stretch, if some warm-hearted volunteer can fix the skimage package.

https://tracker.debian.org/pkg/caffe

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, I was confused about it being left off, so I just guessed :-).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@cdluminate I thought that I would be able to edit or revert my commit to your PR, but it looks like I can only make another commit changing my previous one. I think it would be good to at least mention that by "testing", you mean "stretch", but the other changes are not necessary. Would you mind reverting my commit? Sorry for the hassle.

@cdluminate
Copy link
Contributor Author

@williford Thank you for the change. It looks good to me.

@cdluminate
Copy link
Contributor Author

Well it seems that several Debian developers are fixing the skimage package in the last minutes.

@cdluminate
Copy link
Contributor Author

skimage package was fixed by a Debian science developer. So I expect to see caffe-cpu in Debian/Stretch.

@shelhamer @lukeyeager Please review this document when you are available. I'll update this document when I finally confirmed the result of Debian/Stretch (testing).

Copy link
Contributor

@lukeyeager lukeyeager left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks pretty good. I like the section about downloading the source tarball, making changes and building custom packages.


Only experienced linux users are recommended to try Debian/unstable (Sid).

Last update: Dec.21 2016
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Odd date format. How about 2016-12-21?
https://xkcd.com/1179/


`sudo apt install caffe-cuda`, apt's dependency resolver is smart enough to deal with this.

* Where is the examples, the models and other documentation stuff?
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about "Where are the examples, models and other documentation?"

@@ -12,6 +12,7 @@ The official Makefile and `Makefile.config` build are complemented by a [communi

- [Docker setup](https://github.com/BVLC/caffe/tree/master/docker) *out-of-the-box brewing*
- [Ubuntu installation](install_apt.html) *the standard platform*
- [Debian installation](install_apt_debian.html) *deploy caffe with a single command*
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about "install" instead of "deploy"?

@cdluminate
Copy link
Contributor Author

@lukeyeager Thank you for the comments. I've updated the guide according to your suggestions.

@shelhamer
Copy link
Member

@cdluminate looks good to me, and I expect this should be helpful to the debian part of the community. Could you just squash the @williford commits into one to clean up the history?

williford and others added 2 commits January 5, 2017 04:21
Add the Debian codenames / versions, so it is easier to tell which Debian version is which in the future when the releases are promoted.

Revise commit according to CDLuminate's comments.

Removed rolling release numbers. Mention that Debian/testing can install Caffe using the packages.
@cdluminate
Copy link
Contributor Author

cdluminate commented Jan 5, 2017

@shelhamer I've squashed @williford commits into one, and added two tables to the doc.

One indicating if they are able to do APT install, another indicating if their compiler combination would work.

Your Distro     |  CPU_ONLY  |  CUDA  |     Alias
----------------+------------+--------+-------------------
Debian/stable   |     ✘      |   ✘    | Debian Jessie
Debian/testing  |     ✔      |   ☐    | Debian Stretch/Sid
Debian/unstable |     ✔      |   ✔    | Debian Sid
CXX compiler |  CUDA 7.5  |  CUDA 8.0  |
-------------+------------+------------+-
GCC-7        |     ?      |     ?      |
GCC-6        |     ✘      |     ✘      |
GCC-5        |     ✔ [1]  |     ✔      |
CLANG-4.0    |     ?      |     ?      |
CLANG-3.9    |     ✘      |     ✘      |
CLANG-3.8    |     ?      |     ✔      |

@cdluminate
Copy link
Contributor Author

Oh wait, I can't see \u0x2611 ☑ and \u2612 ☒ clearly on github with the default scaling factor.

@cdluminate
Copy link
Contributor Author

cdluminate commented Jan 5, 2017

Better after %s/☑/✔/g and %s/☒/✘/g


✔ 0x2714 ✘ 0x2718

@cdluminate
Copy link
Contributor Author

non-official version: https://cdluminate.github.io/caffe.html

@shelhamer shelhamer merged commit 8314363 into BVLC:master Jan 13, 2017
@shelhamer
Copy link
Member

Thanks for all of the debian packaging work @cdluminate !

@cdluminate
Copy link
Contributor Author

cdluminate commented Jan 14, 2017

I checked the git history. Currently Debian's Caffe version 1.0.0~rc3+20161127-g24d2f67-* is nearly identical to 1.0.0~rc4 the silent release, except for some typo fixes.

This version (I mean 1.0.0~rc3+20161127-g24d2f67 where "g24d2f67" means git24d2f67) will keep staying in Debian Stretch untill its end of life (Several years). However the Caffe version in Debian Sid will keep rolling with you.

Now let's talk about Ubuntu. Theoretically speaking Ubuntu keeps pulling most of the pacckages directly from Debian unstable to its devel branch, then freeze, and release when it's time. Now my package simply doesn't build on Ubuntu devel and I still don't know the reason why it failes in the unit test. [1]

[1] This is an amd64 build failure example. Failed to build from source because a unit test failure. https://launchpadlibrarian.net/302187072/buildlog_ubuntu-zesty-amd64.caffe_1.0.0~rc3+20161127-g24d2f67-5_BUILDING.txt.gz

@shelhamer


Oops, making the rc4 version into Stretch maybe possible.

@cypof
Copy link
Member

cypof commented Jan 14, 2017

The rc4 tag was just to have one ready now for the docker update, but it was meant to include the NCCL work too, which should merge pretty soon. I will move it afterward and then we can post something about it.

@shelhamer
Copy link
Member

@cdluminate @cypof rc4 isn't supposed to exist yet—I'm not sure how that was made. I hate to switch a tag once it exists but that was in error, and we'll define it once with the usual release notes once NCCL is merged (real soon now).

@cdluminate
Copy link
Contributor Author

@shelhamer If the real rc4 release can be made before Jan 24, it will be possible to push rc4 into stretch.

@shelhamer
Copy link
Member

@cdluminate rc4 is out: https://github.com/BVLC/caffe/releases/tag/rc4

@cdluminate
Copy link
Contributor Author

I updated caffe-cpu to rc4 version. Will update caffe-cuda tomorrow.

caffe-cpu_rc4 is available for amd64, armel, i386, ppc64el, s390x now.

https://buildd.debian.org/status/package.php?p=caffe

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants