search

torch / torch7

http://torch.ch
Other
9k stars 2.38k forks source link

Call for tutorials #637

Open apaszke opened 8 years ago

apaszke commented 8 years ago

After having some discussion with @soumith, we've decided that it would be great to create some good tutorials and examples for Torch beginners. For example TensorFlow has big sections on their website, that explain the most common operations and introduce newcomers to the framework. Current Torch tutorials are a bit outdated and aren't easy to find.

I have created a rough plan of tutorials, that are going to be posted on torch.ch. If anyone would like to take a look and propose something, feel free to comment in the Google Doc.

I think it would be logical to organize these into three sections:

  1. Tutorials - explain in detail how to do things step by step
  2. How to's/Examples - showcase cool projects using torch and provide some additional information (possibly simplify them - they don't need to have very many options). I think it would be good to briefly explain the main principles behind these models, show how the code is organized and how can it be used/extended.
  3. FAQ - just quick answers to questions that often pop up at Gitter and on the mailing list.

I will be working on these in the upcoming months, but if anyone wants to help, I'll be very happy to split work. Thanks!

farrajota commented 8 years ago

I suggest doing a siamese/tripletNet tutorial for face recognition.

apaszke commented 8 years ago

@farrajota Would you like to make one?

farrajota commented 8 years ago

It's something that I know nothing about but I could give it a try.

apaszke commented 8 years ago

@farrajota That would be great! Every contribution is welcome :+1:

Atcold commented 8 years ago

@farrajota: do you mean something like -> https://github.com/Atcold/torch-TripletEmbedding ? It's used in OpenFace -> https://cmusatyalab.github.io/openface/

My code has examples... I can make a tutorial out of it without big troubles.

About ML tutorials -> https://github.com/Atcold/Machine-learning-with-Torch About Torch stuff -> https://github.com/Atcold/Torch-Developer-Guide

I had the same will, but no one was caring much...

I have other 3, 4 chapters almost ready. @nicholas-leonard is writing a book, and all this stuff could be merged, in my opinion. Like here -> https://github.com/rasbt/python-machine-learning-book

farrajota commented 8 years ago

@Atcold if you could do one tutorial out of your code it would be awesome! Also, there's this video of @nicholas-leonard talking about torch that could help new comers to get to know torch much quicker.

nicholas-leonard commented 8 years ago

I can do a tutorial for NLP based on one of these https://github.com/Element-Research/rnn/tree/master/examples .

apaszke commented 8 years ago

@nicholas-leonard That would be awesome!

nicholas-leonard commented 8 years ago

@apaszke So do we just send a PR to torch.github.io with a markdown file for our tutorial and you can handle the rest?

apaszke commented 8 years ago

@nicholas-leonard I will put up a mirror site sometime this week, and when it's finished we can merge it with torch.ch. I will notify you as soon as it will be up.

But in general yeah, I just need a markdown file and I can do all necessary reformatting on my own. Thanks!

apaszke commented 8 years ago

@nicholas-leonard Done. Working repository is online. You can see the preview at torch-docs.github.io.

ilarele commented 8 years ago

Hello, I've written some torch samples for generating adversarial examples and for training a model with adversarial cost: https://github.com/ilarele/torch_examples

nicholas-leonard commented 8 years ago

@ilarele Nice. It would be nice if you could add some visual examples. I am sure it would get you more views.

apaszke commented 8 years ago

@ilarele Thanks! That's definitely worth including! Still, I agree with @nicholas-leonard. It would look great with some examples.