Skip to content

Commit

Permalink
Updating readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
Ragav Venkatesan committed Nov 13, 2016
1 parent bfd5cc9 commit 43aa923
Showing 1 changed file with 19 additions and 12 deletions.
31 changes: 19 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,34 @@
yann:
version 0.01.01
version 0.0.1a1

* An even easier, simpler and versatile CNN alternative to
[Lasagne](https://github.com/Lasagne/Lasagne) and [Keras](https://keras.io/).
* Promotes easy learnability and practice of theano.
* Modelling by just entries in the boilerplate function.

[![Join the chat at https://gitter.im/yann-users/Lobby](https://badges.gitter.im/yann-users/Lobby.svg)](https://gitter.im/yann-users/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![MIT License https://img.shields.io/badge/license-MIT-blue.svg)](http://yann.readthedocs.io/en/latest/license.html)

## Who is this code most useful for ?

[![Join the chat at https://gitter.im/yann-users/Lobby](https://badges.gitter.im/yann-users/Lobby.svg)](https://gitter.im/yann-users/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

I wrote this code essentially for my labmates, those who are interested in
starting deep CNNs to make a fast transition into theano. This will also be
useful for industry when teting out prototypes.

There is a [documentation](http://www.public.asu.edu/~rvenka10/_yann/)
page that has some rudimentary details on how to run the code and how to use it. I
am working on a complete Sphinx Documentation to go on read the docs, but until then,
starting deep CNNs to make a fast transition into theano. It was called samosa then.
Now yann has evolved into a toolbox for CNNs. It is designed as a supplement to an upcoming book on
Convolutional Neural Networks and also the toolbox of choice for a deep learning course.

Because of this reason, Yann is specifically designed to be intuitive and easy to use for beginners.
That does not compromise Yann of any of its features. It is still a good choice for a toolbox for
running pre-trained models and build complicated, non-vannilla CNN architectures that are not easy
to build with the other toolboxes.This will also be useful for industry when teting out prototypes.

There is a [documentation](http://yann.readthedocs.io/en/latest/)
page that has some details on how to run the code and how to use it. I
am working on a more complete Sphinx Documentation but until then,
this is all I have. Contact me if you had trouble.

Thanks for using the code, hope you had fun.
For a quick start into the toolbox, you can use this
[guide](http://yann.readthedocs.io/en/latest/#quick-start).

Thanks for using the code, hope you had fun.
Ragav Venkatesan

http://www.public.asu.edu/~rvenka10
http://www.ragav.net

0 comments on commit 43aa923

Please sign in to comment.