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

Jump to bottom

Create Leaf Book / high-level documentation #91

Closed
MichaelHirn opened this issue Mar 25, 2016 · 8 comments
Closed

Create Leaf Book / high-level documentation #91

MichaelHirn opened this issue Mar 25, 2016 · 8 comments
Assignees
@MichaelHirn
Labels
contributing docs

Comments

@MichaelHirn
Copy link
Member

I feel like, the entrance barrier for (Rust) Developers to engage with Leaf and Machine Learning, for contributions and hacking-away purposes, is still far too high. Partly because the concepts of Machine Learning (Deep Learning) are not yet widely known and partly because not many are familiar with the general design of a Machine Learning framework - compared e.g. to the general design of a Web framework.

The Leaf Book, should provide a practical introduction to Deep Learning for developers. Explain the easy Leaf API and provide examples for popular use-cases like adding a new Layer, Machine Learning across multiple devices and co. After reading it, a developer should feel comfortable hacking on Leaf, even if she has no prior knowledge about Deep Learning ( Deep Learning is really easy).

@hobofan pointed out in #45 interactive documentation for Layers. I am not sure to what extent they can be provided here with the Leaf Book. For the interactive layer documentation, I have something with Jupyter in mind, which would require a Rust kernel first, though. But other options for interactive layer documentation are welcome.

For the book I am trying mdBook as it gives a nice layout and allows it to place the book inside the leaf project. Feedback on the choice is welcome.
@MichaelHirn MichaelHirn self-assigned this Mar 25, 2016
@ujh
Copy link

ujh commented Mar 25, 2016

Sounds good! I can be one of your Guinea pigs for this. I'd be fine with requiring some prior knowledge on ML and deep learning provided that you link to good introductory material. I mean, there must be good material out there and I don't see the point of making the effort to duplicating this. At least not initially.

@MichaelHirn
Copy link
Member Author

Ohh, I like that. Thank you for helping out. Progress can be tracked at the MichaelHirn/book branch for now. I plan to make a WIP PR as soon as the first basics are there.

I also agree with your idea on requiring a basic understanding of ML/Deep Learning for the Leaf Book. I actually don't know a lot of good material for this. One that comes to my mind is A 'brief' history of Deep Learning although a more basic introduction is still required.

BTW, the Book can be build after cloning the branch with

~/.cargo/bin/mdbook watch ./doc

@MichaelHirn MichaelHirn reopened this Mar 25, 2016
@mgattozzi
Copy link

I would also be interested in helping out/being a guinea pig. I've been doing Machine Learning at school so contributing to a project like this would be beneficial in expanding my knowledge of it. Especially a Rust based one.

@ujh
Copy link

ujh commented Mar 25, 2016

The following (free) online book has been recommended to me as an introduction to deep learning: http://neuralnetworksanddeeplearning.com/

I haven't read it yet so I can't say if it's good or not.

@mgattozzi
Copy link

@ujh Thanks for the link! I'll dig into it over the weekend.

@alexandermorozov
Copy link
Contributor

There is also http://cs231n.github.io/. It's quite easy to follow and isn't very heavy on math, but reading it once from start to end feels enough to be able to implement a working NN.

@MichaelHirn MichaelHirn mentioned this issue Mar 28, 2016
Merged
@MichaelHirn
Copy link
Member Author

I think, the first version of the book would be ready for review.

I hosted it for now at http://autumnai.com/leaf/book/. I hope, this makes reading the chapters more convenient.

Looking forward to hear what you think :)

EDIT: flashed out the second sentence.

@KodrAus
Copy link
Contributor

KodrAus commented Apr 3, 2016

Thanks for the awesome work @MichaelHirn I've opened a PR for my copyediting as I go.

homu added a commit that referenced this issue Apr 13, 2016
@homu
Auto merge of #93 - MichaelHirn:book, r=MichaelHirn
d6245b7 
[WIP] The 'Leaf: Machine Learning for hackers' book

This PR is a work in progress. So far I added the 1. Leaf and 2. Layers chapters.

Feedback for the overall structure of the book as well as the general ideas and style of the first two chapters are highly welcome.

There are probably a lot of typos and grammar mistakes in there. You don't have to bother yet pointing them out, the text might change quickly.

REFERENCE: #91
homu added a commit that referenced this issue Apr 13, 2016
@homu
Auto merge of #93 - MichaelHirn:book, r=MichaelHirn
ba0ad2f 
[WIP] The 'Leaf: Machine Learning for hackers' book

This PR is a work in progress. So far I added the 1. Leaf and 2. Layers chapters.

Feedback for the overall structure of the book as well as the general ideas and style of the first two chapters are highly welcome.

There are probably a lot of typos and grammar mistakes in there. You don't have to bother yet pointing them out, the text might change quickly.

REFERENCE: #91
homu added a commit that referenced this issue Apr 21, 2016
@homu
Auto merge of #93 - MichaelHirn:book, r=MichaelHirn
63df108 
[WIP] The 'Leaf: Machine Learning for hackers' book

This PR is a work in progress. So far I added the 1. Leaf and 2. Layers chapters.

Feedback for the overall structure of the book as well as the general ideas and style of the first two chapters are highly welcome.

There are probably a lot of typos and grammar mistakes in there. You don't have to bother yet pointing them out, the text might change quickly.

REFERENCE: #91
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@MichaelHirn MichaelHirn

Labels
contributing docs
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@ujh @alexandermorozov @MichaelHirn @mgattozzi @KodrAus