Documentation

README.md

@@ -1,8 +1,32 @@
 # Caffe
 
-Caffe is a deep learning framework developed with cleanliness, readability, and speed in mind.<br />
-Consult the [project website](http://caffe.berkeleyvision.org) for all documentation.
+Caffe is a deep learning framework made with expression, speed, and modularity in mind.
+It is developed by the Berkeley Vision and Learning Center ([BVLC](http://bvlc.eecs.berkeley.edu)) and community contributors.
 
+Check out the [project site](http://caffe.berkeleyvision.org) for all the details like
 
-Please ask usage questions and how to model different tasks on the [caffe-users mailing list](https://groups.google.com/forum/#!forum/caffe-users).
+- [DIY Deep Learning for Vision with Caffe](https://docs.google.com/presentation/d/1UeKXVgRvvxg9OUdh_UiC5G71UMscNPlvArsWER41PsU/edit#slide=id.p)
+- [Tutorial Documentation](http://caffe.berkeleyvision.org/tutorial/)
+- [BVLC reference models](http://caffe.berkeleyvision.org/model_zoo.html) and the [community model zoo](https://github.com/BVLC/caffe/wiki/Model-Zoo)
+- [Installation instructions](http://caffe.berkeleyvision.org/installation.html)
 
+and step-by-step examples.
+
+Please join the [caffe-users group](https://groups.google.com/forum/#!forum/caffe-users) to ask questions and talk about methods and models.
+Framework development discussions and thorough bug reports are collected on [Issues](https://github.com/BVLC/caffe/issues).
+
+Happy brewing!
+
+## License and Citation
+
+Caffe is released under the [BSD 2-Clause license](https://github.com/BVLC/caffe/blob/master/LICENSE).
+The BVLC reference models are released for unrestricted use.
+
+Please cite Caffe in your publications if it helps your research:
+
+    @article{jia2014caffe,
+      Author = {Jia, Yangqing and Shelhamer, Evan and Donahue, Jeff and Karayev, Sergey and Long, Jonathan and Girshick, Ross and Guadarrama, Sergio and Darrell, Trevor},
+      Journal = {arXiv preprint arXiv:1408.5093},
+      Title = {Caffe: Convolutional Architecture for Fast Feature Embedding},
+      Year = {2014}
+    }

docs/_layouts/default.html

@@ -11,6 +11,8 @@
       Caffe {% if page contains 'title' %}| {{ page.title }}{% endif %}
     </title>
 
+    <link rel="icon" type="image/png" href="/images/caffeine-icon.png">
+
     <link rel="stylesheet" href="/stylesheets/reset.css">
     <link rel="stylesheet" href="/stylesheets/styles.css">
     <link rel="stylesheet" href="/stylesheets/pygment_trac.css">
@@ -34,8 +36,16 @@
       <header>
         <h1 class="header"><a href="/">Caffe</a></h1>
         <p class="header">
-          Deep learning framework developed by <a class="header name" href="http://daggerfs.com/">Yangqing Jia</a> / <a class="header name" href="http://bvlc.eecs.berkeley.edu/">BVLC</a>
+          Deep learning framework by the <a class="header name" href="http://bvlc.eecs.berkeley.edu/">BVLC</a>
         </p>
+        <p class="header">
+          Created by
+          <br>
+          <a class="header name" href="http://daggerfs.com/">Yangqing Jia</a>
+          <br>
+          Lead Developer
+          <br>
+          <a class="header name" href="http://imaginarynumber.net/">Evan Shelhamer</a>
         <ul>
           <li>
             <a class="buttons github" href="https://github.com/BVLC/caffe">View On GitHub</a>

docs/development.md

@@ -1,10 +1,10 @@
 ---
 title: Developing and Contributing
 ---
-# Development
+# Development and Contributing
 
 Caffe is developed with active participation of the community.<br>
-The [BVLC](http://bvlc.eecs.berkeley.edu/) maintainers welcome all contributions!
+The [BVLC](http://bvlc.eecs.berkeley.edu/) brewers welcome all contributions!
 
 The exact details of contributions are recorded by versioning and cited in our [acknowledgements](http://caffe.berkeleyvision.org/#acknowledgements).
 This method is impartial and always up-to-date.
@@ -21,7 +21,7 @@ If a contributor wants to further mark their specific copyright on a particular
 
 ### Documentation
 
-This website, written with [Jekyll](http://jekyllrb.com/), functions as the official Caffe documentation -- simply run `scripts/build_docs.sh` and view the website at `http://0.0.0.0:4000`.
+This website, written with [Jekyll](http://jekyllrb.com/), acts as the official Caffe documentation -- simply run `scripts/build_docs.sh` and view the website at `http://0.0.0.0:4000`.
 
 We prefer tutorials and examples to be documented close to where they live, in `readme.md` files.
 The `build_docs.sh` script gathers all `examples/**/readme.md` and `examples/*.ipynb` files, and makes a table of contents.
@@ -33,79 +33,77 @@ Other docs, such as installation guides, are written in the `docs` directory and
 We strive to provide provide lots of usage examples, and to document all code in docstrings.
 We absolutely appreciate any contribution to this effort!
 
-### The release cycle
+### Versioning
 
-- The `dev` branch receives all new development, including community contributions.
-We aim to keep it in a functional state, but large changes do occur, and things do get broken every now and then.
-Use only if you want the "bleeding edge".
-- BVLC maintainers will periodically update the `master` branch with changes from `dev`, giving it a release tag ([releases so far](https://github.com/BVLC/caffe/releases)).
-Use this if you want more stability.
+The `master` branch receives all new development including community contributions.
+We try to keep it in a reliable state, but it is the bleeding edge, and things do get broken every now and then.
+BVLC maintainers will periodically make releases by marking stable checkpoints as tags and maintenance branches. [Past releases](https://github.com/BVLC/caffe/releases) are catalogued online.
 
-### Issues & Pull Request Protocol
+#### Issues & Pull Request Protocol
 
-Use Github Issues to report [bugs], propose features, and ask development [questions].
-Large-scale development work is guided by [milestones], which are sets of Issues selected for concurrent release (integration from `dev` to `master`).
+Post [Issues](https://github.com/BVLC/caffe/issues) to propose features, report [bugs], and discuss framework code.
+Large-scale development work is guided by [milestones], which are sets of Issues selected for bundling as releases.
 
 Please note that since the core developers are largely researchers, we may work on a feature in isolation for some time before releasing it to the community, so as to claim honest academic contribution.
 We do release things as soon as a reasonable technical report may be written, and we still aim to inform the community of ongoing development through Github Issues.
 
-When you are ready to start developing your feature or fixing a bug, follow this protocol:
+**When you are ready to develop a feature or fixing a bug, follow this protocol**:
 
-- Develop in [feature branches] with descriptive names.
-    - For new development branch off `dev`.
-    - For documentation and fixes for `master` branch off `master`.
-- Bring your work up-to-date by [rebasing] onto the latest `dev` / `master`.
-(Polish your changes by [interactive rebase], if you'd like.)
-- [Pull request] your contribution to `BVLC/caffe`'s `dev` / `master` branch for discussion and review.
+- Develop in [feature branches] with descriptive names. Branch off of the latest `master`.
+- Bring your work up-to-date by [rebasing] onto the latest `master` when done.
+(Groom your changes by [interactive rebase], if you'd like.)
+- [Pull request] your contribution to `BVLC/caffe`'s `master` branch for discussion and review.
   - Make PRs *as soon as development begins*, to let discussion guide development.
   - A PR is only ready for merge review when it is a fast-forward merge, and all code is documented, linted, and tested -- that means your PR must include tests!
 - When the PR satisfies the above properties, use comments to request maintainer review.
 
-Below is a poetic presentation of the protocol in code form.
+The following is a poetic presentation of the protocol in code form.
 
 #### [Shelhamer's](https://github.com/shelhamer) “life of a branch in four acts”
 
-Make the `feature` branch off of the latest `bvlc/dev`
+Make the `feature` branch off of the latest `bvlc/master`
 ```
-git checkout dev
-git pull upstream dev
+git checkout master
+git pull upstream master
 git checkout -b feature
 # do your work, make commits
 ```
 
-Prepare to merge by rebasing your branch on the latest `bvlc/dev`
+Prepare to merge by rebasing your branch on the latest `bvlc/master`
 ```
-# make sure dev is fresh
-git checkout dev
-git pull upstream dev
-# rebase your branch on the tip of dev
+# make sure master is fresh
+git checkout master
+git pull upstream master
+# rebase your branch on the tip of master
 git checkout feature
-git rebase dev
+git rebase master
 ```
 
-Push your branch to pull request it into `dev`
+Push your branch to pull request it into `BVLC/caffe:master`
 ```
 git push origin feature
-# ...make pull request to dev...
+# ...make pull request to master...
 ```
 
-Now make a pull request! You can do this from the command line (`git pull-request -b dev`) if you install [hub](https://github.com/github/hub).
+Now make a pull request! You can do this from the command line (`git pull-request -b master`) if you install [hub](https://github.com/github/hub). Hub has many other magical uses.
 
-The pull request of `feature` into `dev` will be a clean merge. Applause.
+The pull request of `feature` into `master` will be a clean merge. Applause.
 
 [bugs]: https://github.com/BVLC/caffe/issues?labels=bug&page=1&state=open
-[questions]: https://github.com/BVLC/caffe/issues?labels=question&page=1&state=open
 [milestones]: https://github.com/BVLC/caffe/issues?milestone=1
 [Pull request]: https://help.github.com/articles/using-pull-requests
 [interactive rebase]: https://help.github.com/articles/interactive-rebase
 [rebasing]: http://git-scm.com/book/en/Git-Branching-Rebasing
 [feature branches]: https://www.atlassian.com/git/workflows#!workflow-feature-branch
 
+**Historical note**: Caffe once relied on a two branch `master` and `dev` workflow.
+PRs from this time are still open but these will be merged into `master` or closed.
+
 ### Testing
 
 Run `make runtest` to check the project tests. New code requires new tests. Pull requests that fail tests will not be accepted.
 
-The `googletest` framework we use provides many additional options, which you can access by running the test binaries directly. One of the more useful options is `--gtest_filter`, which allows you to filter tests by name:
+The `gtest` framework we use provides many additional options, which you can access by running the test binaries directly. One of the more useful options is `--gtest_filter`, which allows you to filter tests by name:
 
     # run all tests with CPU in the name
     build/test/test_all.testbin --gtest_filter='*CPU*'
@@ -119,7 +117,7 @@ To get a list of all options `googletest` provides, simply pass the `--help` fla
 
 ### Style
 
-- Follow [Google C++ style](http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml) and [Google python style](http://google-styleguide.googlecode.com/svn/trunk/pyguide.html) + [PEP 8](http://legacy.python.org/dev/peps/pep-0008/).
+- **Run `make lint` to check C++ code.**
 - Wrap lines at 80 chars.
+- Follow [Google C++ style](http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml) and [Google python style](http://google-styleguide.googlecode.com/svn/trunk/pyguide.html) + [PEP 8](http://legacy.python.org/dev/peps/pep-0008/).
 - Remember that “a foolish consistency is the hobgoblin of little minds,” so use your best judgement to write the clearest code for your particular case.
-- **Run `make lint` to check C++ code.**

docs/index.md

@@ -4,31 +4,33 @@ title: Deep Learning Framework
 
 # Caffe
 
-Caffe is a deep learning framework developed with cleanliness, readability, and speed in mind.
-It was created by [Yangqing Jia](http://daggerfs.com) during his PhD at UC Berkeley, and is in active development by the Berkeley Vision and Learning Center ([BVLC](http://bvlc.eecs.berkeley.edu)) and by community contributors.
+Caffe is a deep learning framework made with expression, speed, and modularity in mind.
+It is developed by the Berkeley Vision and Learning Center ([BVLC](http://bvlc.eecs.berkeley.edu)) and by community contributors.
+[Yangqing Jia](http://daggerfs.com) created the project during his PhD at UC Berkeley.
 Caffe is released under the [BSD 2-Clause license](https://github.com/BVLC/caffe/blob/master/LICENSE).
 
 Check out our web image classification [demo](http://demo.caffe.berkeleyvision.org)!
 
-## Why use Caffe?
+## Why Caffe?
 
-**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 is as simple as setting a flag -- so models can be trained on a GPU machine, and then used on commodity clusters.
+**Expressive architecture** encourages application and innovation.
+Models and optimization are defined by configuration without hard-coding.
+Switch between CPU and GPU by setting a single flag to train on a GPU machine then deploy to commodity clusters or mobile devices.
 
-**Readable & modifiable implementation** fosters active development.
-In Caffe's first year, it has been forked by over 600 developers on Github, and many have pushed significant changes.
+**Extensible code** fosters active development.
+In Caffe's first year, it has been forked by over 1,000 developers and had many significant changes contributed back.
+Thanks to these contributors the framework tracks the state-of-the-art in both code and models.
 
-**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.
+**Speed** makes Caffe perfect for research experiments and industry deployment.
+Caffe can process **over 60M images per day** with a single NVIDIA K40 GPU\*.
+That's 1 ms/image for inference and 4 ms/image for learning.
+We believe that Caffe is the fastest convnet implementation available.
 
 **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).
+Join our community of brewers on the [caffe-users group](https://groups.google.com/forum/#!forum/caffe-users) and [Github](https://github.com/BVLC/caffe/).
 
 <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.
+\* With the ILSVRC2012-winning [SuperVision](http://www.image-net.org/challenges/LSVRC/2012/supervision.pdf) model and caching IO.
 Consult performance [details](/performance_hardware.html).
 </p>
 
@@ -56,7 +58,7 @@ Developer documentation automagically generated from code comments.
 - <div><a href="{{page.url}}">{{page.title}}</a><br>{{page.description}}</div>
 {% endfor %}
 
-### Notebook examples
+### Notebook Examples
 
 {% assign notebooks = site.pages | where:'category','notebook' | sort: 'priority' %}
 {% for page in notebooks %}
@@ -77,6 +79,17 @@ Please cite Caffe in your publications if it helps your research:
 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).
 
+## Contacting Us
+
+Join the [caffe-users group](https://groups.google.com/forum/#!forum/caffe-users) to ask questions and discuss methods and models. This is where we talk about usage, installation, and applications.
+
+Framework development discussions and thorough bug reports are collected on [Issues](https://github.com/BVLC/caffe/issues).
+
+Contact [caffe-dev](mailto:caffe-dev@googlegroups.com) if you have a confidential proposal for the framework *and the ability to act on it*.
+Requests for features, explanations, or personal help will be ignored; post to [caffe-users](https://groups.google.com/forum/#!forum/caffe-users) instead.
+
+The core Caffe developers offer [consulting services](mailto:caffe-coldpress@googlegroups.com) for appropriate projects.
+
 ## Acknowledgements
 
 The BVLC Caffe developers would like to thank NVIDIA for GPU donation, A9 and Amazon Web Services for a research grant in support of Caffe development and reproducible research in deep learning, and BVLC PI [Trevor Darrell](http://www.eecs.berkeley.edu/~trevor/) for guidance.
@@ -85,20 +98,9 @@ The BVLC members who have contributed to Caffe are (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/), and [Yangqing Jia](http://daggerfs.com/).
 
 The open-source community plays an important 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 a sorted list.
+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 the full list.
 
 We sincerely appreciate your interest and contributions!
 If you'd like to contribute, please read the [developing & contributing](development.html) guide.
 
 Yangqing would like to give a personal thanks to 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 advice.
-
-## Contacting us
-
-All questions about usage, installation, code, and applications should be searched for and asked on the [caffe-users mailing list](https://groups.google.com/forum/#!forum/caffe-users).
-
-All development discussion should be carried out at [GitHub Issues](https://github.com/BVLC/caffe/issues).
-
-If you have a proposal that may not be suited for public discussion *and an ability to act on it*, please email us [directly](mailto:caffe-dev@googlegroups.com).
-Requests for features, explanations, or personal help will be ignored; post such matters publicly as issues.
-
-The core Caffe developers may be able to provide [consulting services](mailto:caffe-coldpress@googlegroups.com) for appropriate projects.