[Caffe: Convolutional Architecture for Fast Feature Extraction](http://caffe.berkeleyvision.org)

Created by [Yangqing Jia](http://daggerfs.com), UC Berkeley EECS department.

In active development by the Berkeley Vision and Learning Center ([BVLC](http://bvlc.eecs.berkeley.edu/)).

Howpublished = {\url{http://caffe.berkeleyvision.org/}

}

Tutorials and general documentation is written in Markdown format in the `docs/` folder.

While the format is quite easy to read directly, you may prefer to view the whole thing as a website.

To do so, simply run `jekyll serve -s docs` and view the documentation website at `http://0.0.0.0:4000` (to get jekyll, you must have ruby and do `gem install jekyll`).

We strive to provide provide lots of usage examples, and to document all code in docstrings.

We'd appreciate your contribution to this effort!

Caffe is developed with active participation of the community by the [Berkeley Vision and Learning Center](http://bvlc.eecs.berkeley.edu/).

We welcome all contributions!

Our workflow is this:

- The `dev` branch is for new development, community contributions, and testing.

- The `master` branch is handled by BVLC, which will integrate changes from `dev` on a roughly monthly schedule.

- Do new development in [feature branches](https://www.atlassian.com/git/workflows#!workflow-feature-branch) with decriptive names.

- Bring your work up-to-date by [rebasing](http://git-scm.com/book/en/Git-Branching-Rebasing) onto the latest `dev`. (Polish your changes by [interactive rebase](https://help.github.com/articles/interactive-rebase), if you'd like.)

- [Pull request](https://help.github.com/articles/using-pull-requests) your contribution to BVLC/caffe's `dev` branch for discussion and review.

BRANCH=`git rev-parse --abbrev-ref HEAD`

MSG=`git log --oneline -1`

if [ $BRANCH = 'master' ]; then

# Make sure that docs/_site tracks remote:gh-pages.

# If not, then we make a new repo and check out just that branch.

mkdir docs/_site

cd docs/_site

SITE_ORIGIN=`git config --get remote.origin.url`

SITE_BRANCH=`git rev-parse --abbrev-ref HEAD`

echo $SITE_ORIGIN

echo $SITE_BRANCH

echo `pwd`

if [[ ( $SITE_ORIGIN == $ORIGIN ) && ( $SITE_BRANCH = 'gh-pages' ) ]]; then

echo "Confirmed that docs/_site has same origin as main repo, and is on gh-pages."

else

echo "Checking out origin:gh-pages into docs/_site (will take a little time)."

git init .

git remote add -t gh-pages -f origin $ORIGIN

git co gh-pages

fi