Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
xiaohk committed Apr 30, 2020
1 parent 8fe74c7 commit 0fc5f4c
Showing 1 changed file with 93 additions and 1 deletion.
94 changes: 93 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,96 @@
# CNN Explainer

CNN Explainer is an interactive visualization system designed for non-experts
to learn and examine convolutional neural networks (CNNs).
to more easily learn about convolutional neural networks (CNNs).

<a href="https://youtu.be/udVN7fPvGe0" target="_blank"><img src="./public/assets/figures/youtube-thumbnail.png" style="max-width:100%;"></a>

## Live Demo

For a live demo, visit: https://poloclub.github.io/cnn-explainer/.

## Running Locally

Clone or download this repository:

```
git clone [email protected]:poloclub/cnn-explainer.git
# Or use degit, if you don't want to download commit histories
degit poloclub/cnn-explainer
```

Install the dependencies:

```
npm install
```

Than run CNN Explainer:

```
npm run dev
```

Navigate to [localhost:5000](localhost:5000). You should CNN Explainer running in your broswer :)

To see how we trained the CNN, visit the directory [`./tiny-vgg/`](tiny-vgg).

## Credits

CNN Explainer was created by
<a href="https://zijie.wang/">Jay Wang</a>,
<a href="https://www.linkedin.com/in/robert-turko/">Robert Turko</a>,
<a href="https://oshaikh.com/">Omar Shaikh</a>,
<a href="https://haekyu.com/">Haekyu Park</a>,
<a href="https://nilakshdas.com/">Nilaksh Das</a>,
<a href="https://fredhohman.com/">Fred Hohman</a>,
<a href="https://minsuk.com">Minsuk Kahng</a>, and
<a href="https://www.cc.gatech.edu/~dchau/">Polo Chau</a>,
which was the result of a research collaboration between
Georgia Tech and Oregon State.

We thank
[Anmol Chhabria](https://www.linkedin.com/in/anmolchhabria),
[Kaan Sancak](https://kaansancak.com),
[Kantwon Rogers](https://www.kantwon.com), and the
[Georgia Tech Visualization Lab](https://vis.gatech.edu)
for their support and constructive feedback.

For more information, check out our [research manuscript](https://arxiv.org/abs/2001.02004):

[Z. J. Wang](https://zijie.wang/),
[R. Turko](https://www.linkedin.com/in/robert-turko/),
[O. Shaikh](https://oshaikh.com/),
[H. Park](https://haekyu.com/),
[N. Das](https://nilakshdas.com/),
[F. Hohman](https://fredhohman.com/),
[M. Kahng](https://minsuk.com),
and [D. H. Chau](https://www.cc.gatech.edu/~dchau/).
CNN Explainer: Learning Convolutional Neural Networks with Interactive Visualization.
<i>arXiv:2001.02004 [cs],</i>
Apr. 2020.


## Citation
```
@article{wangCNNExplainerLearning2020,
title = {{{CNN Explainer}}: {{Learning Convolutional Neural Networks}} with {{Interactive Visualization}}},
shorttitle = {{{CNN Explainer}}},
author = {Wang, Zijie J. and Turko, Robert and Shaikh, Omar and Park, Haekyu and Das, Nilaksh and Hohman, Fred and Kahng, Minsuk and Chau, Duen Horng},
year = {2020},
month = apr,
archivePrefix = {arXiv},
eprint = {2001.02004},
eprinttype = {arxiv},
journal = {arXiv:2001.02004 [cs]},
keywords = {Computer Science - Artificial Intelligence,Computer Science - Human-Computer Interaction,Computer Science - Machine Learning},
primaryClass = {cs}
}
```

## Contact

If you have any questions, feel free to [open an issue](https://github.com/poloclub/cnn-explainer/issues/new/choose) or contact [Jay Wang](www.zijie.wang).


0 comments on commit 0fc5f4c

Please sign in to comment.