summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorSergey Karayev <sergeykarayev@gmail.com>2014-07-09 10:14:00 -0700
committerSergey Karayev <sergeykarayev@gmail.com>2014-07-09 11:32:34 -0700
commitf0cc3f7ee187ae4857c145d2805de19d86acd2fa (patch)
treee3c8985e91ac3ab4afd571eaf703d9412d5690a2 /docs
parent03a48d7d4e0fddef145094652b2c5e5132ff84e6 (diff)
downloadcaffeonacl-f0cc3f7ee187ae4857c145d2805de19d86acd2fa.tar.gz
caffeonacl-f0cc3f7ee187ae4857c145d2805de19d86acd2fa.tar.bz2
caffeonacl-f0cc3f7ee187ae4857c145d2805de19d86acd2fa.zip
[docs] reworked index page, got rid of publications page
Diffstat (limited to 'docs')
-rw-r--r--docs/_layouts/default.html13
-rw-r--r--docs/development.md2
-rw-r--r--docs/images/GitHub-Mark-64px.pngbin0 -> 2625 bytes
-rw-r--r--docs/index.md76
-rw-r--r--docs/publications.md12
-rw-r--r--docs/stylesheets/styles.css20
6 files changed, 56 insertions, 67 deletions
diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html
index 29c7a081..f5d90004 100644
--- a/docs/_layouts/default.html
+++ b/docs/_layouts/default.html
@@ -3,7 +3,9 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="chrome=1">
- <title>Caffe</title>
+ <title>
+ Caffe {% if page contains 'title' %}| {{ page.title }}{% endif %}
+ </title>
<link rel="stylesheet" href="stylesheets/reset.css">
<link rel="stylesheet" href="stylesheets/styles.css">
@@ -27,7 +29,7 @@
<div class="wrapper">
<header>
<h1 class="header"><a href="index.html">Caffe</a></h1>
- <p class="header">Convolutional Architecture for Fast Feature Embedding</p>
+ <!-- <p class="header">Convolutional Architecture for Fast Feature Embedding</p> -->
<ul>
<!--<li class="download"><a class="buttons" href="https://github.com/BVLC/caffe/zipball/master">Download ZIP</a></li>
@@ -43,10 +45,11 @@
{{ content }}
</section>
- <footer>
+<!-- <footer>
<p><small>Hosted on <a href="http://pages.github.com">GitHub Pages</a>.</small></p>
</footer>
- </div>
- <!--[if !IE]><script>fixScale(document);</script><![endif]-->
+ -->
+ </div>
+ <!--[if !IE]><script>fixScale(document);</script><![endif]-->
</body>
</html>
diff --git a/docs/development.md b/docs/development.md
index 26e4332c..ea18d5cf 100644
--- a/docs/development.md
+++ b/docs/development.md
@@ -1,6 +1,6 @@
---
layout: default
-title: Caffe
+title: Development
---
Developing & Contributing
diff --git a/docs/images/GitHub-Mark-64px.png b/docs/images/GitHub-Mark-64px.png
new file mode 100644
index 00000000..182a1a3f
--- /dev/null
+++ b/docs/images/GitHub-Mark-64px.png
Binary files differ
diff --git a/docs/index.md b/docs/index.md
index 05d225e7..51fe8b40 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,36 +1,43 @@
---
layout: default
---
-# Welcome to Caffe
+# Caffe
-Caffe is a framework for convolutional neural network algorithms, developed with speed in mind.
-It was created by [Yangqing Jia](http://daggerfs.com), and is in active development by the [Berkeley Vision and Learning Center](http://bvlc.eecs.berkeley.edu).
+Caffe is a deep learning framework developed with cleanliness, readability, and speed in mind.
+It was created by [Yangqing Jia](http://daggerfs.com), and is in active development by the Berkeley Vision and Learning Center ([BVLC](http://bvlc.eecs.berkeley.edu)) and by community contributors.
+Caffe is released under the [BSD 2-Clause license](https://github.com/BVLC/caffe/blob/master/LICENSE).
-Caffe is released under [the BSD 2-Clause license](https://github.com/BVLC/caffe/blob/master/LICENSE).
+## Why
-Check out the [classification demo](http://demo.caffe.berkeleyvision.org/)!
+**Clean architecture** enables rapid deployment.
+Networks are specified in simple config files, with no hard-coded parameters in the code.
+Switching between CPU and GPU code is as simple as setting a flag -- so models can be trained on a GPU machine, and then used on commodity clusters.
-<!-- BVLC hosts a quick [classification demo](http://demo.caffe.berkeleyvision.org/) using Caffe. -->
+**Readable & modifiable implementation** fosters active development.
+In Caffe's first six months, it has been forked by over 300 developers on Github, and many have contributed significant changes.
-## Why Caffe?
+**Speed** makes Caffe perfect for industry use.
+Caffe can process over **40M images per day** with a single NVIDIA K40 or Titan GPU\*.
+That's 5 ms/image in training, and 2 ms/image in test.
+We believe that Caffe is the fastest CNN implementation available.
-Caffe aims to provide computer vision scientists and practitioners with a **clean and modifiable implementation** of state-of-the-art deep learning algorithms.
-For example, network structure is easily specified in separate config files, with no mess of hard-coded parameters in the code.
+**Community**: Caffe already powers academic research projects, startup prototypes, and even large-scale industrial applications in vision, speech, and multimedia.
+There is an active discussion and support community on [Github](https://github.com/BVLC/caffe/issues).
-At the same time, Caffe fits industry needs, with blazing fast C++/CUDA code for GPU computation.
-Caffe is currently the fastest GPU CNN implementation publicly available, and is able to process more than **40 million images per day** with a single NVIDIA K40 or Titan GPU (or 20 million images per day on a K20 GPU)\*. That's 192 images per second during training and 500 images per second during test.
+<p class="footnote" markdown="1">
+\* When files are properly cached, and using the ILSVRC2012-winning [SuperVision](http://www.image-net.org/challenges/LSVRC/2012/supervision.pdf) model.
+Consult performance [details](/performance_hardware.html).
+</p>
-Caffe also provides **seamless switching between CPU and GPU**, which allows one to train models with fast GPUs and then deploy them on non-GPU clusters with one line of code: `Caffe::set_mode(Caffe::CPU)`.
-Even in CPU mode, computing predictions on an image takes only 20 ms when images are processed in batch mode. While in GPU mode, computing predictions on an image takes only 2 ms when images are processed in batch mode.
-
-## Documentation
+## How
* [Introductory slides](https://www.dropbox.com/s/10fx16yp5etb8dv/caffe-presentation.pdf): slides about the Caffe architecture, *updated 03/14*.
-* [Installation](/installation.html): Instructions on installing Caffe (works on Ubuntu, Red Hat, OS X).
-* [Pre-trained models](/getting_pretrained_models.html): BVLC provides some pre-trained models for academic / non-commercial use.
+* [ACM MM paper](https://github.com/UCB-ICSI-Vision-Group/caffe-paper/raw/arxiv/caffe.pdf): a 4-page report for the ACM Multimedia Open Source competition.
+* [Installation instructions](/installation.html): tested on Ubuntu, Red Hat, OS X.
+* [Pre-trained models](/getting_pretrained_models.html): BVLC provides ready-to-use models for non-commercial use.
* [Development](/development.html): Guidelines for development and contributing to Caffe.
-### Examples
+### Tutorials and Examples
* [Image Classification \[notebook\]][imagenet_classification]: classify images with the pretrained ImageNet model by the Python interface.
* [Detection \[notebook\]][detection]: run a pretrained model as a detector in Python.
@@ -46,7 +53,7 @@ Even in CPU mode, computing predictions on an image takes only 20 ms when images
## Citing Caffe
-Please kindly cite Caffe in your publications if it helps your research:
+Please cite Caffe in your publications if it helps your research:
@misc{Jia13caffe,
Author = {Yangqing Jia},
@@ -55,31 +62,18 @@ Please kindly cite Caffe in your publications if it helps your research:
Howpublished = {\url{http://caffe.berkeleyvision.org/}
}
-### Related Publications
-
-For publications featuring Caffe, refer to this [open list of publications](/publications.html) (please do add your own!) and [Google Scholar](http://scholar.google.com/scholar?oi=bibs&hl=en&cites=17333247995453974016).
-
-### Acknowledgements
-
-Yangqing would like to thank the NVIDIA Academic program for providing K20 GPUs, and [Oriol Vinyals](http://www1.icsi.berkeley.edu/~vinyals/) for various discussions along the journey.
+If you do publish a paper where Caffe helped your research, we encourage you to update the [publications wiki](https://github.com/BVLC/caffe/wiki/Publications).
+Citations are also tracked automatically by [Google Scholar](http://scholar.google.com/scholar?oi=bibs&hl=en&cites=17333247995453974016).
-A core set of BVLC members have contributed lots of new functionality and fixes since the original release (alphabetical by first name):
+## Acknowledgements
-- [Eric Tzeng](https://github.com/erictzeng)
-- [Evan Shelhamer](http://imaginarynumber.net/)
-- [Jeff Donahue](http://jeffdonahue.com/)
-- [Jon Long](https://github.com/longjon)
-- [Dr. Ross Girshick](http://www.cs.berkeley.edu/~rbg/)
-- [Sergey Karayev](http://sergeykarayev.com/)
-- [Dr. Sergio Guadarrama](http://www.eecs.berkeley.edu/~sguada/)
+Yangqing would like to thank the NVIDIA Academic program for providing GPUs, [Oriol Vinyals](http://www1.icsi.berkeley.edu/~vinyals/) for discussions along the journey, and BVLC PI [Trevor Darrell](http://www.eecs.berkeley.edu/~trevor/) for guidance.
-The BVLC contributors would like to thank BVLC PI [Trevor Darrell](http://www.eecs.berkeley.edu/~trevor/) for advising the project.
+A core set of BVLC members have contributed much new functionality and many fixes since the original release (alphabetical by first name):
+[Eric Tzeng](https://github.com/erictzeng), [Evan Shelhamer](http://imaginarynumber.net/), [Jeff Donahue](http://jeffdonahue.com/), [Jon Long](https://github.com/longjon), [Ross Girshick](http://www.cs.berkeley.edu/~rbg/), [Sergey Karayev](http://sergeykarayev.com/), [Sergio Guadarrama](http://www.eecs.berkeley.edu/~sguada/).
Additionally, the open-source community plays a large and growing role in Caffe's development.
-Check out the Github [project pulse](https://github.com/BVLC/caffe/pulse) for recent activity, and the [contributors](https://github.com/BVLC/caffe/graphs/contributors) for an ordered list (by commit activity).
-We sincerely appreciate your interest and contributions!
-If you'd like to contribute, read [this](development.html).
-
----
+Check out the Github [project pulse](https://github.com/BVLC/caffe/pulse) for recent activity, and the [contributors](https://github.com/BVLC/caffe/graphs/contributors) for a sorted list.
-\*: When measured with the [SuperVision](http://www.image-net.org/challenges/LSVRC/2012/supervision.pdf) model that won the ImageNet Large Scale Visual Recognition Challenge 2012. See [performance and hardware configuration details](/performance_hardware.html).
+We sincerely appreciate your interest and contributions!
+If you'd like to contribute, please read the [development guide](development.html).
diff --git a/docs/publications.md b/docs/publications.md
deleted file mode 100644
index 469435e3..00000000
--- a/docs/publications.md
+++ /dev/null
@@ -1,12 +0,0 @@
----
-layout: default
----
-# Related Publications
-
-Caffe powers on-going research projects, large-scale industrial applications, and startup prototypes in vision, speech, and multimedia. Here we highlight publications involving Caffe.
-
-[Caffe: Convolutional Architecture for Fast Feature Embedding](https://github.com/UCB-ICSI-Vision-Group/caffe-paper/raw/arxiv/caffe.pdf): the Caffe tech report on arXiv as submitted to the ACM-MM OSS competition for open-source projects. This introduces the framework and its purpose, compares it to contemporary packages, describes implementation details, and highlights applications.
-
-Please add your own publications by submitting a pull request to the [project github](http://github.com/BVLC/caffe). Send your pull request to the master branch for inclusion on the site and in the documentation.
-
-*Publication list coming soon.*
diff --git a/docs/stylesheets/styles.css b/docs/stylesheets/styles.css
index b91cec6f..5862c6c2 100644
--- a/docs/stylesheets/styles.css
+++ b/docs/stylesheets/styles.css
@@ -1,14 +1,14 @@
+@import url(http://fonts.googleapis.com/css?family=PT+Serif|Open+Sans:600,400);
+
body {
padding:10px 50px 0 0;
- font-family: "Helvetica Neue", Helvetica, Arial, sans-serif;
- font-weight: 300;
+ font-family: 'Open Sans', sans-serif;
font-size: 14px;
color: #232323;
background-color: #FBFAF7;
margin: 0;
- line-height: 1.8em;
+ line-height: 1.5rem;
-webkit-font-smoothing: antialiased;
-
}
h1, h2, h3, h4, h5, h6 {
@@ -21,8 +21,7 @@ p, ul, ol, table, dl {
}
h1, h2, h3 {
- font-family: Times, serif;
- font-weight: 300;
+ font-family: 'PT Serif', serif;
line-height:1.3;
font-weight: normal;
display: block;
@@ -203,7 +202,7 @@ header {
}
p.header {
- font-size: 16px;
+ font-size: 14px;
}
h1.header {
@@ -277,7 +276,8 @@ a.buttons {
}
a.github {
- background: url(../images/octocat-small.png) no-repeat 1px;
+ background: url(/images/GitHub-Mark-64px.png) no-repeat center left;
+ background-size: 15%;
}
a.buttons:hover {
@@ -294,6 +294,10 @@ section {
padding-bottom:50px;
}
+p.footnote {
+ font-size: 12px;
+}
+
/* Footer */