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

Document Caffe by a tour of key subjects #973

Merged
merged 26 commits into from
Sep 3, 2014
Merged

Conversation

shelhamer
Copy link
Member

Lead a tour through the main points of how Caffe works and how to work with Caffe.

The Story

  • nets, layers, and blobs
  • forward / backward passes
  • solving
  • loss
  • interfaces: cli, python, matlab
  • figures

Details

  • layer catalogue skeleton
  • data, IO
  • later: convolution
  • later: add Net::Init to nets, layers, blobs
  • later: DAGs
  • later: weight sharing

Comments

  • Doxygen generation
  • add brief + TODO stubs for includes
  • later: comment crusade

@Yangqing @jeffdonahue let's collaborate on my fork to write this all up and edit this description as you like. BVLC folk, feel free to help!

@kloudkl
Copy link
Contributor

kloudkl commented Aug 27, 2014

@borisgin, your Caffe summer workshop has a lot of good stuffs that fit here.

@borisgin
Copy link

I would be glad to help with tutorial. How I can contribute?

@kloudkl
Copy link
Contributor

kloudkl commented Aug 28, 2014

Maybe a new feature branch should be created and this PR tracks it so that more people can contribute.

@shelhamer
Copy link
Member Author

@borisgin @kloudkl and all:

The first version of this documentation needs to be written by BVLC members. Once the first version is merged to dev everyone will of course be welcome to contribute.

Thank you for your understanding, and certainly for your enthusiasm!

@jeffdonahue
Copy link
Contributor

I pushed a Doxygen config file (should be buildable with make docs if you're using Ubuntu and do sudo apt-get install doxygen; outputs to ./doxygen/) and changed much of the existing comment documentation to Doxygen format, and added a good amount of new documentation (especially for the loss layers and neuron layers, which I think all now have pretty latex forward/backward formulas). There's still quite a bit of work to do -- I think I only put in single-sentence documentation for all of {common,data,vision}_layers.hpp. @shelhamer @longjon @sergeyk it would be great if you guys could help with some of this.

Currently I have the documentation being served at http://durian3.banatao.berkeley.edu:8000/html/annotated.html if you'd like a preview (but I don't guarantee this will remain up at or for any particular amount of time), see http://durian3.banatao.berkeley.edu:8000/html/classcaffe_1_1SigmoidCrossEntropyLossLayer.html for what I think is reasonably good documentation -- ideally we'd pretty much use the same notation everywhere (I tried to do this but not sure I succeeded), so please try to follow the existing notation where applicable (or change it everywhere if it's really that bad) in any new documentation.

@bhack
Copy link
Contributor

bhack commented Aug 31, 2014

@jeffdonahue please take a look also to link in comments #934.

@kloudkl
Copy link
Contributor

kloudkl commented Aug 31, 2014

Pretty comprehensive and precise. Best practical document of deep learning ever seen. Can't wait to see all of them written up.

@kloudkl
Copy link
Contributor

kloudkl commented Sep 3, 2014

Hope you'll be able to publish the documentation before the ECCV'14 tutorial. Good luck!

@shelhamer shelhamer force-pushed the tutorial-docs branch 2 times, most recently from 481d4ea to 6b2bb0d Compare September 3, 2014 20:24
@shelhamer
Copy link
Member Author

@jeffdonahue the docs target and docs script are now configured to link doxygen's html output to docs/doxygen for publishing on the site.

@shelhamer
Copy link
Member Author

Merging -- further documentation will follow. @Yangqing @longjon @sergeyk please join the doxygen comment crusade and use this commenting style in future code.

shelhamer added a commit that referenced this pull request Sep 3, 2014
Document Caffe by a tour of key subjects + doxygen dev documentation
@shelhamer shelhamer merged commit 135786a into BVLC:dev Sep 3, 2014
@shelhamer shelhamer deleted the tutorial-docs branch September 3, 2014 20:27
This was referenced Sep 18, 2014
mitmul pushed a commit to mitmul/caffe that referenced this pull request Sep 30, 2014
Document Caffe by a tour of key subjects + doxygen dev documentation
RazvanRanca pushed a commit to RazvanRanca/caffe that referenced this pull request Nov 4, 2014
Document Caffe by a tour of key subjects + doxygen dev documentation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants